com.ibm.iseries.collectionservices
Class MgtcolObjReadOptions

java.lang.Object
  |
  +--com.ibm.iseries.collectionservices.MgtcolObjReadOptions

public class MgtcolObjReadOptions
extends java.lang.Object

MgtcolObjReadOptions class represents processing parameters, passed to readData() method of MgtcolObj class.

This class does not have any methods. Its function is only to pass information in its public fields.

MgtcolObjReadOptions class is used by Collection Services to provide access to Collection Object APIs for Java programs.
For more information about Collection Object APIs, go to iSeries Information Center.

Since:
V5R2M0

Field Summary
 long length
          Specifies, how many bytes of record data should be read.
 long offset
          Offset in bytes in a record data, where read operation should begin.
 int option
          This field specifies a record positioning option.
static int READ_BY_KEY_EQUAL
          This is a constant value for option field.
static int READ_BY_KEY_GREATER_EQUAL
          This is a constant value for option field.
static int READ_BY_KEY_LESS_EQUAL
          This is a constant value for option field.
static int READ_CURRENT
          This is a constant value for option field.
static int READ_FIRST
          This is a constant value for option field.
static int READ_NEXT
          This is a constant value for option field.
 java.lang.String recKey
          Key of a record to be searched for when one of the Read Record by Key ... options was specified in option field.
 
Constructor Summary
MgtcolObjReadOptions()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

option

public int option
This field specifies a record positioning option.
Supported options are:

recKey

public java.lang.String recKey
Key of a record to be searched for when one of the Read Record by Key ... options was specified in option field.
Format of this field is "DDHHMMSS", where:

offset

public long offset
Offset in bytes in a record data, where read operation should begin.

length

public long length
Specifies, how many bytes of record data should be read.
This field can be zero - in this case API will position to the record, return record information, but will not return any record data

READ_NEXT

public static final int READ_NEXT
This is a constant value for option field.

See option field for the description of the meaning of this constant.


READ_CURRENT

public static final int READ_CURRENT
This is a constant value for option field.

See option field for the description of the meaning of this constant.


READ_FIRST

public static final int READ_FIRST
This is a constant value for option field.

See option field for the description of the meaning of this constant.


READ_BY_KEY_EQUAL

public static final int READ_BY_KEY_EQUAL
This is a constant value for option field.

See option field for the description of the meaning of this constant.


READ_BY_KEY_LESS_EQUAL

public static final int READ_BY_KEY_LESS_EQUAL
This is a constant value for option field.

See option field for the description of the meaning of this constant.


READ_BY_KEY_GREATER_EQUAL

public static final int READ_BY_KEY_GREATER_EQUAL
This is a constant value for option field.

See option field for the description of the meaning of this constant.

Constructor Detail

MgtcolObjReadOptions

public MgtcolObjReadOptions()