public interface PackagePoolItem extends IDProvider
PackagePool items have an attribute #PPOOL_ATTRIBUTE
inthe format:
Items in master project:
pp:"'PACKAGENAME'" (e.g. pp:"content")
Subscribed Items:
pp:"'PACKAGENAME' + : + 'SourceNodeVersion' + , + 'TargetNodeVersion'" (e.g. pp:"content:3,1")
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static int |
BLOCKED
Indicator for the blocked state.
|
static int |
MODIFIED
Indicator for the modified state.
|
static int |
UNMODIFIED
Indicator for the unmodified state.
|
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
void |
addToPackage(Package pck)
Adds this node, all children and
referenced nodes which arePackagePoolItem s to the specified package. |
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 |
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. |
void |
setChangeState(int changeState)
Sets the change state for this PackagePoolItem.
|
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, 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 int UNMODIFIED
getChangeState()
,
setChangeState(int)
,
Constant Field Valuesstatic final int MODIFIED
getChangeState()
,
setChangeState(int)
,
Constant Field Valuesstatic final int BLOCKED
getChangeState()
,
setChangeState(int)
,
Constant Field Values@ApiDoc(comment="Return true if the item is part of a Package.", since="3.1.158") boolean isPackageItem()
true
if the item is part of a Package
@ApiDoc(comment="Return true if this node has been imported by a Subscription.", since="3.1.158") boolean isSubscribedItem()
true
if this node has been imported by a Subscription
@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
referenced nodes
which arePackagePoolItem
s 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.namespace enhancement
is activatednamespace enhancement
is activatedPackagePoolItem#PPOOL_ATTRIBUTE
to the package name
.IllegalStateException
- if the attribute PackagePoolItem#PPOOL_ATTRIBUTE
is already setSecurityException
- if the permission Permission.CAN_CHANGE
is not grantedIllegalStateException
- if the node is not lockedUnsupportedOperationException
- if this node is from release storeLockException
ElementDeletedException
addToPackage(Package)
@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
nodes referencing this nodes
which are PackagePoolItems's
from the specified package.locked
when calling this method. The givenPackage
must be locked when removing this node and must be saved afterwards.pck
- the package to remove this node fromLockException
ElementDeletedException
@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)
true
if this node is neither an package nor an subscribed item and is an allowed contenttype for the specified packageisPackageItem()
,
isSubscribedItem()
@ApiDoc(comment="Checks if this PackagePoolItem is changeable.", since="3.1.158") boolean isChangeable()
isPackageItem()
delivers true
a call to this method will also deliver true
subscribed items
this method checks against the read-only attribute in the belongingsubscription ( Subscription.isChangeable()
)true
if this subscribed item is changeable, false
otherwise@ApiDoc(comment="Returns the name of the package this item belongs to.", since="3.1.158") String getPackageName()
@ApiDoc(comment="Returns the Package this item belongs to or null.", since="3.1.158") @Nullable Package getPackage()
Package
this item belongs to or null
.ServiceNotFoundException
- if this element belongs to a package
or asubscription
but the ppool service
is not reachable@ApiDoc(comment="Returns the change state of this PackagePoolItem either UNMODIFIED, MODIFIED or BLOCKED.", since="3.1.172") int getChangeState()
UNMODIFIED
, MODIFIED
or BLOCKED
. -1 will be returned for items which aren't subscribed item's
or if the state could not be establishedUNMODIFIED
, MODIFIED
or BLOCKED
)@ApiDoc(comment="Sets the change state for this PackagePoolItem.", since="3.1.172") void setChangeState(int changeState) throws IllegalAccessException
changeState
- either UNMODIFIED
, MODIFIED
or BLOCKED
IllegalAccessException
- if this item isn't a subscribed item
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210