de.espirit.firstspirit.access.store

Interface IDProvider

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, StoreElement, Workflowable

All Known Subinterfaces:

Body, ChannelSourceProvider, Content2, Content2Section, ContentFolder, ContentProducer, ContentStoreRoot, DataProvider, Dataset, DocumentGroup, FormatTemplate, FormatTemplateContainer, FormatTemplateFolder, FormatTemplates, GCABody, GCAFolder, GCAPage, GCASection, GlobalContentArea, GlobalStoreRoot, GomSourceProvider, LinkTemplate, LinkTemplateFolder, LinkTemplates, MasterTemplate, Media, MediaFolder, MediaStoreRoot, PackagePoolItem, Page, PageFolder, PageRef, PageRefFolder, PageStoreRoot, PageTemplate, PageTemplates, Previewable, PreviewImageProvider, ProjectProperties, Query, Referenceable, Schema, SchemaContainer, SchemaFolder, Schemes, Script, ScriptContainer, ScriptFolder, Scripts, Section<T>, SectionReference<T>, SectionTemplate, SectionTemplates, SiteStoreFolder, SiteStoreRoot, StartNode, Store, StyleTemplate, TableFormatTemplate, TableTemplate, Template, TemplateContainer<T>, TemplateContentProvider, TemplateFolder<T>, TemplateProvider<T>, TemplateStoreElement, TemplateStoreRoot, Workflow, WorkflowContainer, WorkflowFolder, Workflows

public interface IDProvider
extends StoreElement, HistoryProvider

Since:

3.0.9

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDProvider.DependentReleaseType Type for the dependent release handling.
static class	IDProvider.RevertType Type represanting the revert mode.
static class	IDProvider.UidType Defines the name space in which the unique identifier has to be unique.

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

HistoryProvider.RevisionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANGED Indicates that the actual version of this node differs to the version in release store.
static int	NEVER_RELEASED Indicates that this node doesn't not exist in the release store.
static int	RELEASED Indicates that this node is currently 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
Set<de.espirit.firstspirit.storage.Contrast>	contrastWith(IDProvider reference) Contrast the element with another one.
String	getDisplayName(Language language) Return the display name (label) for the specified language - if no language specific label is defined for this language the value for the master language is returned.
long	getId() Returns the unique ID of this IDProvider
IDProvider	getInRevision(Revision revision) Get this element in the state of the given revision.
LanguageInfo	getLanguageInfo(Language language) Returns the LanguageInfo node for the given language
Long	getLongID()
Data	getMeta() Deprecated. since 4.2.450 - use getMetaFormData() instead
FormData	getMetaFormData() Returns the formdata container of this element or null if there is no meta data template defined for project.
IDProvider	getParent() Return parent IDProvider which is null for deleted elements or store-roots.
User	getReleasedBy() The last user who released this node or null if this node has never been released.
Revision	getReleaseRevision()
int	getReleaseStatus() Returns the release state of this storeelement (CHANGED or RELEASED or NEVER_RELEASED)
Revision	getRevision()
String	getUid() Returns the unique identifier of this IDProvider if it has a unique identifier otherwise throws an UnsupportedOperationException!
IDProvider.UidType	getUidType() Returns the unique identifier type of this IDProvider if it has a unique identifier otherwise throws an UnsupportedOperationException!
boolean	hasMeta() Indicates that any meta data is set for this element.
boolean	hasUid() Returns true if this IDProvider has a unique identifier like e.g.
boolean	isInReleaseStore() Checks if this storeelement exists in the release representation of the belonging store.
boolean	isReleased() Returns true if this element is currently released (not changed).
boolean	isReleaseSupported() Indicates wether this element supports release(boolean) or not.
void	moveChild(IDProvider child) Insert child at last position.
void	moveChild(IDProvider child, int nextSiblingIndex) Insert child at index position.
void	release() Release this node and all childs.
void	release(boolean releaseChilds) Release this node and optionally all childs
void	revert(Revision revision, boolean recursive, EnumSet<IDProvider.RevertType> ignoreRevertTypes) Reverts this storeelement to the given FSRevision.
void	setMeta(Data data) Deprecated. since 4.2.450 - use setMetaFormData(de.espirit.firstspirit.forms.FormData) instead
void	setMetaFormData(FormData formData) Sets the given formdata container of this element.
void	setUid(String uid) Sets the unique identifier.

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

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, 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, replaceChild, 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

