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.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> |
getAllRegistryObjects()
Get the registry object of the PolicyActionParameter and recursively associated PolicyActionParameter(s).
|
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<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 JAXRException
JAXRException
- if an internal error occurs on retrieving the default valuevoid setDefaultValue(java.lang.String defaultValue) throws JAXRException
defaultValue
- The defaultValue value to be set as default.JAXRException
- if an internal error occurs while updating the default valueboolean isRequired() throws JAXRException
true
if this action parameter is mandatory, false
otherwiseJAXRException
- if an internal error occursvoid setRequired(boolean required) throws JAXRException
required
- true
if this action parameter is mandatory, false
otherwise.JAXRException
- if an internal error occursboolean isArray() throws JAXRException
JAXRException
- if an internal error occursvoid setArray(boolean isArray) throws JAXRException
isArray
- the boolean valueJAXRException
- if an internal error occursjava.util.Collection getPossibleValues() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the possible valuesjava.util.Collection<Concept> getPossibleValueConcepts() throws JAXRException
JAXRException
- if an internal error occurs on retrieving possibleValue conceptsvoid setPossibleValues(java.util.Collection possibleValues) throws JAXRException
possibleValues
- The possibleValues collection of possibleValues to be set.JAXRException
- if an internal error occurs on updating the possibleValuesjava.lang.String getType() throws JAXRException
ParameterTypeConstants
If not it will
be the key of the specific object type.JAXRException
- if an internal error occurs on retrieving the typejava.util.List<PolicyActionParameter> getChildActionParameters() throws JAXRException, PolicyException
JAXRException
- if an internal error occurs on retrieving child action parametersPolicyException
- if an internal error occursPolicyActionParameter getPolicyActionParameterByName(java.lang.String name) throws JAXRException, PolicyException
name
- the name to be matched for the PolicyActionParameter.PolicyActionParameter
with the matching name. null if no match found.JAXRException
- if an internal error occurs on retrieving policy child action parameterPolicyException
- if an internal error occursvoid setPolicyActionParameters(java.util.List<PolicyActionParameter> childActionParameters) throws JAXRException
childActionParameters
- the child action parameters to be set for this PolicyActionParameter.JAXRException
- if an internal error occurs on updating the policy action parametersvoid addPolicyActionParameter(PolicyActionParameter policyActionParameter) throws JAXRException
policyActionParameter
- the child PolicyActionParameter to be added.JAXRException
- if an internal error occurs on adding the policy action parametervoid removePolicyActionParameter(PolicyActionParameter childActionParameter) throws JAXRException
childActionParameter
- the child PolicyActionParameter to be removed.JAXRException
- if an internal error occurs on removing the policy action parametervoid removePolicyActionParameterByName(java.lang.String childActionParameterName) throws JAXRException, PolicyException
childActionParameterName
- the Name of the child PolicyActionParameter to be removed.JAXRException
- if an internal error occurs on removing the policy action parameterPolicyException
- if an internal error occursboolean isSystem() throws JAXRException, PolicyException
true
if this is a system PolicyActionParameter, false
otherwiseJAXRException
- if an internal error occurs on checking the system parameterPolicyException
- if an internal error occursjava.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getAllRegistryObjects() throws JAXRException, PolicyException
JAXRException
PolicyException