de.espirit.firstspirit.access.store.sitestore

Interface DocumentGroup

All Superinterfaces:

Comparable<StoreElement>, ContentProducer, HistoryProvider, IDProvider, Previewable, Referenceable, StoreElement, Workflowable

public interface DocumentGroup
extends Referenceable, Previewable, ContentProducer

A DocumentGroup groups DocumentGroupLink's as their child nodes (see StoreElement.getChildren()).

Since:

3.0.54

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static IDProvider.UidType	UID_TYPE Uid type as returned by getUidType().

Fields inherited from interface de.espirit.firstspirit.access.store.Previewable

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

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Method Summary

Methods

Modifier and Type	Method and Description
DocLink	addLink(IDProvider target)
void	appendChild(StoreElement child) Calls appendChildBefore(child, null).
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)

Methods inherited from interface de.espirit.firstspirit.access.store.Referenceable

getReferenceName

Methods inherited from interface de.espirit.firstspirit.access.store.Previewable

getPreviewUrl, getPreviewUrlObject

Methods inherited from interface de.espirit.firstspirit.access.store.ContentProducer

createContent, getExtension, getMultiPageParams, getStoredUrl, getUrl

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

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

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

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

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Field Detail

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by getUidType().

Since:

4.0.24

Method Detail

getPrefixTemplate

@Nullable
PageTemplate getPrefixTemplate()

Get the template which is used to render the prefix, e.g. a table of contents

Since:

3.0.57

setPrefixTemplate

void setPrefixTemplate(PageTemplate value)

Set the template which is used to render the prefix, e.g. a table of contents

Since:

3.0.57

getSuffixTemplate

@Nullable
PageTemplate getSuffixTemplate()

Get the template which is used to render the suffix, e.g. an index

Since:

3.0.57

setSuffixTemplate

void setSuffixTemplate(PageTemplate value)

Set the template which is used to render the suffix, e.g. an index

Since:

3.0.57

getGenerateFor

TemplateSet[] getGenerateFor()

The template sets for which this document group should be generated

Since:

3.0.54

setGenerateFor

void setGenerateFor(TemplateSet[] value)

Since:

3.0.56

setGenerateForToAll

void setGenerateForToAll()

Since:

3.0.57

getGenerateForAll

boolean getGenerateForAll()

Since:

3.0.57

getFilename

@NotNull
String getFilename()

Description copied from interface: ContentProducer

Get a file or link name for this content producer; without path information and extension, e.g. "index"

Specified by:

getFilename in interface ContentProducer

Returns:

a filename without path information and extension

Since:

3.0.57

setFilename

void setFilename(String value)

Since:

3.0.57

getComment

String getComment()

Since:

3.0.64

setComment

void setComment(String value)

Since:

3.0.64

getTemplateExtension

String getTemplateExtension()

Value of the extension used when resolving templates

Since:

3.0.57

setTemplateExtension

void setTemplateExtension(String value)

Since:

3.0.57

containsElement

boolean containsElement(StoreElement element)

Parameters:

element - the element to test

Returns:

true if the provided element part this document group, either direct by a link or indirect by a link on one of its anchestores

Throws:

NullPointerException - when provided element is null

Since:

3.0.57

getDefaultTemplateSet

TemplateSet getDefaultTemplateSet()

Since:

3.0.57

setDefaultTemplateSet

void setDefaultTemplateSet(TemplateSet value)

Since:

3.0.57

addLink

DocLink addLink(IDProvider target)

Since:

4.0

appendChild

void appendChild(StoreElement child)

Description copied from interface: StoreElement

Calls appendChildBefore(child, null).

Specified by:

appendChild in interface StoreElement

Parameters:

child - must be an instance of DocLink whith a PageRef or SiteStoreFolder as target

Throws:

IllegalArgumentException - if the child does not fulfills the restrictions above

Since:

3.0

See Also:

DocLink.getTarget(de.espirit.firstspirit.access.store.Store), DocLink.getTarget(boolean)

appendChildBefore

void appendChildBefore(@NotNull
                     StoreElement child,
                     @Nullable
                     StoreElement before)

Description copied from interface: StoreElement

Appends the given child to the children list before the given 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
 }
 

Specified by:

appendChildBefore in interface StoreElement

Parameters:

child - must be an instance of DocLink whith a PageRef or SiteStoreFolder as target

before - the child will be appended before the nextsibling node

Throws:

IllegalArgumentException - if the child does not fulfills the restrictions above

Since:

3.0.3

See Also:

DocLink.getTarget(de.espirit.firstspirit.access.store.Store), DocLink.getTarget(boolean)

replaceChild

void replaceChild(StoreElement oldChild,
                StoreElement newChild)

Specified by:

replaceChild in interface StoreElement

Parameters:

newChild - must be an instance of DocLink whith a PageRef or SiteStoreFolder as target

Throws:

IllegalArgumentException - if the new child does not fulfills the restrictions above

Since:

3.0.7

See Also:

DocLink.getTarget(de.espirit.firstspirit.access.store.Store), DocLink.getTarget(boolean)

getUidType

@NotNull
IDProvider.UidType getUidType()

Return UID_TYPE.

Specified by:

getUidType in interface IDProvider

Returns:

the unique identifier

Since:

4.0.24

See Also:

IDProvider.hasUid()