FairCom.CtreeDb

Class CTResultSet

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTResultSet

public class CTResultSet
extends CTBase

Deals with the "result set" concept. One CTResultSet belongs to one CTTable, but can be activated to several CTRecord objects from the same CTTable. It contains one or more criteria to be used for filtering the records.

See Also:

CTBase, CTTable, CTRecord, CTResultSetCriteria

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTResultSet(CTTable Handle) Constructor for CTResultSet class based on a CTTable object.
CTResultSet(CTTable Handle, java.lang.String Name) Constructor for CTResultSet class based on a CTTable object and a given Result Set name.

Method Summary

Methods

Modifier and Type	Method and Description
void	AddCriteria(CTResultSetCriteria Handle) Adds a criteria for the current result set object
void	finalize() Frees CTResultSet object
void	RemoveCriteria(CTResultSetCriteria Handle) Removes a criteria from the current result set object
void	SetOnOff(CTRecord Handle, boolean OnOffFlag, boolean AutoSortFlag, int FindMode) Turns ON or OFF a result set criteria to a given CTRecord

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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CTResultSet

public CTResultSet(CTTable Handle,
           java.lang.String Name)
            throws CTException

Constructor for CTResultSet class based on a CTTable object and a given Result Set name.

Parameters:

Handle - Existing CTTable handle

Name - New Result Set name

Throws:

CTException - in case of error

See Also:

finalize()

CTResultSet

public CTResultSet(CTTable Handle)
            throws CTException

Constructor for CTResultSet class based on a CTTable object.

Parameters:

Handle - Existing CTTable handle

Throws:

CTException - in case of error

See Also:

finalize()

Method Detail

finalize

public void finalize()

Frees CTResultSet object

Overrides:

finalize in class java.lang.Object

See Also:

CTResultSet(FairCom.CtreeDb.CTTable)

SetOnOff

public void SetOnOff(CTRecord Handle,
            boolean OnOffFlag,
            boolean AutoSortFlag,
            int FindMode)
              throws CTException

Turns ON or OFF a result set criteria to a given CTRecord

Parameters:

Handle - Existing CTRecord handle

OnOffFlag - true for turning it ON or false for turning it OFF

AutoSortFlag - Flag indicating if it is allowed to change the current sort

FindMode - LOCATE_MODE to be used in the result set

Throws:

CTException - in case of error

See Also:

AddCriteria(FairCom.CtreeDb.CTResultSetCriteria), RemoveCriteria(FairCom.CtreeDb.CTResultSetCriteria)

AddCriteria

public void AddCriteria(CTResultSetCriteria Handle)
                 throws CTException

Adds a criteria for the current result set object

Parameters:

Handle - Existing CTResultSetCriteria handle

Throws:

CTException - in case of error

See Also:

SetOnOff(FairCom.CtreeDb.CTRecord, boolean, boolean, int), RemoveCriteria(FairCom.CtreeDb.CTResultSetCriteria)

RemoveCriteria

public void RemoveCriteria(CTResultSetCriteria Handle)
                    throws CTException

Removes a criteria from the current result set object

Parameters:

Handle - Existing CTResultSetCriteria handle

Throws:

CTException - in case of error

See Also:

SetOnOff(FairCom.CtreeDb.CTRecord, boolean, boolean, int), AddCriteria(FairCom.CtreeDb.CTResultSetCriteria)