com.softwareag.centrasite.api.csom
Interface CentraSiteRegistryObject

All Superinterfaces:
CentraSiteObject
All Known Subinterfaces:
Category, CentraSiteRegistryObjectType, ComputedProfile, CSROProfile, LCM, LCMState, Organization, Profile, Service, Taxonomy, User, XMLSchema

public interface CentraSiteRegistryObject
extends CentraSiteObject

CentraSiteRegistryObject is used to represent the CentraSite Registry objects.
CentraSite Model classes should inherit the CentraSiteRegistryObject


Method Summary
 java.util.Collection<CentraSiteObject> getConsumers()
          gets 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.
 java.lang.String getDisplayVersion()
          Retrieves the display version of a CentraSiteRegistryObject.
 LCMStateAssignment getLCMAssignment()
          Return the lifecycle state information of the CSRO
 java.lang.String getLocalName()
          fetch Local-Name Classification of this RegistryObject.
 java.util.List<Profile> getMandatoryAttributeProfiles()
          Return the list of profiles for the CSRO in which there is atleast 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()
          fetch namespace Classification 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 Organization of the CentraSiteRegistryObject
 User getOwner()
          Retrieves the owner of the CentraSiteRegistryObject
 CentraSiteRegistryObject getPreviousVersion()
          Retrieves the CentraSiteRegistryObject representing the previous version.
 java.util.List<CentraSiteRegistryObject> getPreviousVersions()
          Retrieves the List of CentraSiteRegistryObject representing the previous versions.
 java.lang.Object getRegistryObject()
           
 java.util.Collection<User> getSubscribers()
          gets 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 getUserVersion()
          Retrieves the user version of the CentraSiteRegistryObject
 java.util.List<CSROProfile> getVisiblePrimaryProfiles()
          get the list of primary Profiles including inherited profiles in case of Virtual Types based on the current user permission
 boolean isLatestVersionObject()
          Checks if current object is the maximum (or only) version object
true: is the maximum (or only) version object
false: its an intermediate version object
 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.
 void setDisplayVersion(java.lang.String userVersion)
          Updates the user version according to the given parameter
 void setLCMState(LCMState lcmState)
          Allowed to set the LCMState to CentraSiteRegistryObject.
 void setLocalName(java.lang.String localName)
          Set 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 namespace Classification of this RegistryObject.
 void setOrganization(Organization organization)
          set the Organization of the CentraSiteRegistryObject
 void setOwner(User user)
          sets the owner of the CentraSiteRegistryObject
 void setUserVersion(java.lang.String userVersion)
          Updates the user version according to the given parameter
 
Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteObject
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
 

Method Detail

getName

java.lang.String getName()
                         throws CLLException
Get the Name of the CentraSiteRegistryObject

Returns:
name of the CentraSiteRegistryObject.
Throws:
CLLException

getName

java.lang.String getName(java.util.Locale locale)
                         throws CLLException
Get the Name of the CentraSiteRegistryObject for the given locale

Parameters:
locale - Locale which represent the language
Returns:
a name for given locale that is appropriate for display to the user.
Throws:
CLLException

setName

void setName(java.lang.String name)
             throws CLLException
Sets the Name to the CentraSiteRegistryObject for the current user locale.

Parameters:
name - of the CentraSiteRegistryObject.
Throws:
CLLException

setName

void setName(java.lang.String name,
             java.util.Locale locale)
             throws CLLException
Set the name in the given locale.

Parameters:
name - of the CentraSiteRegistryObject.
locale - name going to store in the given locale.
Throws:
CLLException

getDescription

java.lang.String getDescription()
                                throws CLLException
Get the description of the registry object.

Returns:
description of the registry object.
Throws:
CLLException

getDescription

java.lang.String getDescription(java.util.Locale locale)
                                throws CLLException
Get the description of the registry object.

Parameters:
locale - The Locale for the desired value. If null the default locale is used.
Returns:
description of the registry object in a given locale.
Throws:
CLLException

setDescription

void setDescription(java.lang.String description)
                    throws CLLException
Set the description of the registry object for the current user locale.

Parameters:
description - description of registry object.
Throws:
CLLException

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)
                    throws CLLException
Set the description of the registry object.

Parameters:
description - description of registry object.
locale - description of the registry object is in a given locale.
Throws:
CLLException

getUserVersion

java.lang.String getUserVersion()
                                throws CLLException
Retrieves the user version of the CentraSiteRegistryObject

Returns:
user version of the CentraSiteRegistryObject if specified by user. Otherwise returns empty String
Throws:
CLLException

setUserVersion

void setUserVersion(java.lang.String userVersion)
                    throws CLLException
Updates the user version according to the given parameter

Parameters:
userVersion - user specified version
Throws:
CLLException - will be thrown if setting user version fails

getDisplayVersion

java.lang.String getDisplayVersion()
                                   throws CLLException
Retrieves the display version of a CentraSiteRegistryObject. If the user version is not empty it returns the user version. Otherwise it returns the system version.

Returns:
UserVersion if not empty. Otherwise returns the system version
Throws:
CLLException - thrown if fetch fails

setDisplayVersion

void setDisplayVersion(java.lang.String userVersion)
                       throws CLLException
Updates the user version according to the given parameter

Parameters:
userVersion - user specified version
Throws:
CLLException - will be thrown if setting user version fails

getPreviousVersion

CentraSiteRegistryObject getPreviousVersion()
                                            throws CLLException
