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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
option
public int option
- This field specifies a record positioning option.
Supported options are:
- 0 - Read Next Record
For this option, API will return next repository record in relation
to the last record processed by API. If no records have been read from repository yet,
the very first record will be returned. If no records follow current record in the
repository or if repository does not have any records,
API will return RECORD_NOT_FOUND record status (see MgtcolObjRecInfo class)
and position in repository will not be changed.
(this option is mapped by named constant READ_NEXT)
- 1 - Read Current Record
For this option, API will return the same record which was processed by a previous call.
This option is used when API user wants to read different parts of the same record.
If no records have been read yet from repository, API will return RECORD_NOT_FOUND
record status.
(this option is mapped by named constant READ_CURRENT)
- 2 - Read First Record
For this option, API will return the very first record in repository.
This option can be used to reposition API to start reading repository from the beginning.
If repository does not have any records, API will return RECORD_NOT_FOUND record status.
(this option is mapped by named constant READ_FIRST)
- 3 - Read Record by Key Equal
For this option, API will return record, which has a key, specified in
recKey field. If record is not found, API will return RECORD_NOT_FOUND record status
and position in repository will not be changed.
(this option is mapped by named constant READ_BY_KEY_EQUAL)
- 4 - Read Record by Key Less than or Equal
For this option, API will return the first record, which has a key less than
or equal to a key, specified in recKey field. If record is not found,
API will return RECORD_NOT_FOUND record status and position in repository
will not be changed.
(this option is mapped by named constant READ_BY_KEY_LESS_EQUAL)
- 5 - Read Record by Key Greater than or Equal
For this option, API will return the first record, which has a key greater than
or equal to a key, specified in recKey field. If record is not found,
API will return RECORD_NOT_FOUND record status and position in repository
will not be changed.
(this option is mapped by named constant READ_BY_KEY_GREATER_EQUAL)
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:
- DD - number of days from the beginning of collection
into this collection object. Day numbering starts from 0.
- HHMMSS - time in hours, minutes and seconds,
when a particular collection sample was scheduled.
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.
MgtcolObjReadOptions
public MgtcolObjReadOptions()