com.appiancorp.suiteapi.personalization

Class Expression

java.lang.Object

com.appiancorp.suiteapi.personalization.Expression

All Implemented Interfaces:

java.io.Serializable

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

Title: Expression

Description: Holds expression for a rule set, where an expression consists of an entity name, entity id, and list of conditions.

Copyright: Copyright (c) 2002

Company: Appian Corporation

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	ENTITY_TYPE_ID_USER
static java.lang.String	ENTITY_TYPE_NAME_USER

Constructor Summary

Constructors

Constructor and Description
Expression() Default no-arg constructor.
Expression(java.lang.Long entityTypeId, java.lang.String entityTypeName, Condition[] conditions) Constructor that receives the entity type id, name and a list of conditions.

Method Summary

Modifier and Type	Method and Description
Condition[]	getConditions() Gets the list of conditions.
java.lang.Long	getEntityTypeId() Gets the entityTypeId of this expression.
java.lang.String	getEntityTypeName() Gets the entity type name of this expression.
void	setConditions(Condition[] conditions) Sets the list of conditions.
void	setEntityTypeId(java.lang.Long entityTypeId) Sets the entityTypeId of this expression.
void	setEntityTypeName(java.lang.String entityTypeName) Sets the entity type name for this expression.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_TYPE_NAME_USER

public static final java.lang.String ENTITY_TYPE_NAME_USER

See Also:

Constant Field Values

ENTITY_TYPE_ID_USER

public static final java.lang.Long ENTITY_TYPE_ID_USER

Constructor Detail

Expression

public Expression()

Default no-arg constructor.

Expression

public Expression(java.lang.Long entityTypeId,
                  java.lang.String entityTypeName,
                  Condition[] conditions)

Constructor that receives the entity type id, name and a list of conditions.

Parameters:

entityTypeId - Id of the entity type of this expression. @see #getEntityTypeId().

entityTypeName - Name of the entity type of this expression. @see #getEntityTypeName().

conditions - List of conditions that form this expression.

Method Detail

getEntityTypeName

public java.lang.String getEntityTypeName()

Gets the entity type name of this expression. The value of the entityTypeName depends on the type of expression. For user expressions the value is the string ENTITY_TYPE_NAME_USER, whereas for group types the value is the name of the group type.

Returns:

The entityTypeName of this expression.

setEntityTypeName

public void setEntityTypeName(java.lang.String entityTypeName)

Sets the entity type name for this expression.

Parameters:

entityTypeName - Name of the entity type.

See Also:

getEntityTypeName()

setConditions

public void setConditions(Condition[] conditions)

Sets the list of conditions.

Parameters:

conditions - The list of conditions to set.

getConditions

public Condition[] getConditions()

Gets the list of conditions.

Returns:

List of conditions.

setEntityTypeId

public void setEntityTypeId(java.lang.Long entityTypeId)

Sets the entityTypeId of this expression.

Parameters:

entityTypeId - The entityTypeId to set.

See Also:

getEntityTypeId()

getEntityTypeId

public java.lang.Long getEntityTypeId()

Gets the entityTypeId of this expression. The value of the entityTypeId depends if the expression is for users or group types. For users the value is ENTITY_TYPE_ID_USER, whereas for group types it corresponds to the group type id.

Returns:

The entityTypeId of this expression

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object