com.ibm.iseries.collectionservices
Class MgtcolObjRecInfo

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

public class MgtcolObjRecInfo
extends java.lang.Object

MgtcolObjRecInfo class represents record information, returned by readData() method of MgtcolObj class.

This class does not have any methods. Its function is only to return 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 bytesReturned
          Number of bytes of data, actually returned by readData() method of MgtcolObjClass.
static int CONTROL_RECORD
          This is a constant value for recType field.
static int INTERVAL_RECORD
          This is a constant value for recType field.
 java.lang.String recKey
          Record key of a current record.
 long recLength
          Length in bytes of a current repository record.
static int RECORD_NOT_FOUND
          This is a constant value for recStatus field.
static int RECORD_OK
          This is a constant value for recStatus field.
 int recStatus
          In this field, readData() method returns result of record positioning.
 int recType
          This field indicates record type, processed by API.
static int STOP_RECORD
          This is a constant value for recType field.
 long timestamp
          This is the exact time when repository record was created.
static int UNEXPECTED_RECORD
          This is a constant value for recType field.
 
Constructor Summary
MgtcolObjRecInfo()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

recStatus

public int recStatus
In this field, readData() method returns result of record positioning.
Possible values are:

recType

public int recType
This field indicates record type, processed by API.
Following record types can be returned:

bytesReturned

public long bytesReturned
Number of bytes of data, actually returned by readData() method of MgtcolObjClass.

recKey

public java.lang.String recKey
Record key of a current record.
Format of this field is "DDHHMMSS", where:

timestamp

public long timestamp
This is the exact time when repository record was created. Time is represented in a system timestamp format. See Convert Date and Time Format (QWCCVTDT) API for details about time formats.
this field is provided for reference only

recLength

public long recLength
Length in bytes of a current repository record.

RECORD_OK

public static final int RECORD_OK
This is a constant value for recStatus field.

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


RECORD_NOT_FOUND

public static final int RECORD_NOT_FOUND
This is a constant value for recStatus field.

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


INTERVAL_RECORD

public static final int INTERVAL_RECORD
This is a constant value for recType field.

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


CONTROL_RECORD

public static final int CONTROL_RECORD
This is a constant value for recType field.

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


STOP_RECORD

public static final int STOP_RECORD
This is a constant value for recType field.

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


UNEXPECTED_RECORD

public static final int UNEXPECTED_RECORD
This is a constant value for recType field.

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

Constructor Detail

MgtcolObjRecInfo

public MgtcolObjRecInfo()