public interface Content2 extends TemplateProvider<TableTemplate>, PackagePoolItem, StoreElementFolder, DatasetProvider
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static IDProvider.UidType |
UID_TYPE
Uid type as returned by
IDProvider.getUidType() . |
BLOCKED, MODIFIED, UNMODIFIED
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
void |
delete(Entity entity) |
Content2Params |
getContent2Params() |
List<? extends Entity> |
getData()
Deprecated.
since 5.1.102, use
getDatasets() |
List<? extends Entity> |
getData(Language language)
Deprecated.
since 5.1.102, use
getDatasets(Language) . |
Dataset |
getDataset(Entity entity)
Get a dataset for the given entity.
|
List<Dataset> |
getDatasets()
Returns the list of datasets respecting defined filter and ordering.
|
List<Dataset> |
getDatasets(Language language)
Returns the list of datasets respecting defined filter and ordering.
|
Entity |
getEntity(Object keyValue) |
EntityType |
getEntityType()
Get the entity type supported by this dataset provider.
|
Schema |
getSchema()
Get the schema the provider refers to.
|
TableTemplate |
getTemplate()
Returns the
TableTemplate of this content2 node. |
Workflowable |
getWorkflowable(Entity entity)
Get a workflowable instance for the provided entity.
|
boolean |
isFiltered()
Returns
true if the view is filterd
(getContent2Params() . |
boolean |
isLocked(Entity entity)
Indicates that the given entity is in lock state in the current session.
|
boolean |
isLockedOnServer(Entity entity,
boolean allSessions)
Indicates that the given entity is locked on server side.
|
void |
lock(Entity entity) |
void |
release(Entity entity) |
void |
release(Entity entity,
String comment) |
void |
unlock(Entity entity) |
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid
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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
getDataset
static final IDProvider.UidType UID_TYPE
IDProvider.getUidType()
.@NotNull Schema getSchema()
DatasetProvider
getSchema
in interface DatasetProvider
@NotNull TableTemplate getTemplate()
TableTemplate
of this content2 node.getTemplate
in interface TemplateProvider<TableTemplate>
@NotNull EntityType getEntityType()
DatasetProvider
getEntityType
in interface DatasetProvider
EntityTypeNotFoundException
@Deprecated List<? extends Entity> getData()
getDatasets()
getData(getProject().getMasterLanguage()))
.getContent2Params()
,
isFiltered()
List<Dataset> getDatasets()
getData(getProject().getMasterLanguage()))
.getContent2Params()
,
isFiltered()
@Deprecated List<? extends Entity> getData(@NotNull Language language)
getDatasets(Language)
.language
- The project language to be used for select.getContent2Params()
,
isFiltered()
List<Dataset> getDatasets(@NotNull Language language)
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() }
};
language
- The project language to be used for select.getContent2Params()
,
isFiltered()
void lock(Entity entity) throws LockException
LockException
void unlock(Entity entity) throws LockException
LockException
boolean isLocked(Entity entity)
entity
- The entity to check its state of.true
, if the entity is locked, false
elseboolean isLockedOnServer(Entity entity, boolean allSessions)
entity
- The entity in question.allSessions
- If true
, all sessions are checked, otherwise, only the current session is checked.true
, if locked on server.void release(Entity entity) throws LockException
LockException
void release(Entity entity, String comment) throws LockException
LockException
void delete(Entity entity) throws LockException
LockException
@Nullable Workflowable getWorkflowable(Entity entity)
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
).@NotNull Dataset getDataset(@NotNull Entity entity)
getDataset
in interface DatasetProvider
entity
- The entity to get as Dataset.@NotNull Content2Params getContent2Params()
boolean isFiltered()
getContent2Params()
Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408