CTRecord (JTDB Documentation)

java.lang.Object
- FairCom.CtreeDb.CTBase
- - FairCom.CtreeDb.CTRecord

```
public class CTRecord
extends CTBase
```
Deals with the record concept. The CTRecord object is the "atomic" or basic element of the database system, in the sense that it has the smallest piece of integrated information. It represents the information in the data structure defined in the table. Multiple records may belong to one table, but a record belongs to only one table. The records are several times defined as the "rows" in the tables.

See Also:
CTBase, CTTable

Field Summary
- Fields inherited from class FairCom.CtreeDb.CTBase
  m_handle

Constructor Summary

Constructors
Constructor and Description

CTRecord(CTRecord Handle)
Copy constructor for CTRecord class

CTRecord(CTTable Handle)
Constructor for CTRecord class based on a CTTable object

Constructors
Constructor and Description
`CTRecord(CTRecord Handle)` Copy constructor for CTRecord class
`CTRecord(CTTable Handle)` Constructor for CTRecord class based on a CTTable object

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`BatchLoaded()` Retrieves the number of batch records loaded into batch buffer for GET, RANGE or PHYS `BATCH_MODE` operations.
`int`	`BatchLocked()` Retrieves the number of records locked during a GET, RANGE or PHYS `BATCH_MODE` operation.
`int`	`BatchMode()` Retrieves the current `BATCH_MODE`.
`int`	`BatchTotal()` Retrieves the total number of records selected by a batch retrieval operation.
`byte[]`	`BuildTargetKey(int FindMode)` Build a target key based on data in record buffer
`void`	`Clear()` Clears the current record buffer
`void`	`ClearField(int FieldNbr)` Clears the content of a field
`void`	`ClearField(java.lang.String FieldName)` Clears the content of a field
`void`	`CndxCompile(java.lang.String expression)` Initializes and compiles a conditional expression String.
`boolean`	`CndxEval()` Evaluates a conditional expression compiled by `CndxCompile(java.lang.String)`.
`void`	`CndxFree()` Releases any resources allocated by CndxCompile.
`java.lang.String`	`CndxGetExpression()` Retrieves the conditional expression string
`boolean`	`Compare(CTRecord record)` Compares two records.
`void`	`Delete()` Deletes the current record from table
`void`	`EndBatch()` A batch operation must be terminated by calling EndBatch method.
`void`	`finalize()` Frees Record object
`boolean`	`Find(int FindMode)` Finds a record based on a given key into the record object
`boolean`	`FindRowid(long rowid, int FindMode)` Finds a record by it's rowid Value
`boolean`	`FindTarget(byte[] Value, int FindMode)` Find a record using a target than the current default index key length
`boolean`	`First()` Moves to first record in table
`void`	`FullTextSearchOff()` Turn off Full Text Search
`void`	`FullTextSearchOn(java.lang.String query)` Set the full text search criteria
`CTResultSet`	`GetActiveResultSet()` Retrieves a the active Result Set
`int`	`GetDefaultIndex()` Retrives the current record default index number
`java.lang.String`	`GetDefaultIndexName()` Retrives the current record default index name
`java.math.BigDecimal`	`GetFieldAsBigDecimal(int FieldNumber)` Retrieves the field contents as a BigDecimal value
`java.math.BigDecimal`	`GetFieldAsBigDecimal(java.lang.String FieldName)` Retrieves the field contents as a BigDecimal value
`java.lang.Boolean`	`GetFieldAsBoolean(int FieldNumber)` Retrieves the field contents as a Boolean value
`java.lang.Boolean`	`GetFieldAsBoolean(java.lang.String FieldName)` Retrieves the field contents as a Boolean value
`byte[]`	`GetFieldAsBytes(int FieldNumber)` Retrieves the field contents as a byte[] value
`byte[]`	`GetFieldAsBytes(java.lang.String FieldName)` Retrieves the field contents as a byte[] value
`java.util.Calendar`	`GetFieldAsCalendar(int FieldNumber)` Retrieves the field contents as a Calendar value
`java.util.Calendar`	`GetFieldAsCalendar(java.lang.String FieldName)` Retrieves the field contents as a Calendar value
`java.lang.Double`	`GetFieldAsDouble(int FieldNumber)` Retrieves the field contents as a Double value
`java.lang.Double`	`GetFieldAsDouble(java.lang.String FieldName)` Retrieves the field contents as a Double value
`java.lang.Float`	`GetFieldAsFloat(int FieldNumber)` Retrieves the field contents as a Float value
`java.lang.Float`	`GetFieldAsFloat(java.lang.String FieldName)` Retrieves the field contents as a Float value
`java.lang.Integer`	`GetFieldAsInt(int FieldNumber)` Retrieves the field contents as a Integer value
`java.lang.Integer`	`GetFieldAsInt(java.lang.String FieldName)` Retrieves the field contents as a Integer value
`java.lang.String`	`GetFieldAsJSON(int FieldNumber)` Retrieves the field contents as a string in JSON format
`java.lang.String`	`GetFieldAsJSON(java.lang.String FieldName)` Retrieves the field contents as a string in JSON format
`java.lang.Long`	`GetFieldAsLong(int FieldNumber)` Retrieves the field contents as a Long value
`java.lang.Long`	`GetFieldAsLong(java.lang.String FieldName)` Retrieves the field contents as a Long value
`java.lang.String`	`GetFieldAsString(int FieldNumber)` Retrieves the field contents as a String object
`java.lang.String`	`GetFieldAsString(java.lang.String FieldName)` Retrieves the field contents as a String object
`int`	`GetFieldByName(java.lang.String FieldName)` Retrieves the field number based on the field name
`int`	`GetFieldLength(int FieldNbr)` Retrieves the field actual data length
`int`	`GetFieldLength(java.lang.String FieldName)` Retrieves the field actual data length
`java.lang.String`	`GetFieldName(int FieldNumber)` Retrieves the field name based on the field number
`int`	`GetFieldOffset(int FieldNbr)` Retrieves the field offset in the current record
`int`	`GetFieldOffset(java.lang.String FieldName)` Retrieves the field offset in the current record
`int`	`GetFieldSize(int FieldNbr)` Retrieves the field defined size
`int`	`GetFieldSize(java.lang.String FieldName)` Retrieves the field defined size
`int`	`GetFieldType(int FieldNumber)` Retrieves the field type based on the field number
`int`	`GetFieldType(java.lang.String FieldName)` Retrieves the field type based on the field name
`java.lang.String`	`GetFilter()` Retrieves the current filter expression text
`FTS_ERROR_DETAIL`	`GetFullTextSearchErrorDetails()` Get detail about Full Text Search error
`CTTable`	`getParent()`
`byte[]`	`GetRecordBuffer()` Retrieves the current record buffer
`long`	`GetRecordCount()` Retrieves the number of records in the current record handle.
`long`	`GetRecordKeyPos()` Retrieves the offset of the nth record of the current index.
`int`	`GetRecordLength()` Retrieves the record length
`int`	`GetRecordLock()` Retrieves the current record lock mode
`long`	`GetRecordPos()` Retrieves the current record offset position
`long`	`GetRecordPosAtOffset(long Position)` Retrieves the offset of the nth record of the current index.
`int`	`GetRecordSize()` Retrieves the record allocated size
`long`	`GetRowid()` Retrieves the current record's rowid Value
`void`	`InsertBatch()` Inserts a new record into batch buffer maintained internally by c-treeDB.
`boolean`	`IsBatchActive()` Indicates if a batch operation is active or not.
`boolean`	`IsEdited()` Checks if a record buffer has been modified.
`boolean`	`IsFiltered()` Indicates if a filter condition is active for this record object
`boolean`	`IsFullTextSearchOn()` Indicate if Full Text Search is active on the record
`boolean`	`IsNew()` Checks if a record buffer is cleared.
`boolean`	`IsNullField(int FieldNumber)` Checks if a given field is Null for the current record
`boolean`	`IsNullField(java.lang.String FieldName)` Checks if a given field is Null for the current record
`boolean`	`IsRecordSetOn()` Indicates if record set is active or not.
`boolean`	`IsVariableField(int FieldNbr)` Indicates if a field is in the variable portion of a record
`boolean`	`IsVariableField(java.lang.String FieldName)` Indicates if a field is in the variable portion of a record
`boolean`	`JumpTo(int offset)` Jumps to the "offset"th record past the current record using the current index.
`boolean`	`Last()` Moves to last record in table
`boolean`	`Next()` Moves to next record in table
`void`	`NextBatch()` If the mode of the batch operation is one of GET, RANGE or PHYS of the `BATCH_MODE`, then it may be necessary to retrieve all records that match the batch criteria.
`boolean`	`NextInBatch()` If the mode of the batch operation is one of GET, RANGE or PHYS of the `BATCH_MODE`, then it may be necessary to retrieve all records that match the batch criteria.
`boolean`	`Prev()` Moves to previous record in table
`void`	`Read()` Rereads the current record
`void`	`RecordSetOff()` Deactivates the record set
`void`	`RecordSetOn(int siglen)` Activates the record set.
`void`	`Reset()` Resets the record to its initial condition
`void`	`SeekRecord(long offset)` Moves the record to position pointed by offset
`void`	`SetBatch(int mode)` Attempts to initiate a specified operation on a group of records with keys matching a partial key Value, an index range expression, or the entire table by physical order.
`void`	`SetBatch(int mode, int targetLen, int bufferLen)` Attempts to initiate a specified operation on a group of records with keys matching a partial key Value, an index range expression, or the entire table by physical order.
`void`	`SetDefaultFullTextIndex(int indexno)` Set the new record default Full Text index number
`void`	`SetDefaultIndex(int indexno)` Sets the new record default index number
`void`	`SetDefaultIndex(java.lang.String name)` Sets the new record default index by its name
`void`	`SetEdited(boolean flag)` Sets the changed record flag
`void`	`SetFieldAsBigDecimal(int FieldNumber, java.math.BigDecimal Value)` Sets the field contents as a BigDecimal value
`void`	`SetFieldAsBigDecimal(java.lang.String FieldName, java.math.BigDecimal Value)` Sets the field contents as a BigDecimal value
`void`	`SetFieldAsBoolean(int FieldNumber, java.lang.Boolean Value)` Sets the field contents as a boolean value
`void`	`SetFieldAsBoolean(java.lang.String FieldName, java.lang.Boolean Value)` Sets the field contents as a boolean value
`void`	`SetFieldAsBytes(int FieldNumber, byte[] arr)` Sets the field contents as a byte[] value
`void`	`SetFieldAsBytes(java.lang.String FieldName, byte[] arr)` Sets the field contents as a byte[] value
`void`	`SetFieldAsCalendar(int FieldNumber, java.util.Calendar Value)` Sets the field contents as a Calendar value
`void`	`SetFieldAsCalendar(java.lang.String FieldName, java.util.Calendar Value)` Sets the field contents as a Calendar value
`void`	`SetFieldAsDouble(int FieldNumber, java.lang.Double Value)` Sets the field contents as a Double value
`void`	`SetFieldAsDouble(java.lang.String FieldName, java.lang.Double Value)` Sets the field contents as a Double value
`void`	`SetFieldAsFloat(int FieldNumber, java.lang.Float Value)` Sets the field contents as a Float value
`void`	`SetFieldAsFloat(java.lang.String FieldName, java.lang.Float Value)` Sets the field contents as a Float value
`void`	`SetFieldAsInt(int FieldNumber, java.lang.Integer Value)` Sets the field contents as an Integer value
`void`	`SetFieldAsInt(java.lang.String FieldName, java.lang.Integer Value)` Sets the field contents as an Integer value
`void`	`SetFieldAsJSON(int FieldNumber, java.lang.String Value)` Sets the field contents as a JSON value
`void`	`SetFieldAsJSON(java.lang.String FieldName, java.lang.String Value)` Sets the field contents as a JSON value
`void`	`SetFieldAsLong(int FieldNumber, java.lang.Long Value)` Sets the field contents as a long value
`void`	`SetFieldAsLong(java.lang.String FieldName, java.lang.Long Value)` Sets the field contents as a long value
`void`	`SetFieldAsString(int FieldNumber, java.lang.String Value)` Sets the field contents as a String value
`void`	`SetFieldAsString(java.lang.String FieldName, java.lang.String Value)` Sets the field contents as a String value
`void`	`SetFilter(java.lang.String cndexpr)` Sets or clears record filter condition.
`void`	`SetNew(boolean flag)` Sets the new record flag
`void`	`SetRecordBuffer(byte[] Buffer)` Sets the current record buffer
`void`	`UnlockRecord()` Releases current record lock
`void`	`Write()` Writes the record buffer to disk

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
  - CTRecord
