com.appiancorp.suiteapi.personalization

Class Condition

java.lang.Object

com.appiancorp.suiteapi.personalization.Condition

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME_USERNAME
static java.lang.Long	DATA_TYPE_ID_TYPESTRING

Constructor Summary

Constructors

Constructor and Description
Condition() Default no-arg constructor.
Condition(java.lang.String attributeName, java.lang.Integer operatorId, java.lang.String value) Constructor that receives the attribute name, operator id and the value for this condition.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeDisplayName() Gets the attribute's display name.
java.lang.String	getAttributeName() Gets the attribute's name.
java.lang.Long	getDataTypeId() Gets the id of the type of data used in this condition.
java.lang.String	getDataTypeName() Gets the name of the data type.
java.lang.Integer	getOperatorId() Gets the operator's id.
java.lang.String	getOperatorName() Gets the name of the operator.
java.lang.String	getValue() Gets the value that is being used in the comparison of this condition.
void	setAttributeDisplayName(java.lang.String attributeDisplayName) Sets the attribute's display name.
void	setAttributeName(java.lang.String attributeName) Sets the attribute's name.
void	setDataTypeId(java.lang.Long dataTypeId) Sets the id of the type of data to use in this condition.
void	setDataTypeName(java.lang.String dataTypeName) Sets the name of the data type.
void	setOperatorId(java.lang.Integer operatorId) Sets the operator's id.
void	setOperatorName(java.lang.String operatorName) Sets the name of the operator.
void	setValue(java.lang.String value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ATTRIBUTE_NAME_USERNAME

public static final java.lang.String ATTRIBUTE_NAME_USERNAME

See Also:

Constant Field Values

DATA_TYPE_ID_TYPESTRING

public static final java.lang.Long DATA_TYPE_ID_TYPESTRING

Constructor Detail

Condition

public Condition()

Default no-arg constructor.

Condition

public Condition(java.lang.String attributeName,
                 java.lang.Integer operatorId,
                 java.lang.String value)

Constructor that receives the attribute name, operator id and the value for this condition.

Parameters:

attributeName - Name of the attribute used in this condition.

operatorId - Id of the relational operator; see fields in Operator

value - Value to use for this condition.

Method Detail

getAttributeName

public java.lang.String getAttributeName()

Gets the attribute's name. This value corresponds to a key defined in the map retrieved from com.appiancorp.ag.group.action.AddRuleSet.getAttributeAliasMap()

Returns:

Name of the attribute.

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Sets the attribute's name.

Parameters:

attributeName - Name of the attribute.

See Also:

getAttributeName()

setAttributeDisplayName

public void setAttributeDisplayName(java.lang.String attributeDisplayName)

Sets the attribute's display name.

Parameters:

attributeDisplayName - Display name of the attribute.

See Also:

getAttributeDisplayName()

getAttributeDisplayName

public java.lang.String getAttributeDisplayName()

Gets the attribute's display name. This is the value that is shown in the user interface.

Returns:

Display name of the attribute.

See Also:

AddRuleSet

setOperatorId

public void setOperatorId(java.lang.Integer operatorId)

Sets the operator's id.

Parameters:

operatorId - Id of the operator.

See Also:

getOperatorId()

getOperatorId

public java.lang.Integer getOperatorId()

Gets the operator's id. This field corresponds to the id of the relational operator to use in the comparison of this condition. For instance, the equals operator is Operator.EQUALS.

Returns:

Id of the operator.

See Also:

Operator

setValue

public void setValue(java.lang.String value)

Sets the value.

Parameters:

value - Value to use.

getValue

public java.lang.String getValue()

Gets the value that is being used in the comparison of this condition.

Returns:

The value used in the condition.

setOperatorName

public void setOperatorName(java.lang.String operatorName)

Sets the name of the operator.

Parameters:

operatorName - Name of the operator.

See Also:

getOperatorName()

getOperatorName

public java.lang.String getOperatorName()

Gets the name of the operator.

Returns:

The name of the operator.

See Also:

Operator

setDataTypeId

public void setDataTypeId(java.lang.Long dataTypeId)

Sets the id of the type of data to use in this condition.

Parameters:

dataTypeId - The id of the data type.

See Also:

getDataTypeId()

getDataTypeId

public java.lang.Long getDataTypeId()

Gets the id of the type of data used in this condition.

Returns:

The id of the data type.

See Also:

DataMap

getDataTypeName

public java.lang.String getDataTypeName()

Gets the name of the data type.

Returns:

The name of the data type.

See Also:

DataMap

setDataTypeName

public void setDataTypeName(java.lang.String dataTypeName)

Sets the name of the data type.

Parameters:

dataTypeName - The name of the data type.

See Also:

getDataTypeName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object