com.softwareag.centrasite.policy.api
Interface PolicyActionInstance

All Superinterfaces:
PolicyRegistryObject

public interface PolicyActionInstance
extends PolicyRegistryObject

Represents the instance of a PolicyActionTemplate for a particular Policy It is modeled as an association of type Uses from the Policy(source object) to the PolicyAction(target object)


Method Summary
 void addParameter(PolicyParameter parameter)
          Add the given parameter to the action instance
 void addParameters(java.util.List<PolicyParameter> parameters)
          Add the given list of parameters to the action instance
 PolicyActionTemplate getActionTemplate()
          The Policy Action for which this action instance was created Target object of the association
 AssertionType getActionType()
          returns the assertion type of the associated policy action
 com.centrasite.jaxr.infomodel.CentraSiteAssociation getJAXRObject()
          Returns the JAXR association object for this action instance
 PolicyParameter getParameter(java.lang.String parameterName)
          Get the parameter(if any) which has the given name
 java.util.List<PolicyParameter> getParameters()
          Get the list of parameters for this action instance
 java.util.List<PolicyParameter> getParameters(java.lang.String parameterName)
          Get the list of parameters which have the given name
 Policy getPolicy()
          Gets the Policy for which this action instance was created Source object of the association
 void removeParameter(PolicyParameter parameter)
          remove the given parameter from the list of parameters for the action instance
 void removeParameters(java.util.List<PolicyParameter> parameters)
          remove the given list of parameters from the list of parameters for the action instance
 boolean validate()
          Validate whether all the mandatory parameter(s) have required values
 
Methods inherited from interface com.softwareag.centrasite.policy.api.PolicyRegistryObject
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair
 

Method Detail

getJAXRObject

com.centrasite.jaxr.infomodel.CentraSiteAssociation getJAXRObject()
Returns the JAXR association object for this action instance

Specified by:
getJAXRObject in interface PolicyRegistryObject
Returns:
JAXR object which represents this Policy Object

addParameter

void addParameter(PolicyParameter parameter)
                  throws javax.xml.registry.JAXRException
Add the given parameter to the action instance

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

addParameters

void addParameters(java.util.List<PolicyParameter> parameters)
Add the given list of parameters to the action instance

Parameters:
parameters - parameters to be added

getParameters

java.util.List<PolicyParameter> getParameters()
                                              throws javax.xml.registry.JAXRException,
                                                     PolicyException
Get the list of parameters for this action instance

Throws:
javax.xml.registry.JAXRException
PolicyException

getParameters

java.util.List<PolicyParameter> getParameters(java.lang.String parameterName)
                                              throws javax.xml.registry.JAXRException,
                                                     PolicyException
Get the list of parameters which have the given name

Parameters:
parameterName -
Returns:
list of parameters which have the given name
Throws:
javax.xml.registry.JAXRException
PolicyException

getParameter

PolicyParameter getParameter(java.lang.String parameterName)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Get the parameter(if any) which has the given name

Parameters:
parameterName -
Returns:
the parameter(if any) which has the given name
Throws:
javax.xml.registry.JAXRException
PolicyException

removeParameter

void removeParameter(PolicyParameter parameter)
remove the given parameter from the list of parameters for the action instance

Parameters:
parameter - to be removed

removeParameters

void removeParameters(java.util.List<PolicyParameter> parameters)
remove the given list of parameters from the list of parameters for the action instance

Parameters:
parameters - list of paramters to remove

getActionTemplate

PolicyActionTemplate getActionTemplate()
                                       throws javax.xml.registry.JAXRException
The Policy Action for which this action instance was created Target object of the association

Returns:
Policy Action for which this action instance was created
Throws:
javax.xml.registry.JAXRException

getActionType

AssertionType getActionType()
                            throws javax.xml.registry.JAXRException,
                                   PolicyException
returns the assertion type of the associated policy action

Returns:
assertion type of the associated policy action
Throws:
javax.xml.registry.JAXRException
PolicyException

getPolicy

Policy getPolicy()
                 throws PolicyException,
                        javax.xml.registry.JAXRException
Gets the Policy for which this action instance was created Source object of the association

Returns:
Policy for which this action instance was created
Throws:
PolicyException
javax.xml.registry.JAXRException

validate

boolean validate()
                 throws PolicyException,
                        javax.xml.registry.JAXRException
Validate whether all the mandatory parameter(s) have required values

Returns:
true if all the mandatory parameter(s) have required values
Throws:
PolicyException - if any of the mandatory parameter(s) doesnot have values set
javax.xml.registry.JAXRException