RELEASED

static final int RELEASED

Indicates that this node is currently released. More precisely that the version of this node is equal between current and release store.

Since:

2.3

See Also:

getReleaseStatus(), Constant Field Values

CHANGED

static final int CHANGED

Indicates that the actual version of this node differs to the version in release store.

Since:

2.3

See Also:

getReleaseStatus(), Constant Field Values

NEVER_RELEASED

static final int NEVER_RELEASED

Indicates that this node doesn't not exist in the release store.
Therefore isInReleaseStore() will deliver false

Since:

4.0.17

See Also:

isInReleaseStore(), Constant Field Values

Method Detail

getId

long getId()

Returns the unique ID of this IDProvider

Returns:

the unique ID of this IDProvider

Since:

4.0.90

getLongID

Long getLongID()

Since:

3.1

getRevision

Revision getRevision()

Since:

4.0

getReleaseRevision

@Nullable
Revision getReleaseRevision()

Since:

4.0

getInRevision

@Nullable
IDProvider getInRevision(@NotNull
                                Revision revision)

Get this element in the state of the given revision. If the provided revision is older than Project#getFirstCompleteRevision() this method may behave unexpectly, i.e. may throw an exception or return null.

Parameters:

revision - The revision to use.

Returns:

The revision-based element.

Since:

4.0.52

getUid

@NotNull
String getUid()

Returns the unique identifier of this IDProvider if it has a unique identifier otherwise throws an UnsupportedOperationException!

Returns:

unique identifier

Since:

4.0

See Also:

hasUid()

setUid

void setUid(@NotNull
          String uid)

Sets the unique identifier. The provided uid should contain only lower case characters.

Attention: Use with care. Changing the unique identifier will destroy all incoming references which use this unique identifier.

If the given unique identifier isn't unique on the server during StoreElement.save() a DuplicateReferenceNameException will be thrown

Parameters:

uid - new unique identifier; should contain only lower case characters - internally this value is transformed to lower case

Throws:

NullPointerException - if the provided uid is null

Since:

4.0

getUidType

@NotNull
IDProvider.UidType getUidType()

Returns the unique identifier type of this IDProvider if it has a unique identifier otherwise throws an UnsupportedOperationException!

Returns:

the unique identifier

Since:

4.0

See Also:

hasUid()

hasUid

boolean hasUid()

Returns true if this IDProvider has a unique identifier like e.g. medias, false otherwise. This method must be called in prior to getUid() and getUidType()!

Returns:

true if this IDProvider has a unique identifier, false otherwise

Since:

4.0

See Also:

getUid(), getUidType()

getLanguageInfo

LanguageInfo getLanguageInfo(@NotNull
                           Language language)

Returns the LanguageInfo node for the given language

Parameters:

language - the language to get the language specific info node for

Returns:

LanguageInfo node for the given language

Since:

4.0

moveChild

void moveChild(IDProvider child)
               throws LockException,
                      ElementMovedException

Insert child at last position. This method requires no lock! The given child can be a child of a different parent. Calls moveChild(child, -1)

Parameters:

child - the child to be moved

Throws:

LockException

ElementMovedException

Since:

4.0

moveChild

void moveChild(IDProvider child,
             int nextSiblingIndex)
               throws LockException,
                      ElementMovedException

Insert child at index position. This method requires no lock! The given child can be a child of a different parent. The provided index should be the index of an IDProvider child node (if not the child is moved to the last index).

