public interface LCMState extends CentraSiteRegistryObject
Modifier and Type | Method and Description |
---|---|
java.util.Collection<LCMState> |
getAllowedNextStates()
The next applicable state of the registry object.
|
LCMState |
getAllowedPreferredNextState()
The next preferred state for the registry object.
|
LCM |
getLCM()
Return the LCM to which the state belongs.
|
java.util.Collection<CentraSiteRegistryObject> |
getPermissions()
Return the collection of user or group objects who are allowed to transition into this state.
|
java.util.Collection<Policy> |
getPoliciesAppliedOnState()
Returns the
Collection of design time Policy instances which are applied on this Lifecycle state
through Pre-State or Post-State change events. |
java.util.Collection<LCMStage> |
getPromotionStages()
Returns the collection of Lifecycle Stage objects which are associated with the particular stage.
|
void |
setNextStates(java.util.Collection<LCMState> nextStates) |
void |
setPermissions(java.util.Collection<CentraSiteRegistryObject> userOrGroupObjects)
Specify the collection of user or group objects who are allowed to transition into this state.
|
void |
setPreferredNextState(LCMState preferrednextState) |
void |
setPromotionStages(java.util.Collection<LCMStage> promotionStages)
Sets the promotion stages for the final state of the LCM.
|
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
java.util.Collection<LCMState> getAllowedNextStates() throws CLLException
+----------------------------+ | A --> B --> C --> D | | Initial End | +----------------------------+ The above Life Cycle Model contains the states called A, B, C and D. If the current state is B next allowed states are C.
+----------------------------+ | Initial End | | A --> B --> C --> E | | | | | V | | D | +----------------------------+ The above Life Cycle Model contains the states called A, B, C, D and E. In this case, if the current state is B next allowed states are C and D.
Collection
of LCMState
instances. In case the current LCMState is the last state, then returns null.CLLException
- In case of a failure to get the allowed next states.LCMState getAllowedPreferredNextState() throws CLLException
+----------------------------+ | A --> B --> C --> D | | Initial End | +----------------------------+ The above Life Cycle Model contains the states called A, B, C and D. If the current state is B then the preferred next state is C.
LCMState
. In case the current LCMState is the last state, then returns null.CLLException
- In case of a failure to get the preferred next state.LCM getLCM() throws CLLException
LCM
instance to which the LCMState belongs.CLLException
- In case of a failure to get the LCM.void setNextStates(java.util.Collection<LCMState> nextStates) throws CLLException
CLLException
void setPreferredNextState(LCMState preferrednextState) throws CLLException
CLLException
java.util.Collection<CentraSiteRegistryObject> getPermissions() throws CLLException
CLLException
void setPermissions(java.util.Collection<CentraSiteRegistryObject> userOrGroupObjects) throws CLLException
userOrGroupObjects
- CLLException
java.util.Collection<LCMStage> getPromotionStages() throws CLLException
Collection
of LCMStage
instancesCLLException
- If an error occurs while getting the promotion stagesvoid setPromotionStages(java.util.Collection<LCMStage> promotionStages) throws CLLException
promotionStages
- The Collection
of promotion LCMStage
instancesCLLException
- If an error occurs while setting the promotion stages for the Lifecycle state.java.util.Collection<Policy> getPoliciesAppliedOnState() throws CLLException
Collection
of design time Policy
instances which are applied on this Lifecycle state
through Pre-State or Post-State change events.Collection
of Policy
instances which are applied on this state.CLLException
- If an error occurs while obtaining the policy instances.