com.softwareag.centrasite.api.csom.type
Interface CentraSiteObjectTypeManager


public interface CentraSiteObjectTypeManager

CentraSiteObjectTypeManager used to populate the CentraObjectType based on the different criteria.

  1. the CentraObjectType instance can be retrieved based on the name
  2. the CentraObjectType instance can be retrieved based on the QName
  3. the CentraObjectType instance can be retrieved based on the display name.
 CentraSiteObjectTypeManager instantiated by the CentraSiteObjectFactory, the following is the sample code which will give you the reference to CentraSiteObjectManager.
 CentraSiteObjectFactory centraSiteObjectFactory = CentraSiteObjectFactory.getInstance(CentraSiteConnection);
 CentraSiteObjectTypeManager centraSiteObjectTypeManager = centraSiteObjectFactory.getCentraSiteObjectTypeManager();
 


Method Summary
 java.util.List<CentraSiteObjectAttribute> getAllCommonAttributes()
          Returns all the Common Attributes.
 CentraSiteObjectType getType(javax.xml.namespace.QName name)
          populate the CentraSiteObjectType persisted using the given primary key.
 CentraSiteObjectType getType(java.lang.String name)
          populate the CentraSiteRegistryObjectType , if the concept is exists with the given name.
 CentraSiteObjectType getTypeByDisplayName(java.lang.String name)
          create the CentraSiteObjectType for the given name.
 java.util.Collection<CentraSiteObjectType> getTypes(java.lang.String keyword)
          fetches the collection of types that are containing the given keyword
 

Method Detail

getType

CentraSiteObjectType getType(java.lang.String name)
                             throws CLLException
populate the CentraSiteRegistryObjectType , if the concept is exists with the given name.


if concept is not exists with the given name then returns the null.

Parameters:
name - identifier which used to identify the CentraSiteObjectType.
Returns:
CentraSiteObjectType which wraps Concept.
Throws:
CLLException - thrown in case of failed to populate the CentraSiteObjectType for the given identifier.

getType

CentraSiteObjectType getType(javax.xml.namespace.QName name)
                             throws CLLException
populate the CentraSiteObjectType persisted using the given primary key.

Parameters:
name - identifier which used to identify the registry object.
Returns:
CentraSiteObjectType which represent the type of the Registry Object & holds the information related to that specific type
Throws:
com.softwareag.centrasite.common.exception.CLLException - thrown in case of failed to populate the CentraSiteRegistryObject for the given identifier.
CLLException

getTypes

java.util.Collection<CentraSiteObjectType> getTypes(java.lang.String keyword)
                                                    throws CLLException
fetches the collection of types that are containing the given keyword

Parameters:
keyword - string for which the search is being performed
Returns:
Collection of types where type name contains the given keyword
Throws:
CLLException

getTypeByDisplayName

CentraSiteObjectType getTypeByDisplayName(java.lang.String name)
                                          throws CLLException
create the CentraSiteObjectType for the given name.

Parameters:
name - type representation for CentraSiteObject
Returns:
CentraSiteObjectType which represent the type of the Registry Object & holds the information related to that specific type
Throws:
CLLException - thrown in case of failed to populate the CentraSiteObject for the given type.

getAllCommonAttributes

java.util.List<CentraSiteObjectAttribute> getAllCommonAttributes()
                                                                 throws CLLException
Returns all the Common Attributes.

Returns:
A List of Common Attributes.
Throws:
CLLException - thrown in case the attribute retrieval fails.