com.softwareag.centrasite.policy.api
Interface PolicyRegistryObject

All Known Subinterfaces:
Policy, PolicyActionCategory, PolicyActionInstance, PolicyActionParameter, PolicyActionTemplate, PolicyCondition, PolicyParameter

public interface PolicyRegistryObject

Base class for all Policy related objects


Method Summary
 void addAssociation(javax.xml.registry.infomodel.Association association)
          adds the given association to the underlying JAXR object
 void addAssociation(javax.xml.registry.infomodel.RegistryObject targetObject, java.lang.String associationTypeId)
          creates and adds(if not present already) an association from this object to the target object with the given association type
 java.util.Collection<javax.xml.registry.infomodel.Concept> getAllClassifiedConcepts(java.lang.String classificationSchemeId)
          returns all the concepts under which the underlying JAXR object is classified under the specified classification scheme
 java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getAllJAXRObjects()
          Returns the Collection of ROs which are part of this Policy object including itself
 java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getAllObsoleteObjects()
           
 java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteAssociation> getAssociations()
          return the Associations of the underlying JAXR object
 java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteAssociation> getAssociations(java.lang.String associationTypeId)
          returns all the associations of the underlying JAXR object made to the specified association type
 java.util.Collection<javax.xml.registry.infomodel.Classification> getClassifications()
          return the classifications of the underlying JAXR object
 com.centrasite.jaxr.infomodel.CentraSiteConcept getClassifiedConcept(java.lang.String classificationSchemeId)
          return the concept under which the underlying JAXR object is classified under the specified classification scheme Should there be more than one classifications to some concepts under the specified taxonomy, the first such classification's concept will be returned
 com.centrasite.jaxr.infomodel.CentraSiteInternationalString getDescription()
          returns description of the underlying JAXR object
 com.centrasite.jaxr.infomodel.CentraSiteRegistryObject getJAXRObject()
          returns the underlying JAXR object
 com.centrasite.jaxr.CentraSiteRegistryService getJAXRRegistryService()
          CentraSiteRegistryService which was used to create this Policy object
 javax.xml.registry.infomodel.Key getKey()
          return the Key of the underlying JAXR object
 java.util.Locale getLoggedInUserLocale()
          get the locale of the loggedin user
 com.centrasite.jaxr.infomodel.CentraSiteInternationalString getName()
          returns name of the underlying JAXR object
 void removeAllAssociations(java.lang.String associationTypeId)
          Removes all the associations of the underlying JAXR object made to the specified association type
 void removeAllClassifications(java.lang.String classificationSchemeId)
          Removes all the classifications of the underlying JAXR object made to the specified classification scheme
 void setDescription(com.centrasite.jaxr.infomodel.CentraSiteInternationalString description)
          sets the description of the underlying JAXR object
 void setName(com.centrasite.jaxr.infomodel.CentraSiteInternationalString name)
          sets the name of the underlying JAXR object
 java.lang.String toXMLForRepair()
           
 

Method Detail

getName

com.centrasite.jaxr.infomodel.CentraSiteInternationalString getName()
                                                                    throws javax.xml.registry.JAXRException
returns name of the underlying JAXR object

Returns:
Name of the Policy Object
Throws:
javax.xml.registry.JAXRException

setName

void setName(com.centrasite.jaxr.infomodel.CentraSiteInternationalString name)
             throws javax.xml.registry.JAXRException
sets the name of the underlying JAXR object

Parameters:
name - for the policy object
Throws:
javax.xml.registry.JAXRException

getDescription

com.centrasite.jaxr.infomodel.CentraSiteInternationalString getDescription()
                                                                           throws javax.xml.registry.JAXRException
returns description of the underlying JAXR object

Returns:
description of the Policy Object
Throws:
javax.xml.registry.JAXRException

setDescription

void setDescription(com.centrasite.jaxr.infomodel.CentraSiteInternationalString description)
                    throws javax.xml.registry.JAXRException
sets the description of the underlying JAXR object

Parameters:
description - for the policy object
Throws:
javax.xml.registry.JAXRException

getJAXRObject

com.centrasite.jaxr.infomodel.CentraSiteRegistryObject getJAXRObject()
returns the underlying JAXR object

Returns:
JAXR object which represents this Policy Object

getJAXRRegistryService

com.centrasite.jaxr.CentraSiteRegistryService getJAXRRegistryService()
CentraSiteRegistryService which was used to create this Policy object

