FairCom.CtreeDb

Class CTResultSetCriteria

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTResultSetCriteria

public class CTResultSetCriteria
extends CTBase

"Result set" criteria management class. A CTResultSetCriteria belongs to one CTResultSet, and contains information about a field criteria: Field handle, minimum value, maximum value (used only for range operators) and operator

See Also:

CTBase, CTTable, CTRecord, CTResultSet

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTResultSetCriteria() Default constructor for CTResultSetCriteria class
CTResultSetCriteria(CTField Field, java.lang.String LowValue, java.lang.String HighValue, int Operator) Constructor for CTResultSetCriteria class based on a CTField.

Method Summary

Modifier and Type	Method and Description
CTField	getField() Retrieves the CTField object for the current criteria
java.lang.String	getHighValue() Retrieves the High value for the current criteria
java.lang.String	getLowValue() Retrieves the Low value for the current criteria
int	getOperator() Retrieves the OPERATOR_TYPE for the current criteria
void	setField(CTField Field) Sets the CTField object for the current criteria
void	setHighValue(java.lang.String HighValue) Sets the High value for the current criteria
void	setLowValue(java.lang.String LowValue) Sets the Low value for the current criteria
void	setOperator(int Operator) Sets the OPERATOR_TYPE for the current criteria

Methods inherited from class FairCom.CtreeDb.CTBase

Abort, Begin, ClearSavePoint, Commit, GetAutoCommit, GetHandle, GetKeepLock, GetLockMode, GetOperation, GetTransactionMode, IsLockActive, IsTransActive, IsUnicodeLib, Lock, PrepareCommit, RestoreSavePoint, SetAutoCommit, SetHandle, SetKeepLock, SetOperation, SetSavePoint, SetTransactionMode, Unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

CTResultSetCriteria

public CTResultSetCriteria(CTField Field,
                           java.lang.String LowValue,
                           java.lang.String HighValue,
                           int Operator)
                    throws CTException

Constructor for CTResultSetCriteria class based on a CTField.

Parameters:

Field - Existing CTField handle

LowValue - Minimum data value for the criteria

HighValue - Maximum data value for the criteria

Operator - OPERATOR_TYPE to be used in the criteria

Throws:

CTException - in case of error

CTResultSetCriteria

public CTResultSetCriteria()
                    throws CTException

Default constructor for CTResultSetCriteria class

Throws:

CTException - in case of error

Method Detail

getField

public CTField getField()

Retrieves the CTField object for the current criteria

Returns:

Current CTField object

See Also:

setField(FairCom.CtreeDb.CTField), getHighValue(), getLowValue(), getOperator()

getHighValue

public java.lang.String getHighValue()

Retrieves the High value for the current criteria

Returns:

High value criteria

See Also:

setHighValue(java.lang.String), getField(), getLowValue(), getOperator()

getLowValue

public java.lang.String getLowValue()

Retrieves the Low value for the current criteria

Returns:

Low value criteria

See Also:

setLowValue(java.lang.String), getField(), getHighValue(), getOperator()

getOperator

public int getOperator()

Retrieves the OPERATOR_TYPE for the current criteria

Returns:

Current OPERATOR_TYPE value

See Also:

setOperator(int), getField(), getHighValue(), getLowValue()

setField

public void setField(CTField Field)
              throws CTException

Sets the CTField object for the current criteria

Parameters:

Field - New CTField object

Throws:

CTException - in case of error

See Also:

getField(), setHighValue(java.lang.String), setLowValue(java.lang.String), setOperator(int)

setHighValue

public void setHighValue(java.lang.String HighValue)
                  throws CTException

Sets the High value for the current criteria

Parameters:

HighValue - New High value

Throws:

CTException - in case of error

See Also:

getHighValue(), setField(FairCom.CtreeDb.CTField), setLowValue(java.lang.String), setOperator(int)

setLowValue

public void setLowValue(java.lang.String LowValue)
                 throws CTException

Sets the Low value for the current criteria

Parameters:

LowValue - New Low value

Throws:

CTException - in case of error

See Also:

getLowValue(), setField(FairCom.CtreeDb.CTField), setHighValue(java.lang.String), setOperator(int)

setOperator

public void setOperator(int Operator)
                 throws CTException

Sets the OPERATOR_TYPE for the current criteria

Parameters:

Operator - New OPERATOR_TYPE value

Throws:

CTException - in case of error

See Also:

getOperator(), setField(FairCom.CtreeDb.CTField), setHighValue(java.lang.String), setLowValue(java.lang.String)