com.softwareag.centrasite.policy.api
Interface PolicyParameter

All Superinterfaces:
PolicyRegistryObject

public interface PolicyParameter
extends PolicyRegistryObject

Models the parameters for a specific PolicyActionInstance


Method Summary
 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 value.
 PolicyParameter addParameter(PolicyActionParameter policyActionParameter, java.util.Collection values)
          Adds PolicyParameter from the PolicyActionParameter with the value.
 PolicyParameter addParameter(PolicyActionParameter policyActionParameter, java.util.Date value)
          Adds PolicyParameter from the PolicyActionParameter with the value.
 PolicyParameter addParameter(PolicyActionParameter policyActionParameter, double value)
          Adds PolicyParameter from the PolicyActionParameter with the 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()
          Get the Policy Action Parameter based on which this Policy Parameter was created
 java.util.List<PolicyParameter> getChildParameters()
          Get the list of all child parameters of this policy parameter
 PolicyParameter getParameter(java.lang.String name)
          Returns the child PolicyParameter with the name.
 java.util.List<PolicyParameter> getParameters(java.lang.String name)
          Returns the list of child PolicyParameters with the name.
 com.centrasite.jaxr.infomodel.CentraSiteInternationalString getParameterTemplateName()
           
 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.
 double getValueAsNumber()
          Returns the value of the PolicyParameter.
 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.
 java.util.Collection getValues()
          Returns the value of the PolicyParameter.
 boolean isArray()
          Returns this PolicyActionParameter is ArrayType or not
 boolean isRoType()
          Returns if 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 CSRO as the parameter creates an association to the CSRO from this 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 doesnot have required values, throws PolicyException
 
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

getParameterTemplateName

com.centrasite.jaxr.infomodel.CentraSiteInternationalString getParameterTemplateName()
                                                                                     throws javax.xml.registry.JAXRException,
                                                                                            PolicyException
Throws:
javax.xml.registry.JAXRException
PolicyException

getActionParameter

PolicyActionParameter getActionParameter()
                                         throws javax.xml.registry.JAXRException,
                                                PolicyException
Get the Policy Action Parameter based on which this Policy Parameter was created

Returns:
Policy Action Parameter based on which this Policy Parameter was created
Throws:
javax.xml.registry.JAXRException
PolicyException

getChildParameters

java.util.List<PolicyParameter> getChildParameters()
                                                   throws javax.xml.registry.JAXRException,
                                                          PolicyException
Get the list of all child parameters of this policy parameter

Returns:
list of all child parameters of this policy parameter
Throws:
javax.xml.registry.JAXRException
PolicyException

getValueAsRegistryObject

com.centrasite.jaxr.infomodel.CentraSiteRegistryObject getValueAsRegistryObject()
                                                                                throws javax.xml.registry.JAXRException,
                                                                                       PolicyException
If the parameter references a JAXR object, that will be returned. This will be maintained as an association (PolicyParameter ---> JAXR object)

Returns:
CentraSiteRegistryObject which is referenced by this parameter
Throws:
javax.xml.registry.JAXRException
PolicyException

getValue

java.lang.String getValue()
                          throws javax.xml.registry.JAXRException,
                                 PolicyException
Returns the value of the PolicyParameter.

Returns:
value of the PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

getValueAsURL

java.net.URL getValueAsURL()
                           throws javax.xml.registry.JAXRException,
                                  PolicyException
Returns the value of the PolicyParameter.

Returns:
value of the PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

getValueAsBoolean

boolean getValueAsBoolean()
                          throws javax.xml.registry.JAXRException,
                                 PolicyException
Returns the value of the PolicyParameter.

Returns:
value of the PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

getValueAsDate

java.util.Date getValueAsDate()
                              throws javax.xml.registry.JAXRException,
                                     PolicyException
Returns the value of the PolicyParameter.

Returns:
value of the PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

getValueAsNumber

double getValueAsNumber()
                        throws javax.xml.registry.JAXRException,
                               PolicyException
Returns the value of the PolicyParameter.

Returns:
value of the PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

getValues

java.util.Collection getValues()
                               throws javax.xml.registry.JAXRException,
                                      PolicyException
Returns the value of the PolicyParameter.

Returns:
value of the PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

setValue

void setValue(java.lang.String value)
              throws javax.xml.registry.JAXRException,
                     PolicyException
Sets the value of the PolicyParameter.

Parameters:
value - value to set.
Throws:
javax.xml.registry.JAXRException
PolicyException

setValue

void setValue(java.net.URL value)
              throws javax.xml.registry.JAXRException,
                     PolicyException