Retrieves the CentraSiteRegistryObject representing the previous version. If there is none the method returns null.

Returns:
CentraSiteRegistryObject representing version prior to current version
Throws:
CLLException - will be thrown if fetching previous version fails

getPreviousVersions

java.util.List<CentraSiteRegistryObject> getPreviousVersions()
                                                             throws CLLException
Retrieves the List of CentraSiteRegistryObject representing the previous versions. The returned list is sorted by the version number in descending order. This means the newest version is the first in the list. If there is none the method returns an empty list.

Returns:
List of CentraSiteRegistryObjects representing versions prior to current version
Throws:
CLLException - will be thrown if fetching previous versions fails

getNextVersion

CentraSiteRegistryObject getNextVersion()
                                        throws CLLException
Retrieves the CentraSiteRegistryObject representing the next version. If there is none the method returns null.

Returns:
CentraSiteRegistryObject representing version next to current version
Throws:
CLLException - will be thrown if fetching newer version fails

getNextVersions

java.util.List<CentraSiteRegistryObject> getNextVersions()
                                                         throws CLLException
Retrieves the List of CentraSiteRegistryObject representing the next versions. The returned list is sorted by the version number in descending order. This means the newest version is the first in the list. If there is none the method returns an empty list.

Returns:
List of CentraSiteRegistryObjects representing versions next to current version
Throws:
CLLException - will be thrown if fetching newer versions fails

getSystemVersion

java.lang.String getSystemVersion()
                                  throws CLLException
Retrieves the system version of the CentraSiteRegistryObject

Returns:
system version of the CentraSiteRegistryObject
Throws:
CLLException

isLatestVersionObject

boolean isLatestVersionObject()
                              throws CLLException
Checks if current object is the maximum (or only) version object
true: is the maximum (or only) version object
false: its an intermediate version object

Throws:
CLLException

getOwner

User getOwner()
              throws CLLException
Retrieves the owner of the CentraSiteRegistryObject

Returns:
The user who is the owner of the CentraSiteRegistryObject
Throws:
CLLException

setOwner

void setOwner(User user)
              throws CLLException
sets the owner of the CentraSiteRegistryObject

Parameters:
user - The user who has to be set as the owner of the CentraSiteRegistryObject
Throws:
CLLException

getOrganization

Organization getOrganization()
                             throws CLLException
Retrieves the Organization of the CentraSiteRegistryObject

Returns:
The Organization of the CentraSiteRegistryObject
Throws:
CLLException

setOrganization

void setOrganization(Organization organization)
                     throws CLLException
set the Organization of the CentraSiteRegistryObject

Parameters:
organization - The Organization of the CentraSiteRegistryObject
Throws:
CLLException

getVisiblePrimaryProfiles

java.util.List<CSROProfile> getVisiblePrimaryProfiles()
                                                      throws CLLException
get the list of primary Profiles including inherited profiles in case of Virtual Types based on the current user permission

Returns:
the ordered list of primary Profiles based on the current user permission.
Throws:
CLLException

getSubscribers

java.util.Collection<User> getSubscribers()
                                          throws CLLException
gets the users who have subscribed to (or watching) this CentraSiteRegistryObject for notifications

Returns:
the collection of User who are subscribers to this CentraSiteRegistryObject
Throws:
CLLException

getConsumers

java.util.Collection<CentraSiteObject> getConsumers()
                                                    throws CLLException
gets the users who are registered as Consumers for this CentraSiteRegistryObject

Returns:
the collection of User who are consumers to this CentraSiteRegistryObject
Throws:
CLLException

getLCMAssignment

LCMStateAssignment getLCMAssignment()
                                    throws CLLException
Return the lifecycle state information of the CSRO

Returns:
LCMStateAssignment
Throws:
CLLException - in case of failed to get the LCMStateAssignment assigned to CentraSiteRegistryObject.

setLCMState

void setLCMState(LCMState lcmState)
                 throws CLLException
Allowed to set the LCMState to CentraSiteRegistryObject.

Parameters:
lcmState - state of the CentraSiteRegistryObject.
Throws:
CLLException - in case failed to change the current state of CentraSiteRegistryObject,

setLocalName

void setLocalName(java.lang.String localName)
                  throws CLLException
Set Local-Name Classification of this RegistryObject.

Parameters:
localName - value for the Local-Name Classification
Throws:
CLLException

getLocalName

java.lang.String getLocalName()
                              throws CLLException
fetch Local-Name Classification of this RegistryObject.

Returns:
value for the Local-Name Classification
Throws:
CLLException

setNameSpace

void setNameSpace(java.lang.String nameSpace)
                  throws CLLException
Set namespace Classification of this RegistryObject.

Parameters:
nameSpace - value for the NameSpace Classification
Throws:
CLLException

getNameSpace

java.lang.String getNameSpace()
                              throws CLLException
fetch namespace Classification of this RegistryObject.

Returns:
value for the NameSpace Classification
Throws:
CLLException

getMandatoryAttributeProfiles

java.util.List<Profile> getMandatoryAttributeProfiles()
                                                      throws CLLException
Return the list of profiles for the CSRO in which there is atleast one mandatory attribute, ordered by the profile sequence number.

Returns:
the list of profiles for the CSRO
Throws:
CLLException

getRegistryObject

java.lang.Object getRegistryObject()
                                   throws CLLException
Throws:
CLLException