```
public CTRecord(CTTable Handle)
         throws CTException
```
    Constructor for CTRecord class based on a CTTable object
    
    Parameters:
    Handle - Existing CTTable handle
    
    Throws:
    
    CTException - in case of error
    See Also:
    finalize()
  - CTRecord
```
public CTRecord(CTRecord Handle)
         throws CTException
```
    Copy constructor for CTRecord class
    
    Parameters:
    Handle - Existing Record handle to be duplicated
    
    Throws:
    
    CTException - in case of error
    See Also:
    finalize()
- Method Detail
  - getParent
```
public CTTable getParent()
```
    Returns:
    the CTTable that owns this CTRecord.
  - finalize
```
public void finalize()
```
    Frees Record object
    
    Overrides:
    
    finalize in class java.lang.Object
    
    See Also:
    CTRecord(FairCom.CtreeDb.CTRecord)
  - First
```
public boolean First()
              throws CTException
```
    Moves to first record in table
    
    Returns:
    true if it has moved to the first record, otherwise false
    
    Throws:
    
    CTException - in case of error
    See Also:
    Next(), Last(), Prev(), Find(int), JumpTo(int)
  - Last
```
public boolean Last()
             throws CTException
```
    Moves to last record in table
    
    Returns:
    true if it has moved to the last record, otherwise false
    
    Throws:
    
    CTException - in case of error
    See Also:
    Next(), First(), Prev(), Find(int), JumpTo(int)
  - Next
