public interface PolicyActionParameter extends PolicyRegistryObject
PolicyActionTemplate
.Modifier and Type | Method and Description |
---|---|
void |
addPolicyActionParameter(PolicyActionParameter policyActionParameter)
Adds the PolicyActionParameter to the existing child PolicyActionParameter collection.
|
java.util.List<PolicyActionParameter> |
getChildActionParameters()
Returns the list of child action parameters for this action parameter.
|
java.lang.String |
getDefaultValue()
Returns the default value for the PolicyActionParameter.
|
PolicyActionParameter |
getPolicyActionParameterByName(java.lang.String name)
Returns the child PolicyActionParameter with the given name.
|
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getPossibleValueConcepts()
Returns the Collection of Possible Value concepts for the system policyActionParameter.
|
java.util.Collection |
getPossibleValues()
Returns the Collection of Possible Values for the PolicyActionParameter.
|
java.lang.String |
getType()
Returns the type of PolicyActionParameter.
|
boolean |
isArray()
Returns whether this PolicyActionParameter is ArrayType or not.
|
boolean |
isRequired()
Returns whether this action parameter is mandatory in the context of the Policy Action which uses it.
|
boolean |
isSystem()
Returns true if this is a system PolicyActionParameter, false otherwise.
|
void |
removePolicyActionParameter(PolicyActionParameter childActionParameter)
Removes the child PolicyActionParameter from the existing set of PolicyActionParameters for this input.
|
void |
removePolicyActionParameterByName(java.lang.String childActionParameterName)
Removes the child PolicyActionParameter with the specified name from the PolicyActionParameter.
|
void |
setArray(boolean isArray)
Sets the Array flag to the given boolean.
|
void |
setDefaultValue(java.lang.String defaultValue)
Sets the the default value for the PolicyActionParameter.
|
void |
setPolicyActionParameters(java.util.List<PolicyActionParameter> childActionParameters)
Sets the child PolicyActionParameters of this PolicyActionParameter.
|
void |
setPossibleValues(java.util.Collection possibleValues)
Sets the PossibleValues.
|
void |
setRequired(boolean required)
Sets whether this action parameter is mandatory or not in the context of the Policy Action which uses it.
|
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRObject, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair
java.lang.String getDefaultValue() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the default valuevoid setDefaultValue(java.lang.String defaultValue) throws javax.xml.registry.JAXRException
defaultValue
- The defaultValue value to be set as default.javax.xml.registry.JAXRException
- if an internal error occurs while updating the default valueboolean isRequired() throws javax.xml.registry.JAXRException
true
if this action parameter is mandatory, false
otherwisejavax.xml.registry.JAXRException
- if an internal error occursvoid setRequired(boolean required) throws javax.xml.registry.JAXRException
required
- true
if this action parameter is mandatory, false
otherwise.javax.xml.registry.JAXRException
- if an internal error occursboolean isArray() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid setArray(boolean isArray) throws javax.xml.registry.JAXRException
isArray
- the boolean valuejavax.xml.registry.JAXRException
- if an internal error occursjava.util.Collection getPossibleValues() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the possible valuesjava.util.Collection<javax.xml.registry.infomodel.Concept> getPossibleValueConcepts() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving possibleValue conceptsvoid setPossibleValues(java.util.Collection possibleValues) throws javax.xml.registry.JAXRException
possibleValues
- The possibleValues collection of possibleValues to be set.javax.xml.registry.JAXRException
- if an internal error occurs on updating the possibleValuesjava.lang.String getType() throws javax.xml.registry.JAXRException
ParameterTypeConstants
If not it will
be the key of the specific object type.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the typejava.util.List<PolicyActionParameter> getChildActionParameters() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving child action parametersPolicyException
- if an internal error occursPolicyActionParameter getPolicyActionParameterByName(java.lang.String name) throws javax.xml.registry.JAXRException, PolicyException
name
- the name to be matched for the PolicyActionParameter.PolicyActionParameter
with the matching name. null if no match found.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving policy child action parameterPolicyException
- if an internal error occursvoid setPolicyActionParameters(java.util.List<PolicyActionParameter> childActionParameters) throws javax.xml.registry.JAXRException
childActionParameters
- the child action parameters to be set for this PolicyActionParameter.javax.xml.registry.JAXRException
- if an internal error occurs on updating the policy action parametersvoid addPolicyActionParameter(PolicyActionParameter policyActionParameter) throws javax.xml.registry.JAXRException
policyActionParameter
- the child PolicyActionParameter to be added.javax.xml.registry.JAXRException
- if an internal error occurs on adding the policy action parametervoid removePolicyActionParameter(PolicyActionParameter childActionParameter) throws javax.xml.registry.JAXRException
childActionParameter
- the child PolicyActionParameter to be removed.javax.xml.registry.JAXRException
- if an internal error occurs on removing the policy action parametervoid removePolicyActionParameterByName(java.lang.String childActionParameterName) throws javax.xml.registry.JAXRException, PolicyException
childActionParameterName
- the Name of the child PolicyActionParameter to be removed.javax.xml.registry.JAXRException
- if an internal error occurs on removing the policy action parameterPolicyException
- if an internal error occursboolean isSystem() throws javax.xml.registry.JAXRException, PolicyException
true
if this is a system PolicyActionParameter, false
otherwisejavax.xml.registry.JAXRException
- if an internal error occurs on checking the system parameterPolicyException
- if an internal error occurs