|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PolicyActionTemplate
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 |
---|
javax.xml.registry.infomodel.ExtrinsicObject getRule() throws javax.xml.registry.JAXRException
ExtrinsicObject
which specifies the rule
javax.xml.registry.JAXRException
void setRule(javax.xml.registry.infomodel.ExtrinsicObject rule) throws javax.xml.registry.JAXRException, PolicyException
rule
- extrinsic object to be used as the rule
javax.xml.registry.JAXRException
PolicyException
PolicyActionParameter getActionParameter(java.lang.String name) throws javax.xml.registry.JAXRException, PolicyException
name
- of the Action Parameter
javax.xml.registry.JAXRException
PolicyException
java.util.List<PolicyActionParameter> getActionParameters() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
void addActionParameter(PolicyActionParameter actionParameter) throws javax.xml.registry.JAXRException
actionParameter
- action parameter to add
javax.xml.registry.JAXRException
void addActionParameters(java.util.List<PolicyActionParameter> actionParameters) throws javax.xml.registry.JAXRException
actionParameters
- list of action parameters to add
javax.xml.registry.JAXRException
void setActionParameters(java.util.List<PolicyActionParameter> actionParameters) throws javax.xml.registry.JAXRException
actionParameters
- list of action parameters to set
javax.xml.registry.JAXRException
void removeActionParameter(PolicyActionParameter actionParameter) throws javax.xml.registry.JAXRException
actionParameter
- action parameter to remove
javax.xml.registry.JAXRException
void removeActionParameters(java.util.List<PolicyActionParameter> actionParameters) throws javax.xml.registry.JAXRException
actionParameters
- list of action parameters to remove
javax.xml.registry.JAXRException
void removeActionParameter(java.lang.String actionParameterId) throws javax.xml.registry.JAXRException, PolicyException
actionParameterId
- id of action parameter to remove
javax.xml.registry.JAXRException
PolicyException
java.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableEventTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setApplicableEventTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> eventTypeConcepts) throws javax.xml.registry.JAXRException, PolicyException
eventTypeConcepts
- event types to be set
javax.xml.registry.JAXRException
PolicyException
void addApplicableEventType(javax.xml.registry.infomodel.Concept eventTypeConcept) throws javax.xml.registry.JAXRException, PolicyException
eventTypeConcept
- event type to be added
javax.xml.registry.JAXRException
PolicyException
java.util.Collection<javax.xml.registry.infomodel.Concept> getApplicableObjectTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setApplicableObjectTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypeConcepts) throws javax.xml.registry.JAXRException, PolicyException
objectTypeConcepts
- object types to be set
javax.xml.registry.JAXRException
PolicyException
void addApplicableObjectType(javax.xml.registry.infomodel.Concept objectTypeConcept) throws javax.xml.registry.JAXRException, PolicyException
objectTypeConcept
- object type to be added
javax.xml.registry.JAXRException
PolicyException
boolean isSystem() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isHidden() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isUserDefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setSystem() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setHidden() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setUserDefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setExecutionType(javax.xml.registry.infomodel.Concept executionType) throws PolicyException, javax.xml.registry.JAXRException
executionType
- execution type to be set
PolicyException
javax.xml.registry.JAXRException
javax.xml.registry.infomodel.Concept getExecutionType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
PolicyActionCategory getActionCategory() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
AssertionType getActionType() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |