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) |
void |
appendChild(StoreElement child)
|
void |
appendChildBefore(StoreElement child,
StoreElement before)
Appends the given child to the children list before the given
nextsibling element. |
boolean |
containsElement(StoreElement element) |
String |
getComment() |
TemplateSet |
getDefaultTemplateSet() |
String |
getFilename()
Get a file or link name for this content producer; without path information and extension, e.g.
|
TemplateSet[] |
getGenerateFor()
The template sets for which this document group should be generated
|
boolean |
getGenerateForAll() |
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) |
void |
setComment(String value) |
void |
setDefaultTemplateSet(TemplateSet value) |
void |
setFilename(String value) |
void |
setGenerateFor(TemplateSet[] value) |
void |
setGenerateForToAll() |
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) |
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, 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, 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, update
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)
void setGenerateForToAll()
boolean getGenerateForAll()
@NotNull String getFilename()
ContentProducer
getFilename
in interface ContentProducer
void setFilename(String value)
String getComment()
void setComment(String value)
String getTemplateExtension()
void setTemplateExtension(String value)
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)
DocLink addLink(IDProvider target)
void appendChild(StoreElement child)
StoreElement
appendChild
in interface StoreElement
child
- must be an instance of DocLink
whith a PageRef
or SiteStoreFolder
as
targetIllegalArgumentException
- 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)
StoreElement
nextsibling
element.
If you want to append a child from a different parent, use
moveChild(child)
or
moveChild(child, nextSiblingIndex)
Attention:
It's necessary to lock and save all parts of the operation (parent and child)
You need permission can change
and
can append leaf
(if given child is a leaf node) or
can append folder
(if given child is a folder)
Example 1 (position ordering - same parent):
parent.setLock(true, false); // non recursive lock move.setLock(true, false); // non recursive lock -> avoid concurrent change try { parent.removeChild(moveNode); parent.appendChildBefore(moveNode, nextSibling); // append 'moveNode' before 'nextSibling' parent.save("position changed", false); // non recursive save // it's not necessary to save 'moveNode' because parent hasn't changed } finally { move.setLock(false, false); // non recursive unlock parent.setLock(false, false); // non recursive unlock }
appendChildBefore
in interface StoreElement
child
- must be an instance of DocLink
whith a PageRef
or SiteStoreFolder
as
targetbefore
- the child will be appended before the nextsibling nodeIllegalArgumentException
- 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
newChild
- must be an instance of DocLink
whith a PageRef
or SiteStoreFolder
as
targetIllegalArgumentException
- 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 © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500