com.softwareag.centrasite.api.csom
Interface CentraSiteObject

All Known Subinterfaces:
Category, CentraSiteFile, CentraSiteObjectType, CentraSiteRegistryObject, CentraSiteRegistryObjectType, CentraSiteRepositoryFile, CentraSiteRepositoryFolder, CentraSiteRepositoryObject, ComputedProfile, CSOLink, CSROProfile, ExternalObject, LCM, LCMState, Organization, Profile, Service, Taxonomy, User, XMLSchema

public interface CentraSiteObject

CentraSiteObject is the base class for the CentraSiteObjectModel.
It represents all the kind of CentraSite objects like registry and repository objects.


Method Summary
 void delete()
          Used to delete the CentraSiteObject being used from the underlying registry.
 CSOLink getAttributeLink(CentraSiteObjectAttribute attribute)
          Get the link associated with the attribute
 java.util.Collection<java.lang.Object> getAttributeValue(CentraSiteObjectAttribute attribute)
          Get the attribute value for the given attribute
 java.util.Collection<java.lang.Object> getAttributeValue(javax.xml.namespace.QName name)
          Get the value for the attribute identified by the given QName(Qualified Name)
 java.util.Collection<java.lang.Object> getAttributeValue(java.lang.String name)
          Get the value for the attribute identified by the given name
 java.lang.String getId()
          Get the Unique Identifier for the object.
 CentraSiteObjectType getType()
          Get the type of the CentraSiteObject instance.
 boolean isModified()
          Indicates whether current object being used have modifications compare to the same persisted instance.
 boolean isReadOnly()
          Indicates whether current object being used is write protected or not for the caller.
 void save()
          Used to persist the CentraSiteObject to the underlying registry.
 void setAttributeValue(CentraSiteObjectAttribute attribute, java.util.Collection<java.lang.Object> values)
          Set the attribute value for the given attribute.
 void setAttributeValue(javax.xml.namespace.QName name, java.util.Collection<java.lang.Object> values)
          Set the value for the attribute identified by the given QName(Qualified Name).
 void setAttributeValue(java.lang.String name, java.util.Collection<java.lang.Object> values)
          Set the value for the attribute identified by the given name.
 

Method Detail

getId

java.lang.String getId()
                       throws CLLException
Get the Unique Identifier for the object.

Returns:
Unique identifier for the object.
Throws:
CLLException

getType

CentraSiteObjectType getType()
                             throws CLLException
Get the type of the CentraSiteObject instance.

Returns:
CentraSiteObjectType which represent of the type of the object.
Throws:
CLLException

getAttributeValue

java.util.Collection<java.lang.Object> getAttributeValue(java.lang.String name)
                                                         throws CLLException
Get the value for the attribute identified by the given name

Parameters:
name - The name of the attribute.
Returns:
Collection of values associated with the given name
Throws:
CLLException

setAttributeValue

void setAttributeValue(java.lang.String name,
                       java.util.Collection<java.lang.Object> values)
                       throws CLLException
Set the value for the attribute identified by the given name.

Parameters:
name - The name of the attribute.
values - the Collection of values needed to be associated with the attribute
Throws:
CLLException

getAttributeValue

java.util.Collection<java.lang.Object> getAttributeValue(javax.xml.namespace.QName name)
                                                         throws CLLException
Get the value for the attribute identified by the given QName(Qualified Name)

Parameters:
name - The qualified name of the attribute.
Returns:
Collection of values associated with the given name
Throws:
CLLException

setAttributeValue

void setAttributeValue(javax.xml.namespace.QName name,
                       java.util.Collection<java.lang.Object> values)
                       throws CLLException
Set the value for the attribute identified by the given QName(Qualified Name).

Parameters:
name - qualified name of the attribute.
values - the Collection of values needed to be associated with the attribute
Throws:
CLLException

getAttributeValue

java.util.Collection<java.lang.Object> getAttributeValue(CentraSiteObjectAttribute attribute)
                                                         throws CLLException
Get the attribute value for the given attribute

Parameters:
attribute - The instance of the attribute model.
Returns:
Collection of values associated with the given name
Throws:
CLLException

setAttributeValue

void setAttributeValue(CentraSiteObjectAttribute attribute,
                       java.util.Collection<java.lang.Object> values)
                       throws CLLException
Set the attribute value for the given attribute.
ClassificationAttribute:
If the corresponding taxonomy is internal then the value is a collection of concepts. If the taxonomy is external, then the value is a collection of strings. Any existing value will be replaced. In order to delete the attribute value supply an empty value, or null.
FileAttribute:
The value is a collection of URI strings. Any existing value will be replaced. In order to delete the attribute value supply an empty value, or null.
RelationshipAttribute:
The value is a collection of target objects. Any existing value will be replaced. In order to delete the attribute value supply an empty value, or null.

Parameters:
attribute - The instance of the attribute model.
values - the Collection of values needed to be associated with the attribute
Throws:
CLLException

save

void save()
          throws CLLException
Used to persist the CentraSiteObject to the underlying registry.

Throws:
CLLException

delete

void delete()
            throws CLLException
Used to delete the CentraSiteObject being used from the underlying registry.

Throws:
CLLException

isReadOnly

boolean isReadOnly()
Indicates whether current object being used is write protected or not for the caller.

Returns:
true - in case of the caller having only read only permission on the CentraSiteObject

isModified

boolean isModified()
                   throws CLLException
Indicates whether current object being used have modifications compare to the same persisted instance.

Returns:
true - in case of this object is modified compared to the persisted object instance.
Throws:
CLLException

getAttributeLink

CSOLink getAttributeLink(CentraSiteObjectAttribute attribute)
                         throws CLLException
Get the link associated with the attribute

Parameters:
attribute - The qualified name of the attribute.
Returns:
CSOLink representing the link for the attribute
Throws:
CLLException