Package de.espirit.firstspirit.access.store.contentstore

Interface Content2

All Superinterfaces:

Comparable<StoreElement>, DatasetProvider, HistoryProvider, IDProvider, PackagePoolItem, StoreElement, StoreElementFolder, TemplateProvider<TableTemplate>, Workflowable

@NonExtendable
public interface Content2
extends TemplateProvider<TableTemplate>, PackagePoolItem, StoreElementFolder, DatasetProvider

Interface providing means to operate on content2 elements.

Since:

3.0

Nested Class Summary

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

HistoryProvider.RevisionProvider

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

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

Fields

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

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

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

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

CHANGED, NEVER_RELEASED, RELEASED

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

BLOCKED, MODIFIED, UNMODIFIED

Method Summary

Modifier and Type	Method	Description
void	delete(Entity entity)	Deprecated. since 5.2.201 - use StoreElement.delete() instead.
@NotNull Content2Params	getContent2Params()	Returns the params of this content2.
List<? extends Entity>	getData()	Deprecated. since 5.1.102, use getDatasets()
List<? extends Entity>	getData(@NotNull Language language)	Deprecated. since 5.1.102, use getDatasets(Language).
@NotNull Dataset	getDataset(@NotNull Entity entity)	Get a dataset for the given entity.
List<Dataset>	getDatasets()	Returns the list of datasets respecting defined filter and ordering. Shortcut for getData(getProject().getMasterLanguage())).
List<Dataset>	getDatasets(@NotNull Language language)	Returns the list of datasets respecting defined filter and ordering. Internally this list is constructed lazily, to maintain this feature one should wrap this list if e.g. only Dataset.getEntity() is needed:
@Nullable Entity	getEntity(Object keyValue)	Returns the entity found for given keyValue or null.
@NotNull EntityType	getEntityType()	Returns the entity type this content2 belongs to.
@NotNull Schema	getSchema()	Returns the schema this content2 refers to.
@NotNull TableTemplate	getTemplate()	Returns the TableTemplate of this content2 node.
@Nullable Workflowable	getWorkflowable(Entity entity)	Get a workflowable instance for the provided entity.
boolean	isFiltered()	Returns true if the view is filterd (getContent2Params().getQuery() is not null).
boolean	isLocked(Entity entity)	Deprecated. since 5.2.201 - use StoreElement.isLocked() instead.
boolean	isLockedOnServer(Entity entity, boolean allSessions)	Deprecated. since 5.2.201 - use StoreElement.isLockedOnServer(boolean) instead.
void	lock(Entity entity)	Deprecated. since 5.2.201 - use Dataset#setLock(true) instead.
void	release(Entity entity)	Deprecated. since 5.2.201 - use IDProvider.release() instead.
void	release(Entity entity, String comment)	Deprecated. since 5.2.201 - use IDProvider.release() instead.
void	unlock(Entity entity)	Deprecated. since 5.2.201 - use Dataset#setLock(false) instead.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.store.contentstore.DatasetProvider

createDataset, getDataset

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

asRevisionProvider, getHistory, getHistory

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

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isInReleaseStore, isReachableInReleaseStore, isReleased, isReleased, isReleaseSupported, moveChild, moveChild, release, release, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

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

addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState

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, getPreviousSibling, getProject, getReferenceName, getReferences, 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

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Field Details

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by IDProvider.getUidType().

Since:

4.0.43

Method Details

getSchema

@NotNull
@NotNull Schema getSchema()

Returns the schema this content2 refers to.

Specified by:

getSchema in interface DatasetProvider

Returns:

The schema.

Since:

3.0

getTemplate

@NotNull
@NotNull TableTemplate getTemplate()
                            throws ReferenceNotFoundException

Returns the TableTemplate of this content2 node.

Specified by:

getTemplate in interface TemplateProvider<TableTemplate>

Returns:

the template of type <T>

Throws:

ReferenceNotFoundException - if the template is missing

Since:

3.0

getEntityType

@NotNull
@NotNull EntityType getEntityType()

Returns the entity type this content2 belongs to.

Specified by:

getEntityType in interface DatasetProvider

Returns:

the belonging EntityType or throws EntityTypeNotFoundException

Since:

4.0

getEntity

@Nullable
@Nullable Entity getEntity(Object keyValue)

Returns the entity found for given keyValue or null.

Returns:

The entity found for given keyValue or null.

Since:

4.0

