com.plumtree.server.condition
Interface IPTExpressionInfo


public interface IPTExpressionInfo

Author:
dustina

Method Summary
 int GetActionType()
          Gets the type of action to be performed if the expression evaluates to true.
 int GetActionValue()
          Gets the action value to be performed if the expression evalutes to true.
 int GetConditionTypeID()
          Gets the type of condition that is inside the expression.
 IValue GetConditionValue()
          Gets the value of the condition for the current expression.
 java.lang.String GetDescription()
           
 java.lang.String GetName()
           
 int GetObjectID()
           
 int GetOperatorID()
          Gets the operator that will be used to combine the list of sub expressions.
 int GetTopicPos()
          Gets the priority of the expression categorized by action types.
 boolean IsCondition()
          This expression is just a single condition, with no operator or other moderator.
 int[] QuerySubExpressionIDs()
          Gets the list of sub expression IDs inside the current expression.
 

Method Detail

GetObjectID

int GetObjectID()
Returns:
int

GetName

java.lang.String GetName()
Returns:
String

GetDescription

java.lang.String GetDescription()
Returns:
String

IsCondition

boolean IsCondition()
This expression is just a single condition, with no operator or other moderator.

Returns:
true if the current expression contains only a condition instance, false otherwise

QuerySubExpressionIDs

int[] QuerySubExpressionIDs()
Gets the list of sub expression IDs inside the current expression. Returns null if expression is a condition.

Returns:
array of sub expression IDs

GetOperatorID

int GetOperatorID()
Gets the operator that will be used to combine the list of sub expressions. Returns -1 if expression is a condition.

Returns:
ID of the operator object

GetConditionTypeID

int GetConditionTypeID()
Gets the type of condition that is inside the expression. Returns -1 if expression is not a condition.

Returns:
ID of the condition type object

GetConditionValue

IValue GetConditionValue()
Gets the value of the condition for the current expression. returns null if expression is not a condition.

Returns:
the value of the condition

GetActionType

int GetActionType()
Gets the type of action to be performed if the expression evaluates to true.

Returns:
the type of action to be performed

GetActionValue

int GetActionValue()
Gets the action value to be performed if the expression evalutes to true.

Returns:
the action value

GetTopicPos

int GetTopicPos()
Gets the priority of the expression categorized by action types. Returns 0 if expression has no priority.

Returns:
the priority of the expression


Copyright © 2008 Plumtree Software Inc. All Rights Reserved.