com.softwareag.centrasite.policy.api
Interface PolicyActionTemplate

All Superinterfaces:
PolicyRegistryObject

public interface PolicyActionTemplate
extends PolicyRegistryObject

Models the Policy Action


Method Summary
 void addActionParameter(PolicyActionParameter actionParameter)
          Adds the given Action Parameter to this Action Template
 void addActionParameters(java.util.List<PolicyActionParameter> actionParameters)
          Adds the given list of Action Parameters to this Action Template
 void addApplicableEventType(javax.xml.registry.infomodel.Concept eventTypeConcept)
          Add the given event type(if not present already) to the collection of event types upon which the policy action template can be applied
 void addApplicableObjectType(javax.xml.registry.infomodel.Concept objectTypeConcept)
          Add the given object type(if not present already) to the collection of object types upon which the policy action template can be applied
 PolicyActionCategory getActionCategory()
          Get the policy action category to which this action template belongs
 PolicyActionParameter getActionParameter(java.lang.String name)
          Returns the Policy Action Parameter under this Action Template with the given name if present
 java.util.List<PolicyActionParameter> getActionParameters()
          Returns the list of Policy Action Parameters for this Action Template
 AssertionType getActionType()
          Get the action type of this template
 java.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableEventTypes()
          Get the collection of event types upon which the policy action template can be applied
 java.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableObjectTypes()
          Get the collection of object types upon which the policy action template can be applied
 javax.xml.registry.infomodel.Concept getExecutionType()
          Get the execution type for the action template.
 javax.xml.registry.infomodel.ExtrinsicObject getRule()
          Will return the extrinsic object containing the implementation of the policy action Will be applicable only for Programmatic Actions Will be null for Axiomatic Actions
 boolean isHidden()
          Return if this action template is hidden
 boolean isSystem()
          Return if this action template is System defined
 boolean isUserDefined()
          Return if this action template is user defined
 void removeActionParameter(PolicyActionParameter actionParameter)
          Remove the given action parameter from the list of actionParameters of this Action Template
 void removeActionParameter(java.lang.String actionParameterId)
          Removes the action parameter with the given id from the list of actionParameters for this Action Template
 void removeActionParameters(java.util.List<PolicyActionParameter> actionParameters)
          Remove the given list of action parameters from the list of actionParameters for this Action Template
 void setActionParameters(java.util.List<PolicyActionParameter> actionParameters)
          Sets the given list of Action Parameters to this Action Template Old action parameters will be lost
 void setApplicableEventTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> eventTypeConcepts)
          Sets the collection of event types upon which the policy action template can be applied
 void setApplicableObjectTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypeConcepts)
          Sets the collection of object types upon which the policy action template can be applied
 void setExecutionType(javax.xml.registry.infomodel.Concept executionType)
          Set the execution type for the action template.
 void setHidden()
          Classify this action template as Hidden
 void setRule(javax.xml.registry.infomodel.ExtrinsicObject rule)
          Set the given Extrinsic Object as the Rule for this Action Template
 void setSystem()
          Classify this action template as System defined
 void setUserDefined()
          Classify this action template as User defined
 
Methods inherited from interface com.softwareag.centrasite.policy.api.PolicyRegistryObject
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRObject, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair
 

Method Detail

getRule

javax.xml.registry.infomodel.ExtrinsicObject getRule()
                                                     throws javax.xml.registry.JAXRException
Will return the extrinsic object containing the implementation of the policy action Will be applicable only for Programmatic Actions Will be null for Axiomatic Actions

Returns:
ExtrinsicObject which specifies the rule
Throws:
javax.xml.registry.JAXRException

setRule

void setRule(javax.xml.registry.infomodel.ExtrinsicObject rule)
             throws javax.xml.registry.JAXRException,
                    PolicyException
Set the given Extrinsic Object as the Rule for this Action Template

Parameters:
rule - extrinsic object to be used as the rule
Throws:
javax.xml.registry.JAXRException
PolicyException

getActionParameter

PolicyActionParameter getActionParameter(java.lang.String name)
                                         throws javax.xml.registry.JAXRException,
                                                PolicyException
Returns the Policy Action Parameter under this Action Template with the given name if present

Parameters:
name - of the Action Parameter
Returns:
Policy Action Parameter with the given name
Throws:
javax.xml.registry.JAXRException
PolicyException

getActionParameters

java.util.List<PolicyActionParameter> getActionParameters()
                                                          throws javax.xml.registry.JAXRException,
                                                                 PolicyException
Returns the list of Policy Action Parameters for this Action Template

Returns:
List of Policy Action Parameters
Throws:
javax.xml.registry.JAXRException
PolicyException

addActionParameter

void addActionParameter(PolicyActionParameter actionParameter)
                        throws javax.xml.registry.JAXRException
Adds the given Action Parameter to this Action Template

Parameters:
actionParameter - action parameter to add
Throws:
javax.xml.registry.JAXRException

addActionParameters

void addActionParameters(java.util.List<PolicyActionParameter> actionParameters)
                         throws javax.xml.registry.JAXRException
Adds the given list of Action Parameters to this Action Template

Parameters:
actionParameters - list of action parameters to add
Throws:
javax.xml.registry.JAXRException

setActionParameters

void setActionParameters(java.util.List<PolicyActionParameter> actionParameters)
                         throws javax.xml.registry.JAXRException
Sets the given list of Action Parameters to this Action Template Old action parameters will be lost

Parameters:
actionParameters - list of action parameters to set
Throws:
javax.xml.registry.JAXRException

removeActionParameter

void removeActionParameter(PolicyActionParameter actionParameter)
                           throws javax.xml.registry.JAXRException
Remove the given action parameter from the list of actionParameters of this Action Template

Parameters:
actionParameter - action parameter to remove
Throws:
javax.xml.registry.JAXRException

removeActionParameters

void removeActionParameters(java.util.List<PolicyActionParameter> actionParameters)
                            throws javax.xml.registry.JAXRException
Remove the given list of action parameters from the list of actionParameters for this Action Template

Parameters:
actionParameters - list of action parameters to remove
Throws:
javax.xml.registry.JAXRException

removeActionParameter

void removeActionParameter(java.lang.String actionParameterId)
                           throws javax.xml.registry.JAXRException,
                                  PolicyException
Removes the action parameter with the given id from the list of actionParameters for this Action Template

Parameters:
actionParameterId - id of action parameter to remove
Throws:
javax.xml.registry.JAXRException
PolicyException

getApplicableEventTypes

java.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableEventTypes()
                                                                                   throws javax.xml.registry.JAXRException
Get the collection of event types upon which the policy action template can be applied

Returns:
collection of event types upon which the policy action template can be applied
Throws:
javax.xml.registry.JAXRException

setApplicableEventTypes

void setApplicableEventTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> eventTypeConcepts)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Sets the collection of event types upon which the policy action template can be applied

Parameters:
eventTypeConcepts - event types to be set
Throws:
javax.xml.registry.JAXRException
PolicyException

addApplicableEventType

void addApplicableEventType(javax.xml.registry.infomodel.Concept eventTypeConcept)
                            throws javax.xml.registry.JAXRException,
                                   PolicyException
Add the given event type(if not present already) to the collection of event types upon which the policy action template can be applied

Parameters:
eventTypeConcept - event type to be added
Throws:
javax.xml.registry.JAXRException
PolicyException

getApplicableObjectTypes

java.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableObjectTypes()
                                                                                    throws javax.xml.registry.JAXRException
Get the collection of object types upon which the policy action template can be applied

Returns:
collection of object types upon which the policy action template can be applied
Throws:
javax.xml.registry.JAXRException

setApplicableObjectTypes

void setApplicableObjectTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypeConcepts)
                              throws javax.xml.registry.JAXRException,
                                     PolicyException
Sets the collection of object types upon which the policy action template can be applied

Parameters:
objectTypeConcepts - object types to be set
Throws:
javax.xml.registry.JAXRException
PolicyException

addApplicableObjectType

void addApplicableObjectType(javax.xml.registry.infomodel.Concept objectTypeConcept)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Add the given object type(if not present already) to the collection of object types upon which the policy action template can be applied

Parameters:
objectTypeConcept - object type to be added
Throws:
javax.xml.registry.JAXRException
PolicyException

isSystem

boolean isSystem()
                 throws javax.xml.registry.JAXRException
Return if this action template is System defined

Returns:
true if this action template is system defined, false otherwise
Throws:
javax.xml.registry.JAXRException

isHidden

boolean isHidden()
                 throws javax.xml.registry.JAXRException
Return if this action template is hidden

Returns:
true if this action template is hidden, false otherwise
Throws:
javax.xml.registry.JAXRException

isUserDefined

boolean isUserDefined()
                      throws javax.xml.registry.JAXRException
Return if this action template is user defined

Returns:
true if this action template is user defined, false otherwise
Throws:
javax.xml.registry.JAXRException

setSystem

void setSystem()
               throws javax.xml.registry.JAXRException
Classify this action template as System defined

Throws:
javax.xml.registry.JAXRException

setHidden

void setHidden()
               throws javax.xml.registry.JAXRException
Classify this action template as Hidden

Throws:
javax.xml.registry.JAXRException

setUserDefined

void setUserDefined()
                    throws javax.xml.registry.JAXRException
Classify this action template as User defined

Throws:
javax.xml.registry.JAXRException

setExecutionType

void setExecutionType(javax.xml.registry.infomodel.Concept executionType)
                      throws PolicyException,
                             javax.xml.registry.JAXRException
Set the execution type for the action template.

Parameters:
executionType - execution type to be set
Throws:
PolicyException
javax.xml.registry.JAXRException

getExecutionType

javax.xml.registry.infomodel.Concept getExecutionType()
                                                      throws javax.xml.registry.JAXRException
Get the execution type for the action template. The action template could be executed as Java, Groovy

Returns:
execution type for the action template
Throws:
javax.xml.registry.JAXRException

getActionCategory

PolicyActionCategory getActionCategory()
                                       throws javax.xml.registry.JAXRException,
                                              PolicyException
Get the policy action category to which this action template belongs

Returns:
policy action category to which this action template belongs
Throws:
javax.xml.registry.JAXRException
PolicyException

getActionType

AssertionType getActionType()
                            throws javax.xml.registry.JAXRException,
                                   PolicyException
Get the action type of this template

Returns:
Assertion Type of this template
Throws:
javax.xml.registry.JAXRException
PolicyException