getData

@Deprecated
List<? extends Entity> getData()

Deprecated.

since 5.1.102, use getDatasets()

Returns the list of entities respecting defined filter and ordering.
Shortcut for getData(getProject().getMasterLanguage())).

Returns:

The list of entities respecting defined filter and ordering.

Since:

3.0

See Also:

• getContent2Params()
• isFiltered()

getDatasets

List<Dataset> getDatasets()

Returns the list of datasets respecting defined filter and ordering.
Shortcut for getData(getProject().getMasterLanguage())).

Returns:

The list of entities respecting defined filter and ordering.

Since:

5.1.102

See Also:

• getContent2Params()
• isFiltered()

getData

@Deprecated
List<? extends Entity> getData(@NotNull
 @NotNull Language language)

Deprecated.

since 5.1.102, use getDatasets(Language).

Returns the list of entities respecting defined filter and ordering.

Parameters:

language - The project language to be used for select.

Returns:

The list of entities respecting defined filter and ordering.

Since:

4.2.442

See Also:

• getContent2Params()
• isFiltered()

getDatasets

List<Dataset> getDatasets(@NotNull
 @NotNull Language language)

Returns the list of datasets respecting defined filter and ordering.
Internally this list is constructed lazily, to maintain this feature one should wrap this list if e.g. only Dataset.getEntity() is needed:

     final List<Dataset> datasets = content.getDatasets(language);
     final List<Entity> entities = new AbstractList<Entity>() {
       public Entity get(int i) { return datasets.get(i).getEntity(); }
       public int size() { return datasets.size() }
    };
 

Parameters:

language - The project language to be used for select.

Returns:

The list of entities respecting defined filter and ordering.

Since:

5.1.102

See Also:

• getContent2Params()
• isFiltered()

lock

@Deprecated
void lock(Entity entity)
   throws LockException

Deprecated.

since 5.2.201 - use Dataset#setLock(true) instead.

Throws:

LockException

Since:

4.0

unlock

@Deprecated
void unlock(Entity entity)
     throws LockException

Deprecated.

since 5.2.201 - use Dataset#setLock(false) instead.

Throws:

LockException

Since:

4.0

isLocked

@Deprecated
boolean isLocked(Entity entity)

Deprecated.

since 5.2.201 - use StoreElement.isLocked() instead.

Indicates that the given entity is in lock state in the current session.

Parameters:

entity - The entity to check its state of.

Returns:

true, if the entity is locked, false else

Since:

4.2.30

isLockedOnServer

@Deprecated
boolean isLockedOnServer(Entity entity,
 boolean allSessions)

Deprecated.

since 5.2.201 - use StoreElement.isLockedOnServer(boolean) instead.

Indicates that the given entity is locked on server side.

Parameters:

entity - The entity in question.

allSessions - If true, all sessions are checked, otherwise, only the current session is checked.

Returns:

true, if locked on server.

Since:

5.0.404

release

@Deprecated
void release(Entity entity)
      throws LockException

Deprecated.

since 5.2.201 - use IDProvider.release() instead.

Throws:

LockException

Since:

4.0

release

@Deprecated
void release(Entity entity,
 String comment)
      throws LockException

Deprecated.

since 5.2.201 - use IDProvider.release() instead.

Throws:

LockException

Since:

4.1.23

delete

@Deprecated
void delete(Entity entity)
     throws LockException

Deprecated.

since 5.2.201 - use StoreElement.delete() instead.

Throws:

LockException

Since:

4.0

getWorkflowable

@Nullable
@Nullable Workflowable getWorkflowable(Entity entity)

Get a workflowable instance for the provided entity. Returns null if the provided entity is null or workflows for the provided entity are not supported (e.g. because the corresponding schema is read only).

Since:

4.0

getDataset

@NotNull
@NotNull Dataset getDataset(@NotNull
 @NotNull Entity entity)

Get a dataset for the given entity.

Specified by:

getDataset in interface DatasetProvider

Parameters:

entity - The entity to get as Dataset.

Returns:

A dataset on the given entity.

Since:

4.0.30

getContent2Params

@NotNull
@NotNull Content2Params getContent2Params()

Returns the params of this content2.

Returns:

The params of this content2.

Since:

4.0.130

isFiltered

boolean isFiltered()

Returns true if the view is filterd (getContent2Params().getQuery() is not null).

Since:

4.1

See Also:

• getContent2Params()