Example: Move from another parent

 Root
  |-- newParent
  |     |-- firstNode
  |     `-- nextSibling
  `-- oldParent
        `-- moveNode
 try {
     // move 'moveNode' to 'newParent', position before 'nextSibling'
     newParent.moveChild(moveNode, newParent.getChildIndex(nextSibling));
 } catch(ElementMovedException e) {
    // element moveNode already moved on the server
 } catch(LockException e) {
    // one of the elements (newParent, oldParent, moveNode) is locked on the server by another user
 }
 

Parameters:

child - the child to be moved to this element

nextSiblingIndex - the index of the next sibling. The given child will be positioned before next sibling.

Throws:

LockException

ElementMovedException

Since:

4.0

See Also:

moveChild(IDProvider)

getDisplayName

@NotNull
String getDisplayName(Language language)

Return the display name (label) for the specified language - if no language specific label is defined for this language the value for the master language is returned. If this is also not set a node dependent fallback value is returned.

Since:

4.0.13

isReleaseSupported

boolean isReleaseSupported()

Indicates wether this element supports release(boolean) or not.

Returns:

true if this element supports release, false otherwise

Since:

4.1.9

See Also:

release(), release(boolean), isInReleaseStore()

getReleaseStatus

int getReleaseStatus()

Returns the release state of this storeelement (CHANGED or RELEASED or NEVER_RELEASED)

Since:

4.0.13

See Also:

isInReleaseStore(), isReleaseSupported(), isReleased()

isReleased

boolean isReleased()

Returns true if this element is currently released (not changed). Semantically the same as (getReleaseStatus() == RELEASED) but probably faster, at least for datasets

Since:

5.0.414

getReleasedBy

@Nullable
User getReleasedBy()

The last user who released this node or null if this node has never been released. In projects which do not use the release feature this method returns the last editor.

Since:

4.1.9

isInReleaseStore

boolean isInReleaseStore()

Checks if this storeelement exists in the release representation of the belonging store. This method could only be called for storeelements which support release and which are in the current representation of the belonging store

Returns:

true if the node exists in the release store, false otherwise

Since:

4.1.9

See Also:

isReleaseSupported(), getReleaseStatus()

release

void release()

Release this node and all childs.

Since:

4.1.9

release

void release(boolean releaseChilds)

Release this node and optionally all childs

Since:

4.0

getParent

@Nullable
IDProvider getParent()

Return parent IDProvider which is null for deleted elements or store-roots.

Specified by:

getParent in interface StoreElement

Returns:

parent IDProvider which is null for deleted elements or store-roots.

Since:

4.0.17

contrastWith

@NotNull
Set<de.espirit.firstspirit.storage.Contrast> contrastWith(IDProvider reference)

Contrast the element with another one. Returns the set of changes being applied from the reference element to this one.

Parameters:

reference - The reference element.

Returns:

A set of change information.

Since:

4.0.52

revert

void revert(@NotNull
          Revision revision,
          boolean recursive,
          @NotNull
          EnumSet<IDProvider.RevertType> ignoreRevertTypes)
            throws LockException

Reverts this storeelement to the given FSRevision.

Parameters:

revision - the revision to revert to

recursive -

ignoreRevertTypes -

Throws:

LockException

Since:

4.0.44

See Also:

HistoryProvider.getHistory()

getMeta

@Deprecated
@Nullable
Data getMeta()

Deprecated. since 4.2.450 - use getMetaFormData() instead

Returns the meta data for this element or null if there is no meta data template defined for project.

Returns:

The meta data or null if there is no meta data template defined for project.

Since:

4.0.54

See Also:

Project.getMetadataTemplate()

setMeta

@Deprecated
void setMeta(@Nullable
                      Data data)

Deprecated. since 4.2.450 - use setMetaFormData(de.espirit.firstspirit.forms.FormData) instead

Set meta data for this element or provide null to remove meta data.

Parameters:

data - The meta data to be set.

Since:

4.0.54

hasMeta

boolean hasMeta()

Indicates that any meta data is set for this element.

Returns:

true, if any meta data is set.

Since:

4.0.120

getMetaFormData

@Nullable
FormData getMetaFormData()

Returns the formdata container of this element or null if there is no meta data template defined for project.

Returns:

the formdata container of this element or null if there is no meta data template defined for project.

Since:

4.2.450

See Also:

Project.getMetadataTemplate()

setMetaFormData

void setMetaFormData(@Nullable
                   FormData formData)

Sets the given formdata container of this element. Removes meta data if null is provided.

Parameters:

formData - the form data container to be set to this element or null to remove meta data.

Since:

4.2.450