com.opensymphony.workflow.query
Class FieldExpression

java.lang.Object
  extended by com.opensymphony.workflow.query.Expression
      extended by com.opensymphony.workflow.query.FieldExpression
All Implemented Interfaces:
Serializable

public class FieldExpression
extends Expression

Field expressions are used when constructing a workflow query on the fields of persistent workflow instances like (START_DATE, OWNER,....). Field expressions have three attributes. These are:

  • operator: This is the operator to apply on the expression.
  • field: The workflow field to test agains
  • Context: The context to search in, which can be one history, current steps, or a workflow instance.

    Author:
    Christine Zimmermann
    See Also:
    Serialized Form

    Field Summary
    static int ACTION
              Constant for the workflow action field.
    static int CALLER
              Constant for the workflow caller field.
    static int CURRENT_STEPS
              Constant for the history steps context.
    static int DUE_DATE
              Constant for the workflow due date field.
    static int ENTRY
              Constant for the workflow entry context.
    static int EQUALS
              Constant for the equality operator.
    static int FINISH_DATE
              Constant for the workflow finish date field.
    static int GT
              Constant for the greater than operator.
    static int HISTORY_STEPS
              Constant for the history steps context.
    static int LT
              Constant for the less than operator.
    static int NAME
              Constant for the workflow name field.
    static int NOT_EQUALS
              Constant for the not equals operator.
    static int OWNER
              Constant for the workflow owner field.
    static int START_DATE
              Constant for the workflow start date field.
    static int STATE
              Constant for the state field.
    static int STATUS
              Constant for the workflow status field.
    static int STEP
              Constant for the workflow step field.
     
    Fields inherited from class com.opensymphony.workflow.query.Expression
    negate
     
    Constructor Summary
    FieldExpression()
               
    FieldExpression(int field, int context, int operator, Object value)
               
    FieldExpression(int field, int context, int operator, Object value, boolean negate)
               
     
    Method Summary
     int getContext()
               
     int getField()
               
     int getOperator()
               
     Object getValue()
               
     boolean isNested()
               
     void setContext(int context)
               
     void setField(int field)
               
     void setOperator(int operator)
               
     void setValue(Object value)
               
     
    Methods inherited from class com.opensymphony.workflow.query.Expression
    isNegate
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Field Detail

    EQUALS

    public static final int EQUALS
    Constant for the equality operator.

    See Also:
    Constant Field Values

    LT

    public static final int LT
    Constant for the less than operator.

    See Also:
    Constant Field Values

    GT

    public static final int GT
    Constant for the greater than operator.

    See Also:
    Constant Field Values

    NOT_EQUALS

    public static final int NOT_EQUALS
    Constant for the not equals operator.

    See Also:
    Constant Field Values

    OWNER

    public static final int OWNER
    Constant for the workflow owner field.

    See Also:
    Constant Field Values

    START_DATE

    public static final int START_DATE
    Constant for the workflow start date field.

    See Also:
    Constant Field Values

    FINISH_DATE

    public static final int FINISH_DATE
    Constant for the workflow finish date field.

    See Also:
    Constant Field Values

    ACTION

    public static final int ACTION
    Constant for the workflow action field.

    See Also:
    Constant Field Values

    STEP

    public static final int STEP
    Constant for the workflow step field.

    See Also:
    Constant Field Values

    CALLER

    public static final int CALLER
    Constant for the workflow caller field.

    See Also:
    Constant Field Values

    STATUS

    public static final int STATUS
    Constant for the workflow status field.

    See Also:
    Constant Field Values

    NAME

    public static final int NAME
    Constant for the workflow name field.

    See Also:
    Constant Field Values

    STATE

    public static final int STATE
    Constant for the state field.

    See Also:
    Constant Field Values

    DUE_DATE

    public static final int DUE_DATE
    Constant for the workflow due date field.

    See Also:
    Constant Field Values

    HISTORY_STEPS

    public static final int HISTORY_STEPS
    Constant for the history steps context. Specifying this context means that the search should be performed against the workflow steps.

    See Also:
    Constant Field Values

    CURRENT_STEPS

    public static final int CURRENT_STEPS
    Constant for the history steps context. Specifying this context means that the search should be performed against the workflow current steps.

    See Also:
    Constant Field Values

    ENTRY

    public static final int ENTRY
    Constant for the workflow entry context. Specifying this context means that the search should be performed against the workflow entries.

    See Also:
    Constant Field Values
    Constructor Detail

    FieldExpression

    public FieldExpression()

    FieldExpression

    public FieldExpression(int field,
                           int context,
                           int operator,
                           Object value)

    FieldExpression

    public FieldExpression(int field,
                           int context,
                           int operator,
                           Object value,
                           boolean negate)
    Method Detail

    setContext

    public void setContext(int context)

    getContext

    public int getContext()

    setField

    public void setField(int field)

    getField

    public int getField()

    isNested

    public boolean isNested()
    Specified by:
    isNested in class Expression

    setOperator

    public void setOperator(int operator)

    getOperator

    public int getOperator()

    setValue

    public void setValue(Object value)

    getValue

    public Object getValue()

    OpenSymphony Workflow Project Page