public interface PackagePoolItem extends IDProvider
PackagePool items have an attribute #PPOOL_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")
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 and all childs which are
PackagePoolItem s to the specified package. |
int |
getChangeState()
|
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 and all childs which are
PackagePoolItems's from the
given 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, 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
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 Valuesboolean isPackageItem()
true
if the item is part of a Package
boolean isSubscribedItem()
true
if this node has been imported by a Subscription
void addToPackage(Package pck) throws LockException, ElementDeletedException
PackagePoolItem
s to the specified package.namespace enhancement
is activated
namespace enhancement
is activatedPackagePoolItem#PPOOL_ATTRIBUTE
to the 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)
void removeFromPackage(Package pck) throws LockException, ElementDeletedException
PackagePoolItems's
from the
given package.locked
when calling this method.pck
- the package to remove this node fromLockException
ElementDeletedException
boolean isAddable(Package pck)
true
if this node is neither an package nor an subscribed item and is an allowed content
type for the specified packageisPackageItem()
,
isSubscribedItem()
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 belonging
subscription (Subscription.isChangeable()
)true
if this subscribed item is changeable, false
otherwiseString getPackageName()
@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 reachableint 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
)void setChangeState(int changeState) throws IllegalAccessException
changeState
- either UNMODIFIED
, MODIFIED
or BLOCKED
IllegalAccessException
- if this item isn't a subscribed item
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500