public interface PolicyParameter extends PolicyRegistryObject
PolicyActionInstance
.Modifier and Type | Method and Description |
---|---|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
boolean value)
Adds PolicyParameter from the PolicyActionParameter with the value.
|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
com.centrasite.jaxr.infomodel.CentraSiteRegistryObject registryObject)
Adds PolicyParameter from the PolicyActionParameter with the given value.
|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
java.util.Collection values)
Adds PolicyParameter from the PolicyActionParameter with the given value.
|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
java.util.Date value)
Adds PolicyParameter from the PolicyActionParameter with the given value.
|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
double value)
Adds PolicyParameter from the PolicyActionParameter with the given value.
|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
java.lang.String value)
Adds PolicyParameter from the PolicyActionParameter with the value.
|
PolicyParameter |
addParameter(PolicyActionParameter policyActionParameter,
java.net.URL value)
Adds PolicyParameter from the PolicyActionParameter with the value.
|
void |
addParameter(PolicyParameter childParameter)
Adds the given parameter to the list of child parameters.
|
void |
addParameters(java.util.List<PolicyParameter> parameters)
Adds the given parameters to the list of child parameters.
|
PolicyActionParameter |
getActionParameter()
Gets the Policy Action Parameter based on which this Policy Parameter was created.
|
java.util.List<PolicyParameter> |
getChildParameters()
Gets the list of all child parameters of this policy parameter.
|
PolicyParameter |
getParameter(java.lang.String name)
Returns the child PolicyParameter with the given name.
|
java.util.List<PolicyParameter> |
getParameters(java.lang.String name)
Returns the list of child PolicyParameters with the given name.
|
com.centrasite.jaxr.infomodel.CentraSiteInternationalString |
getParameterTemplateName()
Gets the Policy Parameter Template Name based on which this Policy Parameter was created.
|
java.lang.String |
getType()
Returns the type of PolicyParameter.
|
java.lang.String |
getValue()
Returns the value of the PolicyParameter.
|
boolean |
getValueAsBoolean()
Returns the value of the PolicyParameter.
|
java.util.Date |
getValueAsDate()
Returns the value of the PolicyParameter as a date.
|
double |
getValueAsNumber()
Returns the value of the PolicyParameter as a number.
|
com.centrasite.jaxr.infomodel.CentraSiteRegistryObject |
getValueAsRegistryObject()
If the parameter references a JAXR object, that will be returned.
|
java.net.URL |
getValueAsURL()
Returns the value of the PolicyParameter as a URL.
|
java.util.Collection |
getValues()
Returns the value of the PolicyParameter.
|
boolean |
isArray()
Returns whether this PolicyActionParameter is ArrayType or not.
|
boolean |
isRoType()
Returns whether this parameter is a registry object type.
|
void |
removeParameter(PolicyParameter policyParameter)
Removes the PolicyParameter from the Collection of PolicyParameters.
|
void |
removeParameterByName(java.lang.String policyParameterName)
Removes the PolicyParameter from the Collection of PolicyParameters.
|
void |
setValue(boolean value)
Sets the value of the PolicyParameter.
|
void |
setValue(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject registryObject)
Sets the specified CentraSite Registry Object as the parameter.
|
void |
setValue(java.util.Date value)
Sets the value of the PolicyParameter.
|
void |
setValue(double value)
Sets the value of the PolicyParameter.
|
void |
setValue(java.lang.String value)
Sets the value of the PolicyParameter.
|
void |
setValue(java.net.URL value)
Sets the value of the PolicyParameter.
|
void |
setValues(java.util.Collection values)
Sets the value of the PolicyParameter.
|
void |
validate()
Validates the Policy Parameter If the mandatory parameter does not have required values, throws PolicyException.
|
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRObject, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair
com.centrasite.jaxr.infomodel.CentraSiteInternationalString getParameterTemplateName() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy Parameter Template NamePolicyException
- if an internal error occursPolicyActionParameter getActionParameter() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the action ParameterPolicyException
- if an internal error occursjava.util.List<PolicyParameter> getChildParameters() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the child ParametersPolicyException
- if an internal error occurscom.centrasite.jaxr.infomodel.CentraSiteRegistryObject getValueAsRegistryObject() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the registry object valuePolicyException
- if an internal error occursjava.lang.String getValue() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter valuePolicyException
- if an internal error occursjava.net.URL getValueAsURL() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter value as a URLPolicyException
- if an internal error occursboolean getValueAsBoolean() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter value as booleanPolicyException
- if an internal error occursjava.util.Date getValueAsDate() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter value as a datePolicyException
- if an internal error occursdouble getValueAsNumber() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter value as a numberPolicyException
- if an internal error occursjava.util.Collection getValues() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter valuesPolicyException
- if an internal error occursvoid setValue(java.lang.String value) throws javax.xml.registry.JAXRException, PolicyException
value
- value to set.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter valuePolicyException
- if an internal error occursvoid setValue(java.net.URL value) throws javax.xml.registry.JAXRException, PolicyException
value
- value to set.javax.xml.registry.JAXRException
- if an internal error occurs on updating the policy parameter valuePolicyException
- if an internal error occursvoid setValue(boolean value) throws javax.xml.registry.JAXRException, PolicyException
value
- value to set.javax.xml.registry.JAXRException
- if an internal error occurs on updating the policy parameter valuePolicyException
- if an internal error occursvoid setValue(java.util.Date value) throws javax.xml.registry.JAXRException, PolicyException
value
- the value of type Date
to set.javax.xml.registry.JAXRException
- if an internal error occurs on updating the policy parameter valuePolicyException
- if an internal error occursvoid setValue(double value) throws javax.xml.registry.JAXRException, PolicyException
value
- value to set.javax.xml.registry.JAXRException
- if an internal error occurs on updating policy parameter value
* @throws PolicyException if an internal error occursPolicyException
void setValue(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject registryObject) throws javax.xml.registry.JAXRException, PolicyException
registryObject
- the CentraSite Registry Objectjavax.xml.registry.JAXRException
- if an internal error occursPolicyException
- if an internal error occursvoid setValues(java.util.Collection values) throws javax.xml.registry.JAXRException, PolicyException
values
- value to set.javax.xml.registry.JAXRException
- if an internal error occurs on updating the policy parameter valuesPolicyException
- if an internal error occursjava.lang.String getType() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the policy parameter typePolicyException
- if an internal error occursboolean isArray() throws javax.xml.registry.JAXRException, PolicyException
true
- if this is ArrayType, false
- otherwise.javax.xml.registry.JAXRException
- if an internal error occurs on checking the array typePolicyException
- if an internal error occursboolean isRoType() throws javax.xml.registry.JAXRException, PolicyException
true
if this parameter is a registry object type, false
otherwisejavax.xml.registry.JAXRException
- if an internal error occurs on checking the registry object typePolicyException
- if an internal error occursPolicyParameter getParameter(java.lang.String name) throws javax.xml.registry.JAXRException, PolicyException
name
- Name to be matched.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParameterPolicyException
- if an internal error occursjava.util.List<PolicyParameter> getParameters(java.lang.String name) throws javax.xml.registry.JAXRException, PolicyException
name
- name of the child parameterjavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParametersPolicyException
- if an internal error occursvoid addParameter(PolicyParameter childParameter)
childParameter
- child parameter to be added to the existing list of parametersvoid addParameters(java.util.List<PolicyParameter> parameters)
parameters
- list of child parameters to be added to the existing list of parametersPolicyParameter addParameter(PolicyActionParameter policyActionParameter, java.lang.String value) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.value
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on adding the Policy ParameterPolicyException
- if an internal error occursPolicyParameter addParameter(PolicyActionParameter policyActionParameter, java.net.URL value) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.value
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParametersPolicyException
- if an internal error occursPolicyParameter addParameter(PolicyActionParameter policyActionParameter, boolean value) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.value
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving Policy ParameterPolicyException
- if an internal error occursPolicyParameter addParameter(PolicyActionParameter policyActionParameter, java.util.Date value) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.value
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParameterPolicyException
- if an internal error occursPolicyParameter addParameter(PolicyActionParameter policyActionParameter, double value) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.value
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParameterPolicyException
- if an internal error occursPolicyParameter addParameter(PolicyActionParameter policyActionParameter, com.centrasite.jaxr.infomodel.CentraSiteRegistryObject registryObject) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.registryObject
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParameterPolicyException
- if an internal error occursPolicyParameter addParameter(PolicyActionParameter policyActionParameter, java.util.Collection values) throws javax.xml.registry.JAXRException, PolicyException
policyActionParameter
- PolicyActionParameter for which the value needs to be added.values
- Value for the PolicyParameter.javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Policy ParameterPolicyException
- if an internal error occursvoid removeParameter(PolicyParameter policyParameter) throws javax.xml.registry.JAXRException
policyParameter
- PolicyParameter to be removed.javax.xml.registry.JAXRException
- if an internal error occurs on removing the Policy Parametervoid removeParameterByName(java.lang.String policyParameterName) throws javax.xml.registry.JAXRException, PolicyException
policyParameterName
- PolicyParameter to be removed.javax.xml.registry.JAXRException
- if an internal error occurs on removing the Policy ParameterPolicyException
- if an internal error occursvoid validate() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if an internal error occursPolicyException
- If the mandatory parameter does not have required values