com.bmc.arsys.api
Class QualifierInfo

java.lang.Object
  com.bmc.arsys.api.QualifierInfo

All Implemented Interfaces:

IARQualifierOperand, Serializable, Cloneable

public class QualifierInfo
extends Object
implements IARQualifierOperand, Cloneable, Serializable

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

Sample Code:
QualifierInfo qualInfo = null;
ARServeruser server = new ARServerUser(“User”,”pwd”,”locale”,”server”);
qualInfo = server.parseQualification(String queryString, List fieldList1, List fieldList2,int queryContext);


See Also:

Serialized Form

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()
Default Constructor

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

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
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() Returns the hash code value for this instance of the current class.
void	setLeftOperand(QualifierInfo left) Sets value of left operand.
void	setOperation(int op) Sets operation used in qualification.
void	setRightOperand(QualifierInfo right) Sets value of right operand.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

AR_COND_OP_NONE

public static final int AR_COND_OP_NONE

No qualification.

See Also:

Constant Field Values

AR_COND_OP_AND

public static final int AR_COND_OP_AND

A qualification using the AND operator.

See Also:

Constant Field Values

AR_COND_OP_OR

public static final int AR_COND_OP_OR

A qualification using the OR operator.

See Also:

Constant Field Values

AR_COND_OP_NOT

public static final int AR_COND_OP_NOT

A qualification using the NOT operator.

See Also:

Constant Field Values

AR_COND_OP_REL_OP

public static final int AR_COND_OP_REL_OP

A qualification using a relational operator.

See Also:

Constant Field Values

AR_COND_OP_FROM_FIELD

public static final int AR_COND_OP_FROM_FIELD

A dynamic qualification using a value from a field.

See Also:

Constant Field Values

AR_COND_OP_MAX

public static final int AR_COND_OP_MAX

Indicates the number of currently used possible values (which is 5).

See Also:

Constant Field Values

Constructor Detail

QualifierInfo

public QualifierInfo()

Default Constructor

QualifierInfo

public QualifierInfo(int operation,
                     QualifierInfo op1,
                     QualifierInfo op2)
              throws IllegalArgumentException

Constructor to represent operations between QualifierInfo objects

Throws:

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:

• Constants.AR_COND_OP_NONE
• Constants.AR_COND_OP_AND
• Constants.AR_COND_OP_OR
• Constants.AR_COND_OP_NOT
• Constants.AR_COND_OP_REL_OP

setLeftOperand

public void setLeftOperand(QualifierInfo left)

Sets value of left operand.

setRightOperand

public void setRightOperand(QualifierInfo right)

Sets value of right operand.

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 Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object