Returns:
CentraSiteRegistryService

getLoggedInUserLocale

java.util.Locale getLoggedInUserLocale()
get the locale of the loggedin user

Returns:
locale of the user

getKey

javax.xml.registry.infomodel.Key getKey()
                                        throws javax.xml.registry.JAXRException
return the Key of the underlying JAXR object

Returns:
Key of the underlying JAXR object
Throws:
javax.xml.registry.JAXRException

getClassifications

java.util.Collection<javax.xml.registry.infomodel.Classification> getClassifications()
                                                                                     throws javax.xml.registry.JAXRException
return the classifications of the underlying JAXR object

Returns:
classifications of the underlying JAXR object
Throws:
javax.xml.registry.JAXRException

getAssociations

java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteAssociation> getAssociations()
                                                                                          throws javax.xml.registry.JAXRException
return the Associations of the underlying JAXR object

Returns:
Associations of the underlying JAXR object
Throws:
javax.xml.registry.JAXRException

getClassifiedConcept

com.centrasite.jaxr.infomodel.CentraSiteConcept getClassifiedConcept(java.lang.String classificationSchemeId)
                                                                     throws javax.xml.registry.JAXRException
return the concept under which the underlying JAXR object is classified under the specified classification scheme Should there be more than one classifications to some concepts under the specified taxonomy, the first such classification's concept will be returned

Parameters:
classificationSchemeId - Id of the Classification scheme.
Returns:
concept under the classification scheme using which the Policy object is classified
Throws:
javax.xml.registry.JAXRException

getAllClassifiedConcepts

java.util.Collection<javax.xml.registry.infomodel.Concept> getAllClassifiedConcepts(java.lang.String classificationSchemeId)
                                                                                    throws javax.xml.registry.JAXRException
returns all the concepts under which the underlying JAXR object is classified under the specified classification scheme

Parameters:
classificationSchemeId - Id of the Classification scheme.
Returns:
concepts under the classification scheme using which the Policy object is classified
Throws:
javax.xml.registry.JAXRException

removeAllAssociations

void removeAllAssociations(java.lang.String associationTypeId)
                           throws javax.xml.registry.JAXRException
Removes all the associations of the underlying JAXR object made to the specified association type

Parameters:
associationTypeId - Id of the association type
Throws:
javax.xml.registry.JAXRException

removeAllClassifications

void removeAllClassifications(java.lang.String classificationSchemeId)
                              throws javax.xml.registry.JAXRException
Removes all the classifications of the underlying JAXR object made to the specified classification scheme

Parameters:
classificationSchemeId - Id of the Classification scheme.
Throws:
javax.xml.registry.JAXRException

addAssociation

void addAssociation(javax.xml.registry.infomodel.Association association)
                    throws javax.xml.registry.JAXRException
adds the given association to the underlying JAXR object

Parameters:
association - association to be added
Throws:
javax.xml.registry.JAXRException

addAssociation

void addAssociation(javax.xml.registry.infomodel.RegistryObject targetObject,
                    java.lang.String associationTypeId)
                    throws javax.xml.registry.JAXRException
creates and adds(if not present already) an association from this object to the target object with the given association type

Parameters:
targetObject - the target object of the association
associationTypeId - Id of the association type
Throws:
javax.xml.registry.JAXRException

getAssociations

java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteAssociation> getAssociations(java.lang.String associationTypeId)
                                                                                          throws javax.xml.registry.JAXRException
returns all the associations of the underlying JAXR object made to the specified association type

Parameters:
associationTypeId - Id of the association type
Returns:
Collection of associations made to the specified association type
Throws:
javax.xml.registry.JAXRException

getAllJAXRObjects

java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getAllJAXRObjects()
                                                                                               throws javax.xml.registry.JAXRException,
                                                                                                      PolicyException
Returns the Collection of ROs which are part of this Policy object including itself

Returns:
Collection of ROs
Throws:
javax.xml.registry.JAXRException
PolicyException

getAllObsoleteObjects

java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getAllObsoleteObjects()
                                                                                                   throws javax.xml.registry.JAXRException,
                                                                                                          PolicyException
Throws:
javax.xml.registry.JAXRException
PolicyException

toXMLForRepair

java.lang.String toXMLForRepair()
                                throws javax.xml.registry.JAXRException,
                                       PolicyException
Throws:
javax.xml.registry.JAXRException
PolicyException