public interface Section<T extends SectionTemplate> extends DataProvider, TemplateProvider<T>, PackagePoolItem
Body.getChildren(Section.class)
.IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static long |
OPEN_ENDED
Indicator for open ended lifespan
|
BLOCKED, MODIFIED, UNMODIFIED
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
void |
excludeFromOutput(Language language)
Excludes this section from the output for the given language.
|
long[] |
getLifespan()
Get the lifespan of the current section if there is one defined.
|
String |
getName()
Get the name of the section
|
T |
getTemplate()
Returns the template of this element.
|
void |
includeInOutput(Language language)
Includes this section in the output for the given language.
|
boolean |
isInLifespan()
Indicates whether the
actual time is included in the lifespan of this section. |
boolean |
isInLifespan(long time)
Indicates whether the given timestamp is included in the lifespan of this section.
|
boolean |
isInOutputIncluded(Language language)
Checks if this section is included in the output
for the given language.
|
boolean |
isReference()
Is this a reference section?
|
void |
removeLifespan()
Remove lifespan of the current section.
|
void |
setLifespan(long from,
long to)
Set the lifespan of the current section.
|
void |
setName(String name)
Set the name of a section
|
void |
setTemplate(T template)
Set the template for this section.
|
clearCachedData, getData, getFormData, setData, setFormData
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, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, 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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
static final long OPEN_ENDED
@ApiDoc(comment="Get the name of the section", since="3.0") @NotNull String getName()
getName
in interface StoreElement
@ApiDoc(comment="Set the name of a section", since="3.0") void setName(String name)
name
- new name of a section@ApiDoc(comment="Returns the template of this element.", since="3.0") @NotNull T getTemplate() throws ReferenceNotFoundException
getTemplate
in interface TemplateProvider<T extends SectionTemplate>
ReferenceNotFoundException
- if template is missing@ApiDoc(comment="Set the template for this section.", since="4.1.25") void setTemplate(@NotNull T template)
template
- new templateNullPointerException
- if sectionTemplate
is null
@ApiDoc(comment="Get the lifespan of the current section if there is one defined.", since="3.0") @Nullable long[] getLifespan()
null
or an array with two elements: 1.) start date, 2.) end date or -1L
for no
restriction.setLifespan(long, long)
,
removeLifespan()
,
isInLifespan()
@ApiDoc(comment="Set the lifespan of the current section.", since="3.0") void setLifespan(long from, long to)
from
- start date for lifespan (in milliseconds since 1.1.1970 0:00 UTC)to
- end date for lifespan (in milliseconds since 1.1.1970 0:00 UTC) or -1L
for no restrictiongetLifespan()
,
removeLifespan()
,
isInLifespan()
@ApiDoc(comment="Remove lifespan of the current section.", since="3.0") void removeLifespan()
getLifespan()
,
setLifespan(long, long)
,
isInLifespan()
@ApiDoc(comment="Indicates whether the actual time is included in the lifespan of this section.", since="4.0") boolean isInLifespan()
actual time
is included in the lifespan of this section.
Calls isInLifepan(System.currentTimeMillis())
.true
if no lifespan is set or the actual time is included in the lifespan.getLifespan()
,
setLifespan(long, long)
,
removeLifespan()
@ApiDoc(comment="Indicates whether the given timestamp is included in the lifespan of this section.", since="4.2.200") boolean isInLifespan(long time)
time
- the timestamp to check the lifespan fortrue
if no lifespan is set or the given time is included in the lifespan, false
otherwisegetLifespan()
,
setLifespan(long, long)
,
removeLifespan()
@ApiDoc(comment="Includes this section in the output for the given language.", since="3.0") void includeInOutput(Language language)
language
- the language to include this section for@ApiDoc(comment="Excludes this section from the output for the given language.", since="3.0") void excludeFromOutput(Language language)
language
- the language to exclude for this section@ApiDoc(comment="Checks if this section is included in the output for the given language.", since="3.0") boolean isInOutputIncluded(Language language)
language
- the language to check this section fortrue
if this section is included in the output for this languageCopyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210