public interface DocumentGroup extends Referenceable, Previewable, ContentProducer
DocumentGroupLink's
as their child nodes (see
StoreElement.getChildren()
).IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static IDProvider.UidType |
UID_TYPE
Uid type as returned by
getUidType() . |
PARAM_REVISION, PREVIEWMODE_DEFAULT, PREVIEWMODE_DEFAULT_REFRESH, PREVIEWMODE_FORCE_REFRESH, PREVIEWMODE_FULL_QUALIFIED, PREVIEWMODE_NONE, PREVIEWMODE_SSO, PREVIEWMODE_WEBEDIT, PREVIEWMODE_WEBEDIT_FULL_QUALIFIED, PREVIEWMODE_WITHOUT_CONTEXTNAME
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
DocLink |
addLink(IDProvider target)
Adds a link to the given target element.
|
void |
appendChild(StoreElement child)
Appends a child element to this group, which must be an instance of either
DocLink whith a
PageRef or SiteStoreFolder . |
void |
appendChildBefore(StoreElement child,
StoreElement before)
Appends a child element to this group, inserting it before a reference element.
|
boolean |
containsElement(StoreElement element)
Indicates whether the given element is part of this document group.
|
String |
getComment()
Provides a comment for this group.
|
TemplateSet |
getDefaultTemplateSet()
Gives the default template set to be used.
|
String |
getFilename()
Provides the file name of this group.
|
TemplateSet[] |
getGenerateFor()
The template sets for which this document group should be generated
|
boolean |
getGenerateForAll()
Indicates, whether to generate for all template sets.
|
PageTemplate |
getPrefixTemplate()
Get the template which is used to render the prefix, e.g. a table of contents
|
PageTemplate |
getSuffixTemplate()
Get the template which is used to render the suffix, e.g. an index
|
String |
getTemplateExtension()
Value of the extension used when resolving templates.
|
IDProvider.UidType |
getUidType()
Return
UID_TYPE . |
void |
replaceChild(StoreElement oldChild,
StoreElement newChild)
Replaces a child element with another.
|
void |
setComment(String value)
Defines the comment for this group.
|
void |
setDefaultTemplateSet(TemplateSet value)
Defines the default template set to be used.
|
void |
setFilename(String value)
Defines the file name for this group.
|
void |
setGenerateFor(TemplateSet[] value)
Defines to generate this group for the given list of template sets.
|
void |
setGenerateForToAll()
Defines to generate for all template sets.
|
void |
setPrefixTemplate(PageTemplate value)
Set the template which is used to render the prefix, e.g. a table of contents
|
void |
setSuffixTemplate(PageTemplate value)
Set the template which is used to render the suffix, e.g. an index
|
void |
setTemplateExtension(String value)
Defines the extension used for resolving templates.
|
getReferenceName
getPreviewUrl, getPreviewUrlObject
createContent, getExtension, getMultiPageParams, getStoredUrl, getUrl
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid
delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
static final IDProvider.UidType UID_TYPE
getUidType()
.@Nullable PageTemplate getPrefixTemplate()
void setPrefixTemplate(PageTemplate value)
@Nullable PageTemplate getSuffixTemplate()
void setSuffixTemplate(PageTemplate value)
TemplateSet[] getGenerateFor()
void setGenerateFor(TemplateSet[] value)
value
- An array of template sets.void setGenerateForToAll()
boolean getGenerateForAll()
true
, if to generate for all.@NotNull String getFilename()
getFilename
in interface ContentProducer
void setFilename(String value)
value
- The file name.String getComment()
void setComment(String value)
value
- The comment.String getTemplateExtension()
void setTemplateExtension(String value)
value
- The extension.boolean containsElement(StoreElement element)
element
- the element to testtrue
if the provided element part this document group, either direct by a
link
or indirect by a link
on one of its anchestoresNullPointerException
- when provided element is null
TemplateSet getDefaultTemplateSet()
void setDefaultTemplateSet(TemplateSet value)
value
- A template set.DocLink addLink(IDProvider target)
target
- The target element.void appendChild(StoreElement child)
DocLink
whith a
PageRef
or SiteStoreFolder
.appendChild
in interface StoreElement
child
- The child element.IllegalArgumentException
- if the child does not fulfills the restrictions aboveDocLink.getTarget(de.espirit.firstspirit.access.store.Store)
,
DocLink.getTarget(boolean)
void appendChildBefore(@NotNull StoreElement child, @Nullable StoreElement before)
DocLink
whith a PageRef
or SiteStoreFolder
.appendChildBefore
in interface StoreElement
child
- The child element.before
- The reference element.IllegalArgumentException
- if the child does not fulfills the restrictions aboveDocLink.getTarget(de.espirit.firstspirit.access.store.Store)
,
DocLink.getTarget(boolean)
void replaceChild(StoreElement oldChild, StoreElement newChild)
replaceChild
in interface StoreElement
oldChild
- The old child.newChild
- The new child.IllegalArgumentException
- if the new child does not fulfills the restrictions aboveDocLink.getTarget(de.espirit.firstspirit.access.store.Store)
,
DocLink.getTarget(boolean)
@NotNull IDProvider.UidType getUidType()
UID_TYPE
.getUidType
in interface IDProvider
IDProvider.hasUid()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210