com.softwareag.centrasite.policy.api
Interface PolicyActionParameter

All Superinterfaces:
PolicyRegistryObject

public interface PolicyActionParameter
extends PolicyRegistryObject

Models the action parameters for PolicyActionTemplate


Method Summary
 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 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)
          Set the Array flag to the given boolean if set to true implies that the policy parameter creating from this action parameter can have multiple values
 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
 
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

getDefaultValue

java.lang.String getDefaultValue()
                                 throws javax.xml.registry.JAXRException
Returns the default value for the PolicyActionParameter.

Returns:
default value for the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)
                     throws javax.xml.registry.JAXRException
Sets the the default value for the PolicyActionParameter.

Parameters:
defaultValue - value to be set as default.
Throws:
javax.xml.registry.JAXRException

isRequired

boolean isRequired()
                   throws javax.xml.registry.JAXRException
Returns whether this action parameter is mandatory in the context of the Policy Action which uses it

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

setRequired

void setRequired(boolean required)
                 throws javax.xml.registry.JAXRException
Sets whether this action parameter is mandatory or not in the context of the Policy Action which uses it

Parameters:
required - true if this action parameter is mandatory, false otherwise.
Throws:
javax.xml.registry.JAXRException

isArray

boolean isArray()
                throws javax.xml.registry.JAXRException
Returns this PolicyActionParameter is ArrayType or not

Returns:
true - if this is ArrayType, false - otherwise.
Throws:
javax.xml.registry.JAXRException

setArray

void setArray(boolean isArray)
              throws javax.xml.registry.JAXRException
Set the Array flag to the given boolean if set to true implies that the policy parameter creating from this action parameter can have multiple values

Parameters:
isArray -
Throws:
javax.xml.registry.JAXRException

getPossibleValues

java.util.Collection getPossibleValues()
                                       throws javax.xml.registry.JAXRException
Returns the Collection of Possible Values for the PolicyActionParameter.

Returns:
Collection of possibleValues.
Throws:
javax.xml.registry.JAXRException

getPossibleValueConcepts

java.util.Collection<javax.xml.registry.infomodel.Concept> getPossibleValueConcepts()
                                                                                    throws javax.xml.registry.JAXRException
Returns the Collection of Possible Value concepts for the system policyActionParameter.

Returns:
Collection of possibleValue concepts.
Throws:
javax.xml.registry.JAXRException

setPossibleValues

void setPossibleValues(java.util.Collection possibleValues)
                       throws javax.xml.registry.JAXRException
Sets the PossibleValues.

Parameters:
possibleValues - possibleValues to set.
Throws:
javax.xml.registry.JAXRException

getType

java.lang.String getType()
                         throws javax.xml.registry.JAXRException
Returns the type of PolicyActionParameter. Generally can be any of ParameterTypeConstants If not it will be the key of the specific object type.

Returns:
type of PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException

getChildActionParameters

java.util.List<PolicyActionParameter> getChildActionParameters()
                                                               throws javax.xml.registry.JAXRException,
                                                                      PolicyException
Returns the list of child action parameters for this action parameter

Returns:
list of child action parameters
Throws:
javax.xml.registry.JAXRException
PolicyException

getPolicyActionParameterByName

PolicyActionParameter getPolicyActionParameterByName(java.lang.String name)
                                                     throws javax.xml.registry.JAXRException,
                                                            PolicyException
Returns the child PolicyActionParameter with the given name.

Parameters:
name - name to be matched for the PolicyActionParameter.
Returns:
PolicyActionParameter with the matching name. null if no match found.
Throws:
javax.xml.registry.JAXRException
PolicyException

setPolicyActionParameters

void setPolicyActionParameters(java.util.List<PolicyActionParameter> childActionParameters)
                               throws javax.xml.registry.JAXRException
Sets the child PolicyActionParameters of this PolicyActionParameter. Old PolicyActionParameters will be lost.

Parameters:
childActionParameters - child action parameters to be set for this PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException

addPolicyActionParameter

void addPolicyActionParameter(PolicyActionParameter policyActionParameter)
                              throws javax.xml.registry.JAXRException
Adds the PolicyActionParameter to the existing child PolicyActionParameter collection.

Parameters:
policyActionParameter - child PolicyActionParameter to be added.
Throws:
javax.xml.registry.JAXRException

removePolicyActionParameter

void removePolicyActionParameter(PolicyActionParameter childActionParameter)
                                 throws javax.xml.registry.JAXRException
Removes the child PolicyActionParameter from the existing set of PolicyActionParameters for this input.

Parameters:
childActionParameter - child PolicyActionParameter to be removed.
Throws:
javax.xml.registry.JAXRException

removePolicyActionParameterByName

void removePolicyActionParameterByName(java.lang.String childActionParameterName)
                                       throws javax.xml.registry.JAXRException,
                                              PolicyException
Removes the child PolicyActionParameter with the specified name from the PolicyActionParameter.

Parameters:
childActionParameterName - Name of the child PolicyActionParameter to be removed.
Throws:
javax.xml.registry.JAXRException
PolicyException

isSystem

boolean isSystem()
                 throws javax.xml.registry.JAXRException,
                        PolicyException
Returns true if this is a system PolicyActionParameter, false otherwise

Returns:
true if this is a system PolicyActionParameter, false otherwise
Throws:
javax.xml.registry.JAXRException
PolicyException