|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LCModel
LC Models are state machines for Lifecycle Management and the
state machines may not have any states that cannot be reached
The LCModel
provides methods for all operations
that can be performed on an LCModel
When the LCModel becomes active, no change in the LCModel
will be allowed. Instead, a new version of the LCModel
can be created using LCMAdminManager.createNewVersion(LCModel).
Refer to CentraSiteVMS to know more about versioning of registry objects.
Method Summary | |
---|---|
boolean |
activable(LCModelState lcModelState)
Checks whether this LC Model can be activated |
boolean |
addEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes)
Enables the given registry types for LCM with this LCModel |
boolean |
addEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes,
boolean enableAsLCMforLCM)
Enables the given registry types for LCM with this LCModel and enables this LCModel as LCM for LCModels if the enableAsLCMforLCM is specified true. |
boolean |
addStates(java.util.Collection<LCState> states)
Adds the given states to this LCModel |
void |
deleteModel()
delete the model |
javax.xml.registry.infomodel.InternationalString |
getDescription()
Returns the description of this LCModel |
javax.xml.registry.infomodel.InternationalString |
getDisplayName()
Returns the displayName of this LCModel |
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getEnabledTypes()
Returns the types enabled for LCM with this LCModel |
LCState |
getInitialState()
Returns the initialState of this LCModel |
javax.xml.registry.infomodel.ClassificationScheme |
getModelClassificationScheme()
Return the underlying LCModel Classification Scheme |
LCModel |
getOldVersion()
if this lc model has old version returns the same, else return null |
javax.xml.registry.infomodel.Organization |
getOrganization()
Returns the organization to which the LCModel belongs to |
java.util.Collection<LCState> |
getStates()
Returns the states of the LCModel |
boolean |
isActive()
Checks whether the model is Active. |
boolean |
isGlobal()
Checks whether the model is global. |
boolean |
isInactive()
Checks whether the model is Inactive. |
boolean |
isLCMForLCM()
Checks whether the model is a LCM for LCM |
boolean |
isRetired()
Checks whether the model is Retired. |
boolean |
isSuperseded()
Checks whether the model is Superseded. |
boolean |
removeEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes)
Removes the given types for LCM with this LCModel. |
boolean |
removeEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes,
boolean disableAsLCMforLCM)
Removes the given types for LCM with this LCModel and disables this LCModel as LCM for LCModels if the disableAsLCMforLCM is specified true. |
boolean |
removeState(LCState state)
Remove the given state from the LCModel |
void |
setDescription(javax.xml.registry.infomodel.InternationalString description)
Sets the description for the model |
void |
setDisplayName(javax.xml.registry.infomodel.InternationalString displayName)
Set the display name of the model |
void |
setInitialState(LCState state)
Set the initial state for the LCModel. |
void |
setModelState(LCModelState modelState)
Sets the state of the model |
void |
setOrganization(javax.xml.registry.infomodel.Organization organization,
boolean global)
Set the organization for this model |
void |
validate()
Validates this LCModel |
Method Detail |
---|
javax.xml.registry.infomodel.InternationalString getDisplayName() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorjavax.xml.registry.infomodel.InternationalString getDescription() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorjava.util.Collection<javax.xml.registry.infomodel.Concept> getEnabledTypes() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorLCState getInitialState() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorjavax.xml.registry.infomodel.Organization getOrganization() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorjava.util.Collection<LCState> getStates() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorvoid setDisplayName(javax.xml.registry.infomodel.InternationalString displayName) throws LCMException
displayName
-
LCMException
- - if the LCM provider encounters an internal errorvoid setDescription(javax.xml.registry.infomodel.InternationalString description) throws LCMException
description
- to be set
LCMException
- - if the LCM provider encounters an internal errorvoid setOrganization(javax.xml.registry.infomodel.Organization organization, boolean global) throws LCMException
organization
- for the model
LCMException
- - if the LCM provider encounters an internal errorvoid setInitialState(LCState state) throws LCMException
state
- to be set as the initial state for this model
LCMException
- if the given state is not a part of the model
at the time of calling this methodvoid setModelState(LCModelState modelState) throws LCMException
modelState
- - LCModelState to be set
LCMException
- - if the LCM provider encounters an internal errorboolean addEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes) throws LCMException
registryTypes
- to be enabled for this LCModel
LCMException
- - if the LCM provider encounters an internal errorboolean addEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes, boolean enableAsLCMforLCM) throws LCMException
registryTypes
- to be enabled for this LCModelenableAsLCMforLCM
- to be enabled as LCM for LCModels
LCMException
- - if the LCM provider encounters an internal errorboolean addStates(java.util.Collection<LCState> states) throws LCMException
states
- to be added to this LCModel
LCMException
boolean removeState(LCState state) throws LCMException
state
- The LCState that has to be removed from this LCModel
LCMException
- - if the LCM provider encounters an internal errorboolean removeEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes) throws LCMException
registryTypes
- collection of types that can be removed for LCM
LCMException
- - if the LCM provider encounters an internal errorboolean removeEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes, boolean disableAsLCMforLCM) throws LCMException
registryTypes
- collection of types that can be removed for LCMdisableAsLCMforLCM
- to be disabled as LCM for LCModels
LCMException
- - if the LCM provider encounters an internal errorboolean isGlobal() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorboolean isLCMForLCM() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorvoid validate() throws LCMException
LCMException
- - if the validation fails or
if the LCM provider encounters an internal errorjavax.xml.registry.infomodel.ClassificationScheme getModelClassificationScheme() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorboolean activable(LCModelState lcModelState) throws LCMException
lcModelState
-
LCMException
LCModel getOldVersion() throws LCMException
LCMException
boolean isInactive()
boolean isActive()
boolean isSuperseded()
boolean isRetired()
void deleteModel() throws LCMException
LCMException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |