public interface PolicyActionTemplate extends PolicyRegistryObject
Modifier and Type | Method and Description |
---|---|
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)
Adds 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)
Adds 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()
Gets 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()
Gets the action type of this template.
|
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getApplicableEventTypes()
Gets the collection of event types upon which the policy action template can be applied.
|
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getApplicableObjectTypes()
Gets the collection of object types upon which the policy action template can be applied.
|
javax.xml.registry.infomodel.Concept |
getExecutionType()
Gets the execution type for the action template.
|
javax.xml.registry.infomodel.ExtrinsicObject |
getRule()
Returns the extrinsic object containing the implementation of the policy action.
|
boolean |
isHidden()
Returns whether this action template is hidden.
|
boolean |
isSystem()
Returns whether this action template is system defined.
|
boolean |
isUserDefined()
Returns whether this action template is user defined.
|
void |
removeActionParameter(PolicyActionParameter actionParameter)
Removes 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)
Removes 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)
Sets the execution type for the action template.
|
void |
setHidden()
Classifies this action template as Hidden.
|
void |
setRule(javax.xml.registry.infomodel.ExtrinsicObject rule)
Sets the given Extrinsic Object as the Rule for this Action Template.
|
void |
setSystem()
Classifies this action template as system defined.
|
void |
setUserDefined()
Classifies this action template as user defined.
|
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRObject, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair
javax.xml.registry.infomodel.ExtrinsicObject getRule() throws javax.xml.registry.JAXRException
ExtrinsicObject
which specifies the rulejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the rulevoid setRule(javax.xml.registry.infomodel.ExtrinsicObject rule) throws javax.xml.registry.JAXRException, PolicyException
rule
- extrinsic object to be used as the rulejavax.xml.registry.JAXRException
- if an internal error occurs on updating the rulePolicyException
- if an internal error occursPolicyActionParameter getActionParameter(java.lang.String name) throws javax.xml.registry.JAXRException, PolicyException
name
- the name of the Action Parameterjavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the action parameterPolicyException
- if an internal error occursjava.util.List<PolicyActionParameter> getActionParameters() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the action parametersPolicyException
- if an internal error occursvoid addActionParameter(PolicyActionParameter actionParameter) throws javax.xml.registry.JAXRException
actionParameter
- the action parameter to addjavax.xml.registry.JAXRException
- if an internal error occurs while adding the action parametervoid addActionParameters(java.util.List<PolicyActionParameter> actionParameters) throws javax.xml.registry.JAXRException
actionParameters
- list of PolicyActionParameter
to addjavax.xml.registry.JAXRException
- if an internal error occurs while adding the action parametersvoid setActionParameters(java.util.List<PolicyActionParameter> actionParameters) throws javax.xml.registry.JAXRException
actionParameters
- list of PolicyActionParameter
to setjavax.xml.registry.JAXRException
- if an internal error occurs on updating the action parametersvoid removeActionParameter(PolicyActionParameter actionParameter) throws javax.xml.registry.JAXRException
actionParameter
- the action parameter to removejavax.xml.registry.JAXRException
- if an internal error occurs on removing the action parametervoid removeActionParameters(java.util.List<PolicyActionParameter> actionParameters) throws javax.xml.registry.JAXRException
actionParameters
- list of PolicyActionParameter
to removejavax.xml.registry.JAXRException
- if an internal error occurs on removing the action parametersvoid removeActionParameter(java.lang.String actionParameterId) throws javax.xml.registry.JAXRException, PolicyException
actionParameterId
- the ID of the action parameter to removejavax.xml.registry.JAXRException
- if an internal error occurs on removing the action parameterPolicyException
- if an internal error occursjava.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableEventTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving applicable event typesvoid setApplicableEventTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> eventTypeConcepts) throws javax.xml.registry.JAXRException, PolicyException
eventTypeConcepts
- the collection of event types to be setjavax.xml.registry.JAXRException
- if an internal error occurs on updating applicable event typesPolicyException
- if an internal error occursvoid addApplicableEventType(javax.xml.registry.infomodel.Concept eventTypeConcept) throws javax.xml.registry.JAXRException, PolicyException
eventTypeConcept
- the event type to be addedjavax.xml.registry.JAXRException
- if an internal error occurs on adding the applicable event typePolicyException
- if an internal error occursjava.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableObjectTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the applicable event typevoid setApplicableObjectTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypeConcepts) throws javax.xml.registry.JAXRException, PolicyException
objectTypeConcepts
- object types to be setjavax.xml.registry.JAXRException
- if an internal error occurs on updating the applicable event typesPolicyException
- if an internal error occursvoid addApplicableObjectType(javax.xml.registry.infomodel.Concept objectTypeConcept) throws javax.xml.registry.JAXRException, PolicyException
objectTypeConcept
- object type to be addedjavax.xml.registry.JAXRException
- if an internal error occurs on adding the applicable object typePolicyException
- if an internal error occursboolean isSystem() throws javax.xml.registry.JAXRException
true
if this action template is system defined, false
otherwisejavax.xml.registry.JAXRException
- if an internal error occursboolean isHidden() throws javax.xml.registry.JAXRException
true
if this action template is hidden, false
otherwisejavax.xml.registry.JAXRException
- if an internal error occursboolean isUserDefined() throws javax.xml.registry.JAXRException
true
if this action template is user defined, false
otherwisejavax.xml.registry.JAXRException
- if an internal error occursvoid setSystem() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid setHidden() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid setUserDefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid setExecutionType(javax.xml.registry.infomodel.Concept executionType) throws PolicyException, javax.xml.registry.JAXRException
executionType
- execution type to be setPolicyException
- if an internal error occursjavax.xml.registry.JAXRException
- if an internal error occurs on updating the execution typejavax.xml.registry.infomodel.Concept getExecutionType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the execution typePolicyActionCategory getActionCategory() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the action categoryPolicyException
- if an internal error occursAssertionType getActionType() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the action typePolicyException
- if an internal error occurs