Sets the value of the PolicyParameter.

Parameters:
value - value to set.
Throws:
javax.xml.registry.JAXRException
PolicyException

setValue

void setValue(boolean value)
              throws javax.xml.registry.JAXRException,
                     PolicyException
Sets the value of the PolicyParameter.

Parameters:
value - value to set.
Throws:
javax.xml.registry.JAXRException
PolicyException

setValue

void setValue(java.util.Date value)
              throws javax.xml.registry.JAXRException,
                     PolicyException
Sets the value of the PolicyParameter.

Parameters:
value - value to set.
Throws:
javax.xml.registry.JAXRException
PolicyException

setValue

void setValue(double value)
              throws javax.xml.registry.JAXRException,
                     PolicyException
Sets the value of the PolicyParameter.

Parameters:
value - value to set.
Throws:
javax.xml.registry.JAXRException
PolicyException

setValue

void setValue(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject registryObject)
              throws javax.xml.registry.JAXRException,
                     PolicyException
Sets the specified CSRO as the parameter creates an association to the CSRO from this parameter.

Parameters:
registryObject -
Throws:
javax.xml.registry.JAXRException
PolicyException

setValues

void setValues(java.util.Collection values)
               throws javax.xml.registry.JAXRException,
                      PolicyException
Sets the value of the PolicyParameter.

Parameters:
values - value to set.
Throws:
javax.xml.registry.JAXRException
PolicyException

getType

java.lang.String getType()
                         throws javax.xml.registry.JAXRException,
                                PolicyException
Returns the type of PolicyParameter.

Returns:
type of PolicyParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

isArray

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

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

isRoType

boolean isRoType()
                 throws javax.xml.registry.JAXRException,
                        PolicyException
Returns if this parameter is a registry object type.

Returns:
true if this parameter is a registry object type, false otherwise
Throws:
javax.xml.registry.JAXRException
PolicyException

getParameter

PolicyParameter getParameter(java.lang.String name)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Returns the child PolicyParameter with the name.

Parameters:
name - Name to be matched.
Returns:
PolicyParameter with the name.
Throws:
javax.xml.registry.JAXRException
PolicyException

getParameters

java.util.List<PolicyParameter> getParameters(java.lang.String name)
                                              throws javax.xml.registry.JAXRException,
                                                     PolicyException
Returns the list of child PolicyParameters with the name.

Parameters:
name - name of the child parameter
Returns:
list of child PolicyParameters with the name.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

void addParameter(PolicyParameter childParameter)
Adds the given parameter to the list of child parameters

Parameters:
childParameter - child parameter to be added to the existing list of parameters

addParameters

void addParameters(java.util.List<PolicyParameter> parameters)
Adds the given parameters to the list of child parameters

Parameters:
parameters - list of child parameters to be added to the existing list of parameters

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             java.lang.String value)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
value - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             java.net.URL value)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
value - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             boolean value)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
value - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             java.util.Date value)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
value - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             double value)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
value - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             com.centrasite.jaxr.infomodel.CentraSiteRegistryObject registryObject)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
registryObject - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

addParameter

PolicyParameter addParameter(PolicyActionParameter policyActionParameter,
                             java.util.Collection values)
                             throws javax.xml.registry.JAXRException,
                                    PolicyException
Adds PolicyParameter from the PolicyActionParameter with the value.

Parameters:
policyActionParameter - PolicyActionParameter for which the value needs to be added.
values - Value for the PolicyParameter.
Returns:
The PolicyParameter value created using the PolicyActionParameter.
Throws:
javax.xml.registry.JAXRException
PolicyException

removeParameter

void removeParameter(PolicyParameter policyParameter)
                     throws javax.xml.registry.JAXRException
Removes the PolicyParameter from the Collection of PolicyParameters.

Parameters:
policyParameter - PolicyParameter to be removed.
Throws:
javax.xml.registry.JAXRException

removeParameterByName

void removeParameterByName(java.lang.String policyParameterName)
                           throws javax.xml.registry.JAXRException,
                                  PolicyException
Removes the PolicyParameter from the Collection of PolicyParameters.

Parameters:
policyParameterName - PolicyParameter to be removed.
Throws:
javax.xml.registry.JAXRException
PolicyException

validate

void validate()
              throws javax.xml.registry.JAXRException,
                     PolicyException
Validates the Policy Parameter If the mandatory parameter doesnot have required values, throws PolicyException

Throws:
javax.xml.registry.JAXRException
PolicyException - If the mandatory parameter doesnot have required values