public interface LCModel
Modifier and Type | Method and Description |
---|---|
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 the LCM for LCModels if the enableAsLCMforLCM
is specified as
true . |
boolean |
addStates(java.util.Collection<LCState> states)
Adds the given states to this LCModel
|
void |
deleteModel()
Deletes the current model
|
javax.xml.registry.infomodel.InternationalString |
getDescription()
For the given LCModel returns the description
|
javax.xml.registry.infomodel.InternationalString |
getDisplayName()
For the given LCModel returns the displayName
|
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getEnabledTypes()
For the given LCModel returns the enabled types
|
LCState |
getInitialState()
For the given LCModel returns the initialState
|
javax.xml.registry.infomodel.ClassificationScheme |
getModelClassificationScheme()
Returns the underlying LCModel Classification Scheme
|
LCModel |
getOldVersion()
If this LC Model has an old version, then the old version is returned, otherwise returns null.
|
javax.xml.registry.infomodel.Organization |
getOrganization()
Returns the organization to which the current LCModel belongs
|
java.util.Collection<LCState> |
getStates()
Returns the states of the LCModel
|
boolean |
isActive()
Checks whether the current model is Active.
|
boolean |
isGlobal()
Checks whether the current model is global.
|
boolean |
isInactive()
Checks whether the current model is Inactive.
|
boolean |
isLCMForLCM()
Checks whether the current model is a LCM for LCM
|
boolean |
isRetired()
Checks whether the current model is Retired.
|
boolean |
isSuperseded()
Checks whether the current 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 the LCM for LCModels if the disableAsLCMforLCM
is specified as true.
|
boolean |
removeState(LCState state)
Removes 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)
Sets the display name of the model
|
void |
setInitialState(LCState state)
Sets 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 the current LCModel
|
javax.xml.registry.infomodel.InternationalString getDisplayName() throws LCMException
InternationalString
LCMException
- if the LCM provider encounters an internal error while dealing with InternationalStringjavax.xml.registry.infomodel.InternationalString getDescription() throws LCMException
InternationalString
LCMException
- if the LCM provider encounters an internal error while dealing with InternationalStringjava.util.Collection<javax.xml.registry.infomodel.Concept> getEnabledTypes() throws LCMException
Concept
, enabled types cannot be nullLCMException
- if the LCM provider encounters an internal error while retrieving the enabled typesLCState getInitialState() throws LCMException
LCState
LCMException
- if the LCM provider encounters an internal error while retrieving the initialStatejavax.xml.registry.infomodel.Organization getOrganization() throws LCMException
Organization
LCMException
- if the LCM provider encounters an internal error while retrieving the organizationjava.util.Collection<LCState> getStates() throws LCMException
LCState
, LC States cannot be nullLCMException
- if the LCM provider encounters an internal error while retrieving the statesvoid setDisplayName(javax.xml.registry.infomodel.InternationalString displayName) throws LCMException
displayName
- the displayName of the model as InternationalString
LCMException
- if the LCM provider encounters an internal error while updating the displayNamevoid setDescription(javax.xml.registry.infomodel.InternationalString description) throws LCMException
description
- the description of the model as InternationalString
LCMException
- if the LCM provider encounters an internal error while updating the descriptionvoid setOrganization(javax.xml.registry.infomodel.Organization organization, boolean global) throws LCMException
organization
- the organization for the model as Organization
global
- To set the slot - pendingLCMException
- if the LCM provider encounters an internal error while updating the organizationvoid setInitialState(LCState state) throws LCMException
state
- the state to be set as the initial state for this modelLCMException
- 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 setLCMException
- if the LCM provider encounters an internal error while updating the modelStateboolean addEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes) throws LCMException
registryTypes
- A collection of registryTypes of type Concept
to be enabled for this LCModeltrue
if all the given types are added, false otherwiseLCMException
- if the LCM provider encounters an internal error while adding the enabled typesboolean addEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes, boolean enableAsLCMforLCM) throws LCMException
true
.registryTypes
- the registry types to be enabled for this LCModelenableAsLCMforLCM
- flag whether to set the LCM as the LCM for LCModelstrue
if all the given types are added, false otherwiseLCMException
- if the LCM provider encounters an internal error while adding the enabled typesboolean addStates(java.util.Collection<LCState> states) throws LCMException
states
- the states to be added to this LCModelLCMException
- if the LCM provider encounters an internal error while adding the statesboolean removeState(LCState state) throws LCMException
state
- The LCState
that has to be removed from this LCModeltrue
if the given state is successfully removed, false otherwiseLCMException
- if the LCM provider encounters an internal error while removing the stateboolean removeEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes) throws LCMException
registryTypes
- the collection of types that can be removed for LCMtrue
if the LCModel is deleted as a result of the call, false otherwiseLCMException
- if the LCM provider encounters an internal error while removing the enabled typesboolean removeEnabledTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> registryTypes, boolean disableAsLCMforLCM) throws LCMException
registryTypes
- the collection of types that can be removed for LCMdisableAsLCMforLCM
- the flag for disabling the LCM for LCModelstrue
if the LCModel is deleted as a result of the call, false
otherwiseLCMException
- if the LCM provider encounters an internal error while removing the enabled typesboolean isGlobal() throws LCMException
true
if the above condition is met, false
otherwiseLCMException
- if the LCM provider encounters an internal errorboolean isLCMForLCM() throws LCMException
true
if the above condition is met, false
otherwiseLCMException
- 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
ClassificationScheme
objectLCMException
- if the LCM provider encounters an internal errorboolean activable(LCModelState lcModelState) throws LCMException
lcModelState
- the life cycle model state object.true
if it can be activated, else throws an LCMExceptionLCMException
- if the LCM provider encounters an internal errorLCModel getOldVersion() throws LCMException
LCModel
if any, null otherwiseLCMException
- if the LCM provider encounters an internal error while retrieving the old versionboolean isInactive()
true
if the model is Inactive, false
otherwiseboolean isActive()
true
if the model is Active, false
otherwiseboolean isSuperseded()
true
if the model is Superseded, false
otherwiseboolean isRetired()
true
if the model is Retired, false
otherwisevoid deleteModel() throws LCMException
LCMException
- if the LCM provider encounters an internal error while deleting the model