```
public boolean Next()
             throws CTException
```
    Moves to next record in table
    
    Returns:
    true if it has moved to the next record, otherwise false
    
    Throws:
    
    CTException - in case of error
    See Also:
    Last(), First(), Prev(), Find(int), JumpTo(int)
  - Prev
```
public boolean Prev()
             throws CTException
```
    Moves to previous record in table
    
    Returns:
    true if it has moved to the previous record, otherwise false
    
    Throws:
    
    CTException - in case of error
    See Also:
    Last(), First(), Next(), Find(int), JumpTo(int)
  - Find
```
public boolean Find(int FindMode)
             throws CTException
```
    Finds a record based on a given key into the record object
    
    Parameters:
    FindMode - FIND_MODE to be used in the search
    
    Returns:
    true if record was found, otherwise false
    
    Throws:
    
    CTException - in case of error
    See Also:
    SeekRecord(long), Last(), First(), Next(), Prev(), JumpTo(int)
  - Clear
```
public void Clear()
           throws CTException
```
    Clears the current record buffer
    
    Throws:
    
    CTException - in case of error
    See Also:
    Find(int), Read(), Write()
  - Read
```
public void Read()
          throws CTException
```
    Rereads the current record
    
    Throws:
    
    CTException - in case of error
    See Also:
    Find(int), Clear(), Write()
  - Write
```
public void Write()
           throws CTException
```
    Writes the record buffer to disk
    
    Throws:
    
    CTException - in case of error
    See Also:
    Find(int), Clear(), Read()
  - Delete
```
public void Delete()
            throws CTException
```
    Deletes the current record from table
    
    Throws:
    
    CTException - in case of error
    See Also:
    Find(int), Write(), Read()
  - IsNew
```
public boolean IsNew()
```
    Checks if a record buffer is cleared. It means that if a Write() is called, an insert record will be executed.
    
    Returns:
    true if the record buffer has been cleared, otherwise false
    See Also:
    SetNew(boolean), Clear(), IsEdited()
  - IsEdited
```
public boolean IsEdited()
```
    Checks if a record buffer has been modified.
    
    Returns:
    true if the record has been modified, otherwise false
    See Also:
    SetEdited(boolean), Clear(), IsNew()
  - SetNew
```
public void SetNew(boolean flag)
            throws CTException
```
    Sets the new record flag
    
    Parameters:
    flag - true to mark the record as new. Setting it to false the record will marked as not new
    
    Throws:
    
    CTException - in case of error
    See Also:
    IsNew(), Clear(), SetEdited(boolean)
  - SetEdited
```
public void SetEdited(boolean flag)
               throws CTException
```
    Sets the changed record flag
    
    Parameters:
    flag - true to mark the record as modified, setting it to false the record edited flag will be set to false.
    
    Throws:
    
    CTException - in case of error
    See Also:
    IsEdited(), Clear(), SetNew(boolean)
  - GetDefaultIndex
```
public int GetDefaultIndex()
```
    Retrives the current record default index number
    
    Returns:
    Current default index number
    See Also:
    GetDefaultIndexName(), SetDefaultIndex(int)
  - GetDefaultIndexName
```
public java.lang.String GetDefaultIndexName()
```
    Retrives the current record default index name
    
    Returns:
    Current default index number name
    See Also:
    GetDefaultIndex(), SetDefaultIndex(int)
  - SetDefaultIndex
```
public void SetDefaultIndex(int indexno)
                     throws CTException
```
    Sets the new record default index number
    
    Parameters:
    indexno - New record default index number
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetDefaultIndexName(), GetDefaultIndex(), SetDefaultIndex(int)
  - SetDefaultIndex
```
public void SetDefaultIndex(java.lang.String name)
                     throws CTException
```
    Sets the new record default index by its name
    
    Parameters:
    name - New record default index name
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetDefaultIndexName(), GetDefaultIndex(), SetDefaultIndex(int)
  - GetRecordLength
```
public int GetRecordLength()
```
    Retrieves the record length
    
    Returns:
    Current record length
    See Also:
    GetRecordSize(), GetRecordPos(), GetRecordPosAtPercentile(int), GetRecordPosAtOffset(long)
  - GetRecordSize
```
public int GetRecordSize()
```
    Retrieves the record allocated size
    
    Returns:
    Current record size
    See Also:
    GetRecordLength(), GetRecordPos(), GetRecordPosAtPercentile(int), GetRecordPosAtOffset(long)
  - GetRecordPos
```
public long GetRecordPos()
                  throws CTException
```
    Retrieves the current record offset position
    
    Returns:
    Current record offset
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetRecordLength(), GetRecordSize(), GetRecordPosAtPercentile(int), GetRecordPosAtOffset(long), SeekRecord(long)
  - SeekRecord
```
public void SeekRecord(long offset)
                throws CTException
```
    Moves the record to position pointed by offset
    
    Parameters:
    offset - record offset position
    
    Throws:
    
    CTException - in case of error
    See Also:
    Find(int), GetRecordPos(), GetRecordPosAtPercentile(int)
  - IsNullField
```
public boolean IsNullField(java.lang.String FieldName)
                    throws CTException
```
    Checks if a given field is Null for the current record
    
    Parameters:
    FieldName - Field name to be checked
    
    Returns:
    true is field is Null, otherwise false
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsString(java.lang.String), GetFieldAsBoolean(java.lang.String), Clear(), ClearField(java.lang.String)
  - IsNullField
```
public boolean IsNullField(int FieldNumber)
```
    Checks if a given field is Null for the current record
    
    Parameters:
    FieldNumber - Field number to be checked
    
    Returns:
    true is field is Null, otherwise false
    See Also:
    GetFieldAsString(java.lang.String), GetFieldAsBoolean(java.lang.String), Clear(), ClearField(java.lang.String)
  - GetFieldName
