public interface CentraSiteRegistryObject extends CentraSiteObject
Modifier and Type | Method and Description |
---|---|
java.util.Collection<CentraSiteObject> |
getConsumers()
Get the users who are registered as Consumers for this CentraSiteRegistryObject.
|
java.lang.String |
getDescription()
Get the description of the registry object.
|
java.lang.String |
getDescription(java.util.Locale locale)
Get the description of the registry object for the given locale.
|
java.lang.String |
getDisplayVersion()
Retrieves the display version of a CentraSiteRegistryObject.
|
LCMStateAssignment |
getLCMAssignment()
Return the lifecycle state information of the registry object.
|
java.lang.String |
getLocalName()
Get the Local-Name Classification value of this RegistryObject.
|
java.util.List<Profile> |
getMandatoryAttributeProfiles()
Return the list of profiles for the registry object in which there is at least one mandatory attribute, ordered by the profile sequence number.
|
java.lang.String |
getName()
Get the Name of the CentraSiteRegistryObject.
|
java.lang.String |
getName(java.util.Locale locale)
Get the Name of the CentraSiteRegistryObject for the given locale.
|
java.lang.String |
getNameSpace()
Get the namespace Classification value of this RegistryObject.
|
CentraSiteRegistryObject |
getNextVersion()
Retrieves the CentraSiteRegistryObject representing the next version.
|
java.util.List<CentraSiteRegistryObject> |
getNextVersions()
Retrieves the List of CentraSiteRegistryObject representing the next
versions.
|
Organization |
getOrganization()
Retrieves the belonging Organization of the CentraSiteRegistryObject.
|
User |
getOwner()
Retrieves the owner of the CentraSiteRegistryObject.
|
java.util.Collection<ApprovalFlow> |
getPendingApprovals()
Gets the pending approvals for the CentraSiteRegistryObject.
|
CentraSiteRegistryObject |
getPreviousVersion()
Retrieves the
CentraSiteRegistryObject representing the previous version. |
java.util.List<CentraSiteRegistryObject> |
getPreviousVersions()
Retrieves the List of CentraSiteRegistryObjects representing the previous
versions.
|
java.lang.Object |
getRegistryObject()
Get the underlying registry object for this
CentraSiteRegistryObject instance. |
java.util.Collection<User> |
getSubscribers()
Get the users who have subscribed to (or watching) this CentraSiteRegistryObject for notifications.
|
java.lang.String |
getSystemVersion()
Retrieves the system version of the CentraSiteRegistryObject.
|
java.lang.String |
getTitle(java.lang.String messageId)
Returns the string corresponding to the given messageId based on User locale.
|
java.lang.String |
getUserVersion()
Retrieves the user version of this CentraSiteRegistryObject.
|
java.util.List<CSROProfile> |
getVisiblePrimaryProfiles()
Get the list of primary
Profile s including inherited profiles in case of Virtual Types based on the current user permission. |
CSROProfile |
getVisibleProfile(java.lang.String profileId)
Return the primary or nested profile based which is visible based on the given id.
|
boolean |
isDeployedOn(Target target)
Checks whether the current registry object is deployed on the given target instance.
|
boolean |
isLatestVersionObject()
Checks if current object is the maximum (or only) version object.
|
boolean |
isPropagatePermissions()
Check whether this registry object can propagate its permissions to its dependent objects or not.
|
boolean |
isPropagateProfilePermissions()
Check whether this registry object can propagate its profile permissions to its dependent objects or not.
|
void |
setDescription(java.lang.String description)
Set the description of the registry object for the current user locale.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Set the description of the registry object for the given locale.
|
void |
setDisplayVersion(java.lang.String userVersion)
Updates the user version according to the given parameter.
|
void |
setLCMState(LCMState lcmState)
Set the LCMState to CentraSiteRegistryObject.
|
void |
setLocalName(java.lang.String localName)
Set the Local-Name Classification of this RegistryObject.
|
void |
setName(java.lang.String name)
Sets the Name to the CentraSiteRegistryObject for the current user locale.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Set the name in the given locale.
|
void |
setNameSpace(java.lang.String nameSpace)
Set the namespace Classification of this RegistryObject.
|
void |
setOrganization(Organization organization)
Set the belonging Organization of the CentraSiteRegistryObject.
|
void |
setOwner(User user)
Sets the owner of the CentraSiteRegistryObject.
|
void |
setPropagatePermissions(boolean propagatePermissions)
Set whether the registry object should propagate the permissions to its dependent objects or not.
|
void |
setPropagateProfilePermissions(boolean propagateProfilePermissions)
Set whether this registry object can propagate its profile permissions to its dependent objects or not.
|
void |
setUserVersion(java.lang.String userVersion)
Updates the user version according to the given parameter.
|
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
java.lang.String getName() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.java.lang.String getName(java.util.Locale locale) throws CLLException
locale
- Locale
which represent the languageCLLException
- If an error occurs while trying to fetch the required property.void setName(java.lang.String name) throws CLLException
name
- Name of the CentraSiteRegistryObject to set.CLLException
- If an error occurs while trying to set the required property.void setName(java.lang.String name, java.util.Locale locale) throws CLLException
name
- Name of the CentraSiteRegistryObject.locale
- Locale
to store the name in the given locale.CLLException
- If an error occurs while trying to set the required property.java.lang.String getDescription() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.java.lang.String getDescription(java.util.Locale locale) throws CLLException
locale
- The Locale
for the desired value. If null the default locale is used.CLLException
- If an error occurs while trying to fetch the required property.void setDescription(java.lang.String description) throws CLLException
description
- The description to set for registry object.CLLException
- If an error occurs while trying to set the required property.void setDescription(java.lang.String description, java.util.Locale locale) throws CLLException
description
- The description to set for the registry object.locale
- The Locale
for the descriptionCLLException
- If an error occurs while trying to set the required property.java.lang.String getUserVersion() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.void setUserVersion(java.lang.String userVersion) throws CLLException
userVersion
- User specified versionCLLException
- If an error occurs while setting the user versionjava.lang.String getDisplayVersion() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.void setDisplayVersion(java.lang.String userVersion) throws CLLException
userVersion
- User specified versionCLLException
- If an error occurs while trying to set the required property.CentraSiteRegistryObject getPreviousVersion() throws CLLException
CentraSiteRegistryObject
representing the previous version. If there is none the method returns null.CentraSiteRegistryObject
representing the version prior to current versionCLLException
- If an error occurs while trying to fetch the the previous version registry objectjava.util.List<CentraSiteRegistryObject> getPreviousVersions() throws CLLException
List
of CentraSiteRegistryObject
s representing versions prior to the current versionCLLException
- If an error occurs while trying to fetch the registry objects for the previous versionsCentraSiteRegistryObject getNextVersion() throws CLLException
CentraSiteRegistryObject
representing version next to current versionCLLException
- If fetching newer version failsjava.util.List<CentraSiteRegistryObject> getNextVersions() throws CLLException
List
of CentraSiteRegistryObject
s representing versions next to the current versionCLLException
- If fetching newer versions failsjava.lang.String getSystemVersion() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.boolean isLatestVersionObject() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.User getOwner() throws CLLException
User
who is the owner of the CentraSiteRegistryObjectCLLException
- If an error occurs while trying to fetch the required property.void setOwner(User user) throws CLLException
user
- The User
who has to be set as the owner of the CentraSiteRegistryObjectCLLException
- If an error occurs while trying to set the required property.Organization getOrganization() throws CLLException
Organization
to which the CentraSiteRegistryObject belongsCLLException
- If an error occurs while trying to fetch the required property.void setOrganization(Organization organization) throws CLLException
organization
- The Organization
to set for the CentraSiteRegistryObjectCLLException
- If an error occurs while trying to set the required property.java.util.List<CSROProfile> getVisiblePrimaryProfiles() throws CLLException
Profile
s including inherited profiles in case of Virtual Types based on the current user permission.List
of primary CSROProfile
s based on the current user permission.CLLException
- If an error occurs while trying to fetch the required property.CSROProfile getVisibleProfile(java.lang.String profileId) throws CLLException
profileId
- unique identifier of the profileCSROProfile
corresponding to the given profileIdCLLException
- In case of a failure to get the profile by the given id.java.util.Collection<User> getSubscribers() throws CLLException
Collection
of User
s who are subscribers/watchers to this CentraSiteRegistryObjectCLLException
- If an error occurs while trying to fetch the required property.java.util.Collection<CentraSiteObject> getConsumers() throws CLLException
Collection
of User
s who are consumers to this CentraSiteRegistryObjectCLLException
- If an error occurs while trying to fetch the required property.java.util.Collection<ApprovalFlow> getPendingApprovals() throws CLLException
Collection
of ApprovalFlow
objects which are pending for this registry objectCLLException
- If an error occurs while trying to fetch the required property.LCMStateAssignment getLCMAssignment() throws CLLException
LCMStateAssignment
instance which gives the current life cycle state informationCLLException
- In case of a failure to get the LCMStateAssignment assigned to CentraSiteRegistryObject.void setLCMState(LCMState lcmState) throws CLLException
lcmState
- State of the CentraSiteRegistryObject as a LCMState
instanceCLLException
- In case of a failure to change the current state of CentraSiteRegistryObjectvoid setLocalName(java.lang.String localName) throws CLLException
localName
- Value for the Local-Name ClassificationCLLException
- If an error occurs while trying to set the required property.java.lang.String getLocalName() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.void setNameSpace(java.lang.String nameSpace) throws CLLException
nameSpace
- Value for the NameSpace ClassificationCLLException
- If an error occurs while trying to set the required property.java.lang.String getNameSpace() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.java.util.List<Profile> getMandatoryAttributeProfiles() throws CLLException
List
of Profile
s for the registry objectCLLException
- If an error occurs while trying to fetch the required property.void setPropagatePermissions(boolean propagatePermissions) throws CLLException
propagatePermissions
- If true, the registry object will propagate its permissions to its dependent objects
and if false, the permissions are not propagated to its dependent objects.CLLException
- If an error occurs while trying to set the required property.boolean isPropagatePermissions() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.void setPropagateProfilePermissions(boolean propagateProfilePermissions) throws CLLException
propagateProfilePermissions
- The profile related permissions for this registry object can be propagated if set to true and cannot be propagated if set to falseCLLException
- If an error occurs while trying to set the required property.boolean isPropagateProfilePermissions() throws CLLException
CLLException
- If an error occurs while trying to fetch the required property.java.lang.Object getRegistryObject() throws CLLException
CentraSiteRegistryObject
instance.RegistryObject
CLLException
- If an error occurs while trying to fetch the required property.boolean isDeployedOn(Target target) throws CLLException
target
- The Target
instanceCLLException
- If an error occurs while trying to fetch the required property.java.lang.String getTitle(java.lang.String messageId) throws CLLException
messageId
- The message IdCLLException
- If an error occurs while trying to fetch the required property.