Package de.espirit.firstspirit.access.store

Interface PackagePoolItem

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, Workflowable

All Known Subinterfaces:

Content2, Content2Section, FormatTemplate, FormatTemplateFolder, GCAPage, GCASection, LinkTemplate, MasterTemplate, Media, Page, PageRef, PageRefFolder, PageTemplate, Query, Schema, SchemaFolder, Script, ScriptFolder, Section<T>, SectionReference<T>, SectionTemplate, StyleTemplate, TableFormatTemplate, TableTemplate, Template, TemplateFolder<T>, Workflow, WorkflowFolder

public interface PackagePoolItem
extends IDProvider

All items which may be added to a package implement this.

PackagePool items have an attribute in the format:
Items in master project:
pp:"'PACKAGENAME'" (e.g. pp:"content")
Subscribed Items:
pp:"'PACKAGENAME' + : + 'SourceNodeVersion' + , + 'TargetNodeVersion'" (e.g. pp:"content:3,1")

Since:

3.1.158

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 int	BLOCKED	Indicator for the blocked state.
static final int	MODIFIED	Indicator for the modified state.
static final int	UNMODIFIED	Indicator for the unmodified state.

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

Method Summary

Modifier and Type	Method	Description
void	addToPackage(Package pck)	Adds this node, all children and referenced nodes which are PackagePoolItems to the specified package.
int	getChangeState()	Returns the change state of this PackagePoolItem either UNMODIFIED, MODIFIED or BLOCKED.
@Nullable Package	getPackage()	Returns the Package this item belongs to or null.
String	getPackageName()	Returns the name of the package this item belongs to.
boolean	isAddable(Package pck)
boolean	isChangeable()	Checks if this PackagePoolItem is changeable.
boolean	isPackageItem()
boolean	isSubscribedItem()
void	removeFromPackage(Package pck)	Removes this node, all children and nodes referencing this nodes which are PackagePoolItems's from the specified package. This node needn't to be locked when calling this method.
void	setChangeState(int changeState)	Sets the change state for this PackagePoolItem.

Methods inherited from interface java.lang.Comparable

compareTo

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, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

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, 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

UNMODIFIED

static final int UNMODIFIED

Indicator for the unmodified state.

Since:

3.1.172

See Also:

• getChangeState()
• setChangeState(int)
• Constant Field Values

MODIFIED

static final int MODIFIED

Indicator for the modified state.

Since:

3.1.172

See Also:

• getChangeState()
• setChangeState(int)
• Constant Field Values

BLOCKED

static final int BLOCKED

Indicator for the blocked state.

Since:

3.1.172

See Also:

• getChangeState()
• setChangeState(int)
• Constant Field Values

Method Details

isPackageItem

@ApiDoc(comment="Return true if the item is part of a Package.",
        since="3.1.158")
boolean isPackageItem()

Returns:

true if the item is part of a Package

Since:

3.1.158

isSubscribedItem

@ApiDoc(comment="Return true if this node has been imported by a Subscription.",
        since="3.1.158")
boolean isSubscribedItem()

Returns:

true if this node has been imported by a Subscription

Since:

3.1.158

addToPackage

@ApiDoc(comment="Adds this node, all children and referenced nodes which are PackagePoolItems to the specified package.",
        since="3.1.158")
void addToPackage(Package pck)
           throws LockException,
ElementDeletedException

Adds this node, all children and referenced nodes which are PackagePoolItems to the specified package. To be added, this node must be present and must not be locked. Additionally, the given Package must be locked when adding this node and must be saved afterwards.
The following modifications are performed:

• adds "@package-Name" to the unique identifier, if namespace enhancement is activated
• adds "@package-Name" to the display name, if namespace enhancement is activated
• sets the attribute to the package name.
• add this node to the start node list of the specified package

Throws:

IllegalStateException - if the attribute is already set

SecurityException - if the permission Permission.CAN_CHANGE is not granted

IllegalStateException - if the node is not locked

UnsupportedOperationException - if this node is from release store

LockException

ElementDeletedException

Since:

3.1.158

See Also:

• addToPackage(Package)

removeFromPackage

@ApiDoc(comment="Removes this node, all children and nodes referencing this nodes which are PackagePoolItems\'s from the specified package.",
        since="3.1.192")
void removeFromPackage(Package pck)
                throws LockException,
ElementDeletedException

Removes this node, all children and nodes referencing this nodes which are PackagePoolItems's from the specified package.
This node needn't to be locked when calling this method. The given Package must be locked when removing this node and must be saved afterwards.

Parameters:

pck - the package to remove this node from

Throws:

LockException

ElementDeletedException

Since:

3.1.192

isAddable

@ApiDoc(comment="Return true if this node is neither an package nor an subscribed item and is an allowed content type for the specified package.",
        since="3.1.158")
boolean isAddable(Package pck)

Returns:

true if this node is neither an package nor an subscribed item and is an allowed content type for the specified package

Since:

3.1.158

See Also:

• isPackageItem()
• isSubscribedItem()

isChangeable

@ApiDoc(comment="Checks if this PackagePoolItem is changeable.",
        since="3.1.158")
boolean isChangeable()

Checks if this PackagePoolItem is changeable. If isPackageItem() delivers true a call to this method will also deliver true
For subscribed items this method checks against the read-only attribute in the belonging subscription (Subscription.isChangeable())

Returns:

true if this subscribed item is changeable, false otherwise

Since:

3.1.158

getPackageName

@ApiDoc(comment="Returns the name of the package this item belongs to.",
        since="3.1.158")
String getPackageName()

Returns the name of the package this item belongs to.

Returns:

the name of the belonging package

Since:

3.1.158

getPackage

@ApiDoc(comment="Returns the Package this item belongs to or null.",
        since="3.1.158")
@Nullable
@Nullable Package getPackage()

Returns the Package this item belongs to or null.

Returns:

the package this item belongs to

Throws:

ServiceNotFoundException - if this element belongs to a package or a subscription but the ppool service is not reachable

Since:

3.1.158

getChangeState

@ApiDoc(comment="Returns the change state of this PackagePoolItem either UNMODIFIED, MODIFIED or BLOCKED.",
        since="3.1.172")
int getChangeState()

Returns the change state of this PackagePoolItem either UNMODIFIED, MODIFIED or BLOCKED. -1 will be returned for items which aren't subscribed item's or if the state could not be established

Returns:

the change state (UNMODIFIED, MODIFIED or BLOCKED)

Since:

3.1.172

setChangeState

@ApiDoc(comment="Sets the change state for this PackagePoolItem.",
        since="3.1.172")
void setChangeState(int changeState)
             throws IllegalAccessException

Sets the change state for this PackagePoolItem. Valid values are UNMODIFIED, MODIFIED or BLOCKED

Parameters:

changeState - either UNMODIFIED, MODIFIED or BLOCKED

Throws:

IllegalAccessException - if this item isn't a subscribed item

Since:

3.1.172