```
public java.lang.String GetFieldName(int FieldNumber)
                              throws CTException
```
    Retrieves the field name based on the field number
    
    Parameters:
    FieldNumber - Field number to retrive its name
    
    Returns:
    Field name
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldType(java.lang.String), GetFieldByName(java.lang.String), GetFieldLength(java.lang.String), GetFieldSize(java.lang.String), GetFieldOffset(java.lang.String)
  - GetFieldType
```
public int GetFieldType(java.lang.String FieldName)
                 throws CTException
```
    Retrieves the field type based on the field name
    
    Parameters:
    FieldName - Field name to retrieve its type
    
    Returns:
    FIELD_TYPE
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldName(int), GetFieldByName(java.lang.String), GetFieldLength(java.lang.String), GetFieldSize(java.lang.String), GetFieldOffset(java.lang.String)
  - GetFieldType
```
public int GetFieldType(int FieldNumber)
                 throws CTException
```
    Retrieves the field type based on the field number
    
    Parameters:
    FieldNumber - Field number to get its type
    
    Returns:
    FIELD_TYPE
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldName(int), GetFieldByName(java.lang.String), GetFieldLength(java.lang.String), GetFieldSize(java.lang.String), GetFieldOffset(java.lang.String)
  - GetFieldAsString
```
public java.lang.String GetFieldAsString(java.lang.String FieldName)
                                  throws CTException
```
    Retrieves the field contents as a String object
    
    Parameters:
    FieldName - Field name to be retrieved.
    
    Returns:
    Field content as a String
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsString(java.lang.String, java.lang.String), GetFieldAsBigDecimal(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsLong(java.lang.String)
  - GetFieldAsString
```
public java.lang.String GetFieldAsString(int FieldNumber)
                                  throws CTException
```
    Retrieves the field contents as a String object
    
    Parameters:
    FieldNumber - Field number to be retrieved.
    
    Returns:
    Field content as a String
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsString(java.lang.String, java.lang.String), GetFieldAsBigDecimal(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsLong(java.lang.String)
  - GetFieldAsJSON
```
public java.lang.String GetFieldAsJSON(java.lang.String FieldName)
                                throws CTException
```
    Retrieves the field contents as a string in JSON format
    
    Parameters:
    FieldName - Field name to be retrieved.
    
    Returns:
    Field content as a string in JSON format
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsString(java.lang.String), SetFieldAsJSON(int, java.lang.String), SetFieldAsString(java.lang.String, java.lang.String)
  - GetFieldAsJSON
```
public java.lang.String GetFieldAsJSON(int FieldNumber)
                                throws CTException
```
    Retrieves the field contents as a string in JSON format
    
    Parameters:
    FieldNumber - Field number to be retrieved.
    
    Returns:
    Field content as a string in JSON format
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsString(java.lang.String), SetFieldAsJSON(int, java.lang.String), SetFieldAsString(java.lang.String, java.lang.String)
  - SetFieldAsBoolean
```
public void SetFieldAsBoolean(java.lang.String FieldName,
                     java.lang.Boolean Value)
                       throws CTException
```
    Sets the field contents as a boolean value
    
    Parameters:
    FieldName - Field name to be set
    Value - New boolean value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsBoolean(java.lang.String), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsLong(java.lang.String, java.lang.Long)
  - SetFieldAsBoolean
```
public void SetFieldAsBoolean(int FieldNumber,
                     java.lang.Boolean Value)
                       throws CTException
```
    Sets the field contents as a boolean value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New boolean value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsBoolean(java.lang.String), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsLong(java.lang.String, java.lang.Long)
  - SetFieldAsLong
```
public void SetFieldAsLong(java.lang.String FieldName,
                  java.lang.Long Value)
                    throws CTException
```
    Sets the field contents as a long value
    
    Parameters:
    FieldName - Field name to be set
    Value - New long value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsLong(java.lang.String), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsLong
```
public void SetFieldAsLong(int FieldNumber,
                  java.lang.Long Value)
                    throws CTException
```
    Sets the field contents as a long value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New long value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsLong(java.lang.String), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsBigDecimal
```
public void SetFieldAsBigDecimal(java.lang.String FieldName,
                        java.math.BigDecimal Value)
                          throws CTException
```
    Sets the field contents as a BigDecimal value
    
    Parameters:
    FieldName - Field name to be set
    Value - New BigDecimal value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsBigDecimal(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsBigDecimal
```
public void SetFieldAsBigDecimal(int FieldNumber,
                        java.math.BigDecimal Value)
                          throws CTException
```
    Sets the field contents as a BigDecimal value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New BigDecimal value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsBigDecimal(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsBytes
```
public void SetFieldAsBytes(java.lang.String FieldName,
                   byte[] arr)
                     throws CTException
```
    Sets the field contents as a byte[] value
    
    Parameters:
    FieldName - Field name to be set
    arr - New byte[] value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsBytes(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsBytes
```
public void SetFieldAsBytes(int FieldNumber,
                   byte[] arr)
                     throws CTException
```
    Sets the field contents as a byte[] value
    
    Parameters:
    FieldNumber - Field number to be set
    arr - New byte[] value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsBytes(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsString
```
public void SetFieldAsString(java.lang.String FieldName,
                    java.lang.String Value)
                      throws CTException
```
    Sets the field contents as a String value
    
    Parameters:
    FieldName - Field name to be set
    Value - New String value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsString(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsString
```
public void SetFieldAsString(int FieldNumber,
                    java.lang.String Value)
                      throws CTException
```
    Sets the field contents as a String value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New String value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsString(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsJSON
```
public void SetFieldAsJSON(int FieldNumber,
                  java.lang.String Value)
                    throws CTException
```
    Sets the field contents as a JSON value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New JSON value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsString(java.lang.String, java.lang.String), GetFieldAsJSON(java.lang.String), GetFieldAsString(java.lang.String)
  - SetFieldAsJSON
```
public void SetFieldAsJSON(java.lang.String FieldName,
                  java.lang.String Value)
                    throws CTException
```
    Sets the field contents as a JSON value
    
    Parameters:
    FieldName - Field name to be set
    Value - New JSON value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsString(java.lang.String, java.lang.String), GetFieldAsJSON(java.lang.String), GetFieldAsString(java.lang.String)
  - SetFieldAsInt
```
public void SetFieldAsInt(java.lang.String FieldName,
                 java.lang.Integer Value)
                   throws CTException
```
    Sets the field contents as an Integer value
    
    Parameters:
    FieldName - Field name to be set
    Value - New Integer value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsInt(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsInt
```
public void SetFieldAsInt(int FieldNumber,
                 java.lang.Integer Value)
                   throws CTException
```
    Sets the field contents as an Integer value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New Integer value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsInt(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsDouble
```
public void SetFieldAsDouble(java.lang.String FieldName,
                    java.lang.Double Value)
                      throws CTException
```
    Sets the field contents as a Double value
    
    Parameters:
    FieldName - Field name to be set
    Value - New Double value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsDouble(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsDouble
```
public void SetFieldAsDouble(int FieldNumber,
                    java.lang.Double Value)
                      throws CTException
```
    Sets the field contents as a Double value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New Double value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsDouble(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsFloat
```
public void SetFieldAsFloat(java.lang.String FieldName,
                   java.lang.Float Value)
                     throws CTException
```
    Sets the field contents as a Float value
    
    Parameters:
    FieldName - Field name to be set
    Value - New Float value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsDouble(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsFloat
```
public void SetFieldAsFloat(int FieldNumber,
                   java.lang.Float Value)
                     throws CTException
```
    Sets the field contents as a Float value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New Float value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsDouble(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsCalendar(java.lang.String, java.util.Calendar), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsCalendar
```
public void SetFieldAsCalendar(java.lang.String FieldName,
                      java.util.Calendar Value)
                        throws CTException
```
    Sets the field contents as a Calendar value
    
    Parameters:
    FieldName - Field name to be set
    Value - New Calendar value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsCalendar(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - SetFieldAsCalendar
```
public void SetFieldAsCalendar(int FieldNumber,
                      java.util.Calendar Value)
                        throws CTException
```
    Sets the field contents as a Calendar value
    
    Parameters:
    FieldNumber - Field number to be set
    Value - New Calendar value to be assigned to be field
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldAsCalendar(java.lang.String), SetFieldAsLong(java.lang.String, java.lang.Long), SetFieldAsBytes(java.lang.String, byte[]), SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), SetFieldAsDouble(java.lang.String, java.lang.Double), SetFieldAsInt(java.lang.String, java.lang.Integer), SetFieldAsString(java.lang.String, java.lang.String), SetFieldAsBoolean(java.lang.String, java.lang.Boolean)
  - GetFieldByName
```
public int GetFieldByName(java.lang.String FieldName)
                   throws CTException
```
    Retrieves the field number based on the field name
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field number
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldName(int)
  - GetFieldAsBigDecimal
```
public java.math.BigDecimal GetFieldAsBigDecimal(java.lang.String FieldName)
                                          throws CTException
```
    Retrieves the field contents as a BigDecimal value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a BigDecimal value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), GetFieldAsLong(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBoolean(java.lang.String)
  - GetFieldAsBigDecimal
```
public java.math.BigDecimal GetFieldAsBigDecimal(int FieldNumber)
                                          throws CTException
```
    Retrieves the field contents as a BigDecimal value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a BigDecimal value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsBigDecimal(java.lang.String, java.math.BigDecimal), GetFieldAsLong(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBoolean(java.lang.String)
  - GetFieldAsBoolean
```
public java.lang.Boolean GetFieldAsBoolean(java.lang.String FieldName)
                                    throws CTException
```
    Retrieves the field contents as a Boolean value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a Boolean value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsBoolean(java.lang.String, java.lang.Boolean), GetFieldAsLong(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsBoolean
```
public java.lang.Boolean GetFieldAsBoolean(int FieldNumber)
                                    throws CTException
```
    Retrieves the field contents as a Boolean value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a Boolean value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsBoolean(java.lang.String, java.lang.Boolean), GetFieldAsLong(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsBytes
```
public byte[] GetFieldAsBytes(java.lang.String FieldName)
                       throws CTException
```
    Retrieves the field contents as a byte[] value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a byte[] value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsBytes(java.lang.String, byte[]), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsBytes
```
public byte[] GetFieldAsBytes(int FieldNumber)
                       throws CTException
```
    Retrieves the field contents as a byte[] value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a byte[] value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsBytes(java.lang.String, byte[]), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetRecordBuffer
```
public byte[] GetRecordBuffer()
                       throws CTException
```
    Retrieves the current record buffer
    
    Returns:
    Record contents as byte array
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetRecordBuffer(byte[])
  - SetRecordBuffer
```
public void SetRecordBuffer(byte[] Buffer)
                     throws CTException
```
    Sets the current record buffer
    
    Parameters:
    Buffer - The new record buffer
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetRecordBuffer()
  - GetFieldAsCalendar
```
public java.util.Calendar GetFieldAsCalendar(java.lang.String FieldName)
                                      throws CTException
```
    Retrieves the field contents as a Calendar value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a Calendar value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsCalendar(java.lang.String, java.util.Calendar), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsCalendar
```
public java.util.Calendar GetFieldAsCalendar(int FieldNumber)
                                      throws CTException
```
    Retrieves the field contents as a Calendar value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a Calendar value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsCalendar(java.lang.String, java.util.Calendar), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsDouble
```
public java.lang.Double GetFieldAsDouble(java.lang.String FieldName)
                                  throws CTException
```
    Retrieves the field contents as a Double value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a Double value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsDouble(java.lang.String, java.lang.Double), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsDouble
```
public java.lang.Double GetFieldAsDouble(int FieldNumber)
                                  throws CTException
```
    Retrieves the field contents as a Double value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a Double value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsDouble(java.lang.String, java.lang.Double), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsFloat
```
public java.lang.Float GetFieldAsFloat(java.lang.String FieldName)
                                throws CTException
```
    Retrieves the field contents as a Float value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a Float value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsDouble(java.lang.String, java.lang.Double), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsFloat
```
public java.lang.Float GetFieldAsFloat(int FieldNumber)
                                throws CTException
```
    Retrieves the field contents as a Float value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a Float value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsDouble(java.lang.String, java.lang.Double), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsInt(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsInt
```
public java.lang.Integer GetFieldAsInt(java.lang.String FieldName)
                                throws CTException
```
    Retrieves the field contents as a Integer value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a Integer value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsInt(java.lang.String, java.lang.Integer), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsInt
```
public java.lang.Integer GetFieldAsInt(int FieldNumber)
                                throws CTException
```
    Retrieves the field contents as a Integer value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a Integer value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsInt(java.lang.String, java.lang.Integer), GetFieldAsLong(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsLong
```
public java.lang.Long GetFieldAsLong(java.lang.String FieldName)
                              throws CTException
```
    Retrieves the field contents as a Long value
    
    Parameters:
    FieldName - Field name to be retrieved
    
    Returns:
    Field content as a Long value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsLong(java.lang.String, java.lang.Long), GetFieldAsInt(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetFieldAsLong
```
public java.lang.Long GetFieldAsLong(int FieldNumber)
                              throws CTException
```
    Retrieves the field contents as a Long value
    
    Parameters:
    FieldNumber - Field number to be retrieved
    
    Returns:
    Field content as a Long value
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetFieldAsLong(java.lang.String, java.lang.Long), GetFieldAsInt(java.lang.String), GetFieldAsBoolean(java.lang.String), GetFieldAsBytes(java.lang.String), GetFieldAsCalendar(java.lang.String), GetFieldAsDouble(java.lang.String), GetFieldAsString(java.lang.String), GetFieldAsBigDecimal(java.lang.String)
  - GetRecordCount
```
public long GetRecordCount()
                    throws CTException
```
    Retrieves the number of records in the current record handle.
    
    Returns:
    Total number of records
    
    Throws:
    
    CTException - in case of error
    See Also:
    Write(), Delete()
  - RecordSetOn
```
public void RecordSetOn(int siglen)
                 throws CTException
```
    Activates the record set.
    
    Parameters:
    siglen - Number of key bytes.
    
    Throws:
    
    CTException - in case of error
    See Also:
    RecordSetOff(), IsRecordSetOn()
  - RecordSetOff
```
public void RecordSetOff()
                  throws CTException
```
    Deactivates the record set
    
    Throws:
    
    CTException - in case of error
    See Also:
    RecordSetOn(int), IsRecordSetOn()
  - Reset
```
public void Reset()
           throws CTException
```
    Resets the record to its initial condition
    
    Throws:
    
    CTException - in case of error
    See Also:
    Clear()
  - IsVariableField
```
public boolean IsVariableField(java.lang.String FieldName)
                        throws CTException
```
    Indicates if a field is in the variable portion of a record
    
    Parameters:
    FieldName - Field name to be checked
    
    Returns:
    true if a field is in the variable portion of a record, false otherwise
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldLength(java.lang.String), GetFieldSize(java.lang.String), GetFieldType(java.lang.String)
  - IsVariableField
```
public boolean IsVariableField(int FieldNbr)
```
    Indicates if a field is in the variable portion of a record
    
    Parameters:
    FieldNbr - Field number to be checked
    
    Returns:
    true if a field is in the variable portion of a record, false otherwise
    See Also:
    GetFieldLength(java.lang.String), GetFieldSize(java.lang.String), GetFieldType(java.lang.String)
  - GetFieldLength
```
public int GetFieldLength(java.lang.String FieldName)
                   throws CTException
```
    Retrieves the field actual data length
    
    Parameters:
    FieldName - Field name to be checked
    
    Returns:
    Field data actual length
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldSize(java.lang.String), GetFieldType(java.lang.String)
  - GetFieldLength
```
public int GetFieldLength(int FieldNbr)
```
    Retrieves the field actual data length
    
    Parameters:
    FieldNbr - Field number to be checked
    
    Returns:
    Field data actual length
    See Also:
    GetFieldSize(java.lang.String), GetFieldType(java.lang.String)
  - GetFieldSize
```
public int GetFieldSize(java.lang.String FieldName)
                 throws CTException
```
    Retrieves the field defined size
    
    Parameters:
    FieldName - Field name to be checked
    
    Returns:
    Defined field size
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldLength(java.lang.String), GetFieldType(java.lang.String)
  - GetFieldSize
```
public int GetFieldSize(int FieldNbr)
```
    Retrieves the field defined size
    
    Parameters:
    FieldNbr - Field number to be checked
    
    Returns:
    Defined field size
    See Also:
    GetFieldLength(java.lang.String), GetFieldType(java.lang.String)
  - GetFieldOffset
```
public int GetFieldOffset(java.lang.String FieldName)
                   throws CTException
```
    Retrieves the field offset in the current record
    
    Parameters:
    FieldName - Field name to be checked
    
    Returns:
    Field offset
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetFieldLength(java.lang.String), GetFieldType(java.lang.String)
  - GetFieldOffset
```
public int GetFieldOffset(int FieldNbr)
```
    Retrieves the field offset in the current record
    
    Parameters:
    FieldNbr - Field number to be checked
    
    Returns:
    Field offset
    See Also:
    GetFieldLength(java.lang.String), GetFieldType(java.lang.String)
  - ClearField
```
public void ClearField(java.lang.String FieldName)
                throws CTException
```
    Clears the content of a field
    
    Parameters:
    FieldName - Field name to be cleared
    
    Throws:
    
    CTException - in case of error
    See Also:
    Clear(), IsNullField(java.lang.String), IsNew()
  - ClearField
```
public void ClearField(int FieldNbr)
                throws CTException
```
    Clears the content of a field
    
    Parameters:
    FieldNbr - Field number to be cleared
    
    Throws:
    
    CTException - in case of error
    See Also:
    Clear(), IsNullField(java.lang.String), IsNew()
  - UnlockRecord
```
public void UnlockRecord()
                  throws CTException
```
    Releases current record lock
    
    Throws:
    
    CTException - in case of error
    See Also:
    CTBase.Lock(int), GetRecordLock()
  - GetRowid
```
public long GetRowid()
              throws CTException
```
    Retrieves the current record's rowid Value
    
    Returns:
    Current Rowid value
    
    Throws:
    
    CTException - in case of error
    See Also:
    FindRowid(long, int)
  - FindRowid
```
public boolean FindRowid(long rowid,
                int FindMode)
                  throws CTException
```
    Finds a record by it's rowid Value
    
    Parameters:
    rowid - Rowid of record you are looking for
    FindMode - FIND_MODE to be used in the search
    
    Returns:
    true if the record is found, or false if it is not
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetRowid()
  - CndxCompile
```
public void CndxCompile(java.lang.String expression)
                 throws CTException
```
    Initializes and compiles a conditional expression String.
    
    Parameters:
    expression - Conditional expression to be compiled
    
    Throws:
    
    CTException - in case of error
    See Also:
    CndxEval(), CndxFree(), CndxGetExpression()
  - CndxEval
```
public boolean CndxEval()
                 throws CTException
```
    Evaluates a conditional expression compiled by CndxCompile(java.lang.String). You can compile an expression once and run it many times.
    
    Returns:
    true if the execution was ok and the expression evaluates to true, false otherwise.
    
    Throws:
    
    CTException - in case of error
    See Also:
    CndxCompile(java.lang.String), CndxFree(), CndxGetExpression()
  - CndxFree
```
public void CndxFree()
```
    Releases any resources allocated by CndxCompile.
    
    See Also:
    CndxCompile(java.lang.String), CndxEval(), CndxGetExpression()
  - CndxGetExpression
```
public java.lang.String CndxGetExpression()
                                   throws CTException
```
    Retrieves the conditional expression string
    
    Returns:
    Conditional expression String.
    
    Throws:
    
    CTException - in case of error
    See Also:
    CndxCompile(java.lang.String), CndxEval(), CndxFree()
  - Compare
```
public boolean Compare(CTRecord record)
                throws CTException
```
    Compares two records.
    
    Parameters:
    record - Record handle to compare with
    
    Returns:
    true if both records are equal, or false if the records are different
    
    Throws:
    
    CTException - in case of error
  - IsRecordSetOn
```
public boolean IsRecordSetOn()
```
    Indicates if record set is active or not. A record set is active after a successfull call to RecordSetOn. A record set can be switched off by calling RecordSetOff.
    
    Returns:
    true if record set if active, or false if it is not active.
    See Also:
    RecordSetOn(int), RecordSetOff()
  - SetFilter
```
public void SetFilter(java.lang.String cndexpr)
               throws CTException
```
    Sets or clears record filter condition. If a filter is set, all record reads will evaluate the conditional expression against the record data. If the result is false the record is skipped. The filter condition remains in place until the table is closed or replaced by another conditional expression. Pass an empty String to switch off the current filter state.
    
    Parameters:
    cndexpr - Conditional expression used to filter the records. Pass an empty String to switch off the filter state.
    
    Throws:
    
    CTException - in case of error
    See Also:
    IsFiltered(), GetFilter()
  - IsFiltered
```
public boolean IsFiltered()
```
    Indicates if a filter condition is active for this record object
    
    Returns:
    true is there is a filter active for the current record, or false if it is not.
    See Also:
    SetFilter(java.lang.String), GetFilter()
  - GetFilter
```
public java.lang.String GetFilter()
```
    Retrieves the current filter expression text
    
    Returns:
    Current filter expression string
    See Also:
    SetFilter(java.lang.String), IsFiltered()
  - BatchLoaded
```
public int BatchLoaded()
```
    Retrieves the number of batch records loaded into batch buffer for GET, RANGE or PHYS BATCH_MODE operations. This is the number of records that are ready to be retrieved by NextBatch() method.
    
    Returns:
    Number of records ready for retrieval, or a negative number indicating an error.
    See Also:
    BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - BatchLocked
```
public int BatchLocked()
```
    Retrieves the number of records locked during a GET, RANGE or PHYS BATCH_MODE operation. If LOCK_READ or LOCK_WRITE are specified in the batch mode, BatchLocked() return the total number of records locked. If LOCK_ONE is specified, or if no LOCK_READ or LOCK_WRITE modes are not specified, BatchLocked return zero.
    
    Returns:
    Number of locked records. In case of an error, returns a negative Value.
    See Also:
    BatchLoaded(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - BatchTotal
```
public int BatchTotal()
```
    Retrieves the total number of records selected by a batch retrieval operation.
    
    Returns:
    Total number of records retrieved. If a batch operation is not active, returns 0, or in case of error, returns a negative Value.
    See Also:
    BatchLoaded(), BatchLocked(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - BatchMode
```
public int BatchMode()
```
    Retrieves the current BATCH_MODE. The batch mode is set by calling SetBatch(int) method.
    
    Returns:
    Current batch mode or NONE if no batch operation is currently active.
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - IsBatchActive
```
public boolean IsBatchActive()
```
    Indicates if a batch operation is active or not. This is equivalent to BatchMode() call returning BATCH_MODE of NONE;
    
    Returns:
    true if a batch operation is underway, otherwise return false.
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - EndBatch
```
public void EndBatch()
              throws CTException
```
    A batch operation must be terminated by calling EndBatch method. Once a batch operation is started, by calling SetBatch(int), no other batch operation is allowed to start until the current batch operation is terminated. When performing batch retrieval operations, you may cancel the batch operation before retrieving all the records by calling EndBatch. If the batch operation is a BATCH_MODE of RANGE, then you must also call RecordRangeOff to terminate the index range used for the batch operation.
    
    Throws:
    
    CTException - in case of error
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), InsertBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - InsertBatch
```
public void InsertBatch()
                 throws CTException
```
    Inserts a new record into batch buffer maintained internally by c-treeDB. When the batch buffer fills up, the group of records stored in the batch buffer are inserted into the table. If EndBatch() is called and the batch buffer still contains records, a new insert record operation is performed for the remaining records before the batch operation is terminated. For transaction controlled files, the batch insertion operation is treated as one all or nothing operation. If no explicit transaction is started, each insertion of records with will start and end its own transaction. Even if an explicit transaction is started, each insertion operation is treated independently through safe points. Note: currently, all records insertion operations will not perform any conversion of records images, key values and records position for heterogeneous client/server implementations. The following steps must be taken to perform a batch insert record operation:
    a) call SetBatch(int) function, with BATCH_MODE of INS, to insert a group of records;
    b) for each record to be inserted perform the following operations:
    i) call Clear() to clear the record buffer
    ii) for each field in the record call one of the SetFieldAs… function to set the field data
    iii) call InsertBatch() to insert the record into the batch buffer
    c) call EndBatch() to indicate that no more records will beinserted.
    
    Throws:
    
    CTException - in case of error
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), NextBatch(), NextInBatch(), SetBatch(int)
  - NextBatch
```
public void NextBatch()
               throws CTException
```
    If the mode of the batch operation is one of GET, RANGE or PHYS of the BATCH_MODE, then it may be necessary to retrieve all records that match the batch criteria. The records are retrieved by calling NextBatch method. NextBatch method retrieves the record data from the batch buffer maintained by c-treeDB's record handle. After a successful call to NextBatch function the field data can be retrieved by calling the appropriate GetFieldAs… methods.
    
    Throws:
    
    CTException - in case of error
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextInBatch(), SetBatch(int)
  - NextInBatch
```
public boolean NextInBatch()
                    throws CTException
```
    If the mode of the batch operation is one of GET, RANGE or PHYS of the BATCH_MODE, then it may be necessary to retrieve all records that match the batch criteria. The records are retrieved by calling NextInBatch method. NextInBatch method retrieve the record data from the batch buffer maintained by c-treeDB's record handle. After a successful call to NextInBatch function the field data can be retrieved by calling the appropriate GetFieldAs… methods. Notice that NextInBatch does not throw an exception when the end of the batch is reached.
    
    Returns:
    true if the batch operation was successful false otherwise
    
    Throws:
    
    CTException - in case of error
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), SetBatch(int)
  - SetBatch
```
public void SetBatch(int mode)
              throws CTException
```
    Attempts to initiate a specified operation on a group of records with keys matching a partial key Value, an index range expression, or the entire table by physical order.
    
    Parameters:
    mode - BATCH_MODE
    
    Throws:
    
    CTException - in case of error
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch()
  - SetBatch
```
public void SetBatch(int mode,
            int targetLen,
            int bufferLen)
              throws CTException
```
    Attempts to initiate a specified operation on a group of records with keys matching a partial key Value, an index range expression, or the entire table by physical order.
    
    Parameters:
    mode - BATCH_MODE
    targetLen - Specify the number of significant bytes of the partial target key when the batch mode is GET or DEL.
    bufferLen - Size of the buffer used internally by c-treeDB code to handle batch operations. A zero Value for this parameter is an indication that the default Value size should be used. The default buffer size is calculated as the size of the fixed portion of the record multiplied by 128.
    
    Throws:
    
    CTException - in case of error
    See Also:
    BatchLoaded(), BatchLocked(), BatchTotal(), BatchMode(), IsBatchActive(), EndBatch(), InsertBatch(), NextBatch(), NextInBatch()
  - GetRecordKeyPos
```
public long GetRecordKeyPos()
                     throws CTException
```
    Retrieves the offset of the nth record of the current index.
    
    Returns:
    Return record offset at a given offset
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetRecordPosAtPercentile(int), GetRecordPosAtOffset(long), SeekRecord(long)
  - GetRecordPosAtOffset
```
public long GetRecordPosAtOffset(long Position)
                          throws CTException
```
    Retrieves the offset of the nth record of the current index.
    
    Parameters:
    Position - Record position to be retrieved
    
    Returns:
    Return record offset at a given offset
    
    Throws:
    
    CTException - in case of error
    See Also:
    GetRecordPosAtPercentile(int), GetRecordPosAtOffset(long), SeekRecord(long)
  - JumpTo
```
public boolean JumpTo(int offset)
               throws CTException
```
    Jumps to the "offset"th record past the current record using the current index.
    
    Parameters:
    offset - Number of records to jump to
    
    Returns:
    true if the jump was successfull, otherwise false.
    
    Throws:
    
    CTException - in case of error
    See Also:
    SeekRecord(long), Last(), First(), Next(), Prev(), Find(int)
  - GetActiveResultSet
```
public CTResultSet GetActiveResultSet()
```
    Retrieves a the active Result Set
    
    Returns:
    Current active CTResultSet object if there is any, otherwise return Null
  - GetRecordLock
```
public int GetRecordLock()
```
    Retrieves the current record lock mode
    
    Returns:
    Current record LOCK_MODE. If FREE is returned, it indicates that no locks are currently active.
    See Also:
    CTBase.Lock(int), UnlockRecord()
  - SetDefaultFullTextIndex
```
public void SetDefaultFullTextIndex(int indexno)
                             throws CTException
```
    Set the new record default Full Text index number
    
    Parameters:
    indexno - The new record Full Text index number
    
    Throws:
    
    CTException - in case of error
    See Also:
    CTTable.GetFullTextIndexCount(), CTTable.GetFullTextIndex(java.lang.String), CTTable.GetFullTextIndex(int), CTFullTextIndex.GetNumber()
  - FullTextSearchOn
```
public void FullTextSearchOn(java.lang.String query)
                      throws CTException
```
    Set the full text search criteria
    
    Parameters:
    query - The full text search query
    
    Throws:
    
    CTException - in case of error
    See Also:
    SetDefaultFullTextIndex(int), FullTextSearchOff(), RecordSetOn(int), RecordSetOff()
  - IsFullTextSearchOn
```
public boolean IsFullTextSearchOn()
```
    Indicate if Full Text Search is active on the record
    
    Returns:
    true if a full text search is active false otherwise
    See Also:
    FullTextSearchOn(java.lang.String), FullTextSearchOff(), IsRecordSetOn()
  - FullTextSearchOff
```
public void FullTextSearchOff()
                       throws CTException
```
    Turn off Full Text Search
    
    Throws:
    
    CTException - in case of error
    See Also:
    FullTextSearchOn(java.lang.String), IsFullTextSearchOn(), RecordSetOn(int), RecordSetOff()
  - GetFullTextSearchErrorDetails
```
public FTS_ERROR_DETAIL GetFullTextSearchErrorDetails()
                                               throws CTException
```
    Get detail about Full Text Search error
    
    Returns:
    a FTS_ERROR_DETAIL object describing the error detail
    
    Throws:
    
    CTException - in case of error
    See Also:
    FTS_ERROR_DETAIL
  - FindTarget
```
public boolean FindTarget(byte[] Value,
                 int FindMode)
                   throws CTException
```
    Find a record using a target than the current default index key length
    
    Parameters:
    Value - C-Tree Plus key target. The key target must be transformed with BuildTargetKey(int) unless #define CTDB_FIND_TFRMKEY is turned on in the underlying native library. Please also note that the length of value must be major or equal of the current default key length which can be obtained calling CTIndex.GetKeyLength()
    FindMode - FIND_MODE to be used in the search
    
    Returns:
    true if the record is found
    
    Throws:
    
    CTException - in case of errors or if value is shorter
  - BuildTargetKey
```
public byte[] BuildTargetKey(int FindMode)
                      throws CTException
```
    Build a target key based on data in record buffer
    
    Parameters:
    FindMode - FIND_MODE to be used in the key generation
    
    Returns:
    a byte array containing the target key for the current record buffer
    
    Throws:
    
    CTException - in case an error happens

Class CTRecord

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

Constructor Summary

Method Summary

Methods inherited from class FairCom.CtreeDb.CTBase

Methods inherited from class java.lang.Object

Constructor Detail

CTRecord

CTRecord

Method Detail

getParent

finalize

First

Last

Next

Prev

Find

Clear

Read

Write

Delete

IsNew

IsEdited

SetNew

SetEdited

GetDefaultIndex

GetDefaultIndexName

SetDefaultIndex

SetDefaultIndex

GetRecordLength

GetRecordSize

GetRecordPos

SeekRecord

IsNullField

IsNullField

GetFieldName

GetFieldType

GetFieldType

GetFieldAsString

GetFieldAsString

GetFieldAsJSON

GetFieldAsJSON

SetFieldAsBoolean

SetFieldAsBoolean

SetFieldAsLong

SetFieldAsLong

SetFieldAsBigDecimal

SetFieldAsBigDecimal

SetFieldAsBytes

SetFieldAsBytes

SetFieldAsString

SetFieldAsString

SetFieldAsJSON

SetFieldAsJSON

SetFieldAsInt

SetFieldAsInt

SetFieldAsDouble

SetFieldAsDouble

SetFieldAsFloat

SetFieldAsFloat

SetFieldAsCalendar

SetFieldAsCalendar

GetFieldByName

GetFieldAsBigDecimal

GetFieldAsBigDecimal

GetFieldAsBoolean

GetFieldAsBoolean

GetFieldAsBytes

GetFieldAsBytes

GetRecordBuffer

SetRecordBuffer

GetFieldAsCalendar

GetFieldAsCalendar

GetFieldAsDouble

GetFieldAsDouble

GetFieldAsFloat

GetFieldAsFloat

GetFieldAsInt

GetFieldAsInt