com.ibm.itim.apps.policy
Class ServiceAttributeParameter

java.lang.Object
  com.ibm.itim.apps.policy.ServiceAttributeParameter

All Implemented Interfaces:

java.io.Serializable

public class ServiceAttributeParameter
extends java.lang.Object
implements java.io.Serializable

This class is used to store a service attribute parameter enforceable through a provisioning policy.

See Also:

ProvisioningParameters, Serialized Form

Field Summary

static int	ALLOWED Constant which represents an optional attribute enforcement.
static int	DEFAULT Constant which represents an default attribute enforcement.
static int	EXCLUDED Constant which represents an excluded attribute enforcement.
static int	EXPRESSION_TYPE_REGULAR
static int	EXPRESSION_TYPE_SCRIPT
static int	MANDATORY Constant which represents an mandatory attribute enforcement.
static int	OPTIONAL Deprecated. This enforcement now behaves like DEFAULT. To specify optional attribute enforcement, use ALLOWED instead.

Constructor Summary

ServiceAttributeParameter(java.lang.String parameterName, java.util.List parameterValues, int[] enforcements)
Constructor for single or multi valued attributes

ServiceAttributeParameter(java.lang.String parameterName, java.util.List parameterValues, int[] enforcements, int[] expressionTypes)
Constructor for single or mainly multi valued attributes

ServiceAttributeParameter(java.lang.String parameterName, java.lang.Object parameterValue, int enforcement)
Constructor only for single valued attributes where the value is a constant or contains a script expression or program.

Method Summary

AttributeValue	getAttributeValueObject() Returns the AttributeValue object of a single valued parameter.
int	getEnforcement() Returns enforcement of the only value of a single valued parameter.
int[]	getEnforcements() Returns array of enforcements order of which corresponds to the order of individual values in this provisioning parameter.
int	getExpressionType() Returns expressionType of the only value of a single valued parameter.
int[]	getExpressionTypes() Returns array of expression types order of which corresponds to the order of individual values in this provisioning parameter.
java.lang.String	getParameterName() Returns name of the provisioning parameter
java.lang.Object	getParameterValue() Returns single value of the prosivioning parameter.
java.util.List	getParameterValues() Return collection of all individual parameter values.
void	setEnforcement(int enforcement) Sets the enforcement of the only value of this provisioning parameter.
void	setEnforcements(int[] enforcements) Sets the enforcements for each value in this provisioning parameter.
void	setExpressionType(int expressionType) Sets the expression type of the only value of this provisioning parameter.
void	setExpressionTypes(int[] expressionTypes) Sets the expression types for each value in this provisioning parameter.
void	setParameterValue(java.lang.Object parameterValue) Stores value of a single value parameter
void	setParameterValues(java.util.List parameterValues) Stores the collection of all individual values that this parameter contains.
java.lang.String	toString() This method will return a string representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OPTIONAL

public static final int OPTIONAL

Deprecated. This enforcement now behaves like DEFAULT. To specify optional attribute enforcement, use ALLOWED instead.

Constant which represents an optional attribute enforcement.

See Also:

Constant Field Values

EXCLUDED

public static final int EXCLUDED

Constant which represents an excluded attribute enforcement.

See Also:

Constant Field Values

ALLOWED

public static final int ALLOWED

Constant which represents an optional attribute enforcement.

See Also:

Constant Field Values

DEFAULT

public static final int DEFAULT

Constant which represents an default attribute enforcement.

See Also:

Constant Field Values

MANDATORY

public static final int MANDATORY

Constant which represents an mandatory attribute enforcement.

See Also:

Constant Field Values

EXPRESSION_TYPE_SCRIPT

public static final int EXPRESSION_TYPE_SCRIPT

See Also:

Constant Field Values

EXPRESSION_TYPE_REGULAR

public static final int EXPRESSION_TYPE_REGULAR

See Also:

Constant Field Values

Constructor Detail

ServiceAttributeParameter

public ServiceAttributeParameter(java.lang.String parameterName,
                                 java.lang.Object parameterValue,
                                 int enforcement)

Constructor only for single valued attributes where the value is a constant or contains a script expression or program.

Parameters:

parameterName - Name of the provisioning parameter, the account attribute name

parameterValue - Value of the attribute this parameter represents where the value is a constant or a script or regular expression. A constant value must include the surrounding double quotes. Example: String value = "\"my value\""; A javascript value should be without the surrounding curly braces, "{".

enforcement - Defines the enforcement option correspond to the value stored in the parameterValue argument. Possible values are EXCLUDED, ALLOWED, DEFAULT (OPTIONAL), or MANDATORY.

ServiceAttributeParameter

public ServiceAttributeParameter(java.lang.String parameterName,
                                 java.util.List parameterValues,
                                 int[] enforcements)

Constructor for single or multi valued attributes

Parameters:

parameterName - name of the provisioning parameter, the account attribute name

parameterValues - List of values of the attribute this parameter represents, where each individual value is a constant or a script or regular expression. A constant value must include the surrounding double quotes. Example: String value = "\"my value\""; A javascript value should be without the surrounding curly braces, "{".

enforcements - Defines array with enforcement options ordered to correspond to values stored in the parameterValues argument. Note: enforcement type of ALLOWED and EXCLUDED are not supported for single-valued attribute.

ServiceAttributeParameter

public ServiceAttributeParameter(java.lang.String parameterName,
                                 java.util.List parameterValues,
                                 int[] enforcements,
                                 int[] expressionTypes)

Constructor for single or mainly multi valued attributes

Parameters:

parameterName - Name of the provisioning parameter, the account attribute name

parameterValues - List of values of the attribute this parameter represents, where each individual value is a constant or a script or regular expression. A constant value must include the surrounding double quotes. Example: String value = "\"my value\""; A javascript value should be without the surrounding curly braces, "{".

enforcements - Defines array with enforcement options ordered to correspond to values. Note: enforcement type of ALLOWED and EXCLUDED are not supported for single-valued attribute.

expressionTypes - Defines array with expression type options ordered to correspond to values stored in the parameterValues argument. options maybe one of the following: EXPRESSION_TYPE_SCRIPT EXPRESSION_TYPE_REGULAR

Method Detail

getParameterName

public java.lang.String getParameterName()

Returns name of the provisioning parameter

Returns:

String representing the name of provisioning parameter

getAttributeValueObject

public AttributeValue getAttributeValueObject()

Returns the AttributeValue object of a single valued parameter.

Returns:

AttributeValue object of a single valued parameter.

getParameterValue

public java.lang.Object getParameterValue()

Returns single value of the prosivioning parameter.

Returns:

Object containing the parameter value.

setParameterValue

public void setParameterValue(java.lang.Object parameterValue)

Stores value of a single value parameter

Parameters:

parameterValue - Value of the attribute this parameter represents where the value is a constant or a script or regular expression. A constant value must include the surrounding double quotes. Example: String value = "\"my value\""; A javascript value should be without the surrounding curly braces, "{".

getParameterValues

public java.util.List getParameterValues()

Return collection of all individual parameter values. In case of a single valued parameter only one value is expected.

Returns:

a list of all individual parameter values.

setParameterValues

public void setParameterValues(java.util.List parameterValues)

Stores the collection of all individual values that this parameter contains.

Parameters:

parameterValues - List of values of the attribute this parameter represents, where each individual value is a constant or a script or regular expression. A constant value must include the surrounding double quotes. Example: String value = "\"my value\""; A javascript value should be without the surrounding curly braces, "{".

getEnforcement

public int getEnforcement()

Returns enforcement of the only value of a single valued parameter.

Returns:

int representing the enforcement of the only value of a single valued parameter.

setEnforcement

public void setEnforcement(int enforcement)

Sets the enforcement of the only value of this provisioning parameter.

Parameters:

enforcement - int representing the only value of this provisioning parameter. Note: enforcement type of ALLOWED and EXCLUDED are not supported for single-valued attribute.

getEnforcements

public int[] getEnforcements()

Returns array of enforcements order of which corresponds to the order of individual values in this provisioning parameter.

Returns:

int[] containing enforcements order of which corresponds to the order of individual values in this provisioning parameter.

setEnforcements

public void setEnforcements(int[] enforcements)

Sets the enforcements for each value in this provisioning parameter.

Parameters:

enforcements - int[] of enforcements. Order corresponds to order of individual values stored by this provisioning parameter. Note: enforcement type of ALLOWED and EXCLUDED are not supported for single-valued attribute.

getExpressionType

public int getExpressionType()

Returns expressionType of the only value of a single valued parameter.

Returns:

int representing the expressionType of the only value of a single valued parameter.

setExpressionType

public void setExpressionType(int expressionType)

Sets the expression type of the only value of this provisioning parameter.

Parameters:

expressionType - int representing the only value of this provisioning parameter.

getExpressionTypes

public int[] getExpressionTypes()

Returns array of expression types order of which corresponds to the order of individual values in this provisioning parameter.

Returns:

int[] containing expression types order of which corresponds to the order of individual values in this provisioning parameter.

setExpressionTypes

public void setExpressionTypes(int[] expressionTypes)

Sets the expression types for each value in this provisioning parameter.

Parameters:

expressionTypes - int[] of expression types. Order corresponds to order of individual values stored by this provisioning parameter.

toString

public java.lang.String toString()

This method will return a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

String object containing textual description of this object.