com.remedy.arsys.api
Class QualifierInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.QualifierInfo
All Implemented Interfaces:
java.lang.Cloneable, IARQualifierOperand

public class QualifierInfo
extends java.lang.Object
implements IARQualifierOperand, java.lang.Cloneable

The QualifierInfo class is composed of a set of zero or more conditions that limit the set of entries retrieved. Each individual condition by using a tree structure comprised of an operation and one or two operands IARQualifierOperand (depending on the type of operation). Specific implementations of this interface are QualifierInfo and RelationalOperationInfo


Field Summary
static int AR_COND_OP_AND
          A qualification using the AND operator.
static int AR_COND_OP_FROM_FIELD
          A dynamic qualification using a value from a field.
static int AR_COND_OP_MAX
          Indicates the number of currently used possible values (which is 5).
static int AR_COND_OP_NONE
          No qualification.
static int AR_COND_OP_NOT
          A qualification using the NOT operator.
static int AR_COND_OP_OR
          A qualification using the OR operator.
static int AR_COND_OP_REL_OP
          A qualification using a relational operator.
 
Constructor Summary
QualifierInfo(int operation, QualifierInfo op1, QualifierInfo op2)
          Constructor to represent operations between QualifierInfo objects
QualifierInfo(QualifierFromFieldInfo fid)
          Constructor to allow dynamic qualifier
QualifierInfo(RelationalOperationInfo op1)
          Constructor to allow relational operation
 
Method Summary
 java.lang.Object clone()
          Clone implementation that returns an Object with data cloned from self
 boolean equals(java.lang.Object anObject)
          Use this method for checking equality.
 QualifierFromFieldInfo getFromFieldInfo()
          Returns field ID/value pair information.
 QualifierInfo getLeftOperand()
          Returns value of left operand.
 QualifierInfo getNotOperand()
          Helper function to return the operand associated in NOT operation
 int getOperation()
          Returns operation used in qualification.
 RelationalOperationInfo getRelationalOperationInfo()
          Helper function to return RelationalOperationInfo object
 QualifierInfo getRightOperand()
          Returns value of right operand.
 int hashCode()
          This method can be used to populate a hash table.
 void setOperation(int op)
          Sets operation used in qualification.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AR_COND_OP_NONE

public static final int AR_COND_OP_NONE
No qualification.

AR_COND_OP_AND

public static final int AR_COND_OP_AND
A qualification using the AND operator.

AR_COND_OP_OR

public static final int AR_COND_OP_OR
A qualification using the OR operator.

AR_COND_OP_NOT

public static final int AR_COND_OP_NOT
A qualification using the NOT operator.

AR_COND_OP_REL_OP

public static final int AR_COND_OP_REL_OP
A qualification using a relational operator.

AR_COND_OP_FROM_FIELD

public static final int AR_COND_OP_FROM_FIELD
A dynamic qualification using a value from a field.

AR_COND_OP_MAX

public static final int AR_COND_OP_MAX
Indicates the number of currently used possible values (which is 5).
Constructor Detail

QualifierInfo

public QualifierInfo(int operation,
                     QualifierInfo op1,
                     QualifierInfo op2)
              throws java.lang.IllegalArgumentException
Constructor to represent operations between QualifierInfo objects
Throws:
java.lang.IllegalArgumentException - if invalid operation

QualifierInfo

public QualifierInfo(RelationalOperationInfo op1)
Constructor to allow relational operation

QualifierInfo

public QualifierInfo(QualifierFromFieldInfo fid)
Constructor to allow dynamic qualifier
Method Detail

getOperation

public int getOperation()
Returns operation used in qualification.

setOperation

public void setOperation(int op)
Sets operation used in qualification. The following operation constant values can be set:

getLeftOperand

public QualifierInfo getLeftOperand()
Returns value of left operand.

getRightOperand

public QualifierInfo getRightOperand()
Returns value of right operand.

getNotOperand

public QualifierInfo getNotOperand()
Helper function to return the operand associated in NOT operation

getRelationalOperationInfo

public RelationalOperationInfo getRelationalOperationInfo()
Helper function to return RelationalOperationInfo object

getFromFieldInfo

public QualifierFromFieldInfo getFromFieldInfo()
Returns field ID/value pair information.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self
Overrides:
clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)
Use this method for checking equality. The result is true if and only if the argument is not null, is of same type and represents the same content.
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
This method can be used to populate a hash table. Implicitly used method to test equality of objects.
Overrides:
hashCode in class java.lang.Object