com.ibm.iseries.collectionservices
Class MgtcolObjAttributes

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

public class MgtcolObjAttributes
extends java.lang.Object

MgctolObjAttributes class represents attributes of a Management Collection Object and its repositories as returned by rtvAttributes() method of MgtcolObj class.

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

MgtcolObjAttributes 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
 int dftInterval
          Default collection interval in seconds for this collection object.
 byte isActive
          Indicates whether collection is in progress for this collection object.
 byte isRepaired
          Indicates whether collection object required repair.
 java.lang.String logicalPSN
          Logical serial number of a system partition, where collection object was created.
 int repositoryCount
          Number of repositories found in this Management Collection Object.
 MgtcolObjRepositoryEntry[] repositoryInfo
          This array contains an entry for every repository found in a Management Collection Object.
 int retentionPeriod
          Number of hours collection object should be kept on system, before it will be automatically deleted.
 long size
          Size of the Management Collection Object in Kbytes (K = 1024).
static byte SUMMARY_FAILED
          This is a constant value for sumStatus field.
static byte SUMMARY_IN_PROGRESS
          This is a constant value for sumStatus field.
static byte SUMMARY_NOT_RUN
          This is a constant value for sumStatus field.
static byte SUMMARY_OK
          This is a constant value for sumStatus field.
 byte sumStatus
          This field indicates a status of summarization process for this object.
 java.lang.String timeCreated
          Date and time, when collection object was created.
 java.lang.String timeUpdated
          Date and time when last update to collection object data occurred.
 
Constructor Summary
MgtcolObjAttributes()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

size

public long size
Size of the Management Collection Object in Kbytes (K = 1024).

repositoryCount

public int repositoryCount
Number of repositories found in this Management Collection Object.

retentionPeriod

public int retentionPeriod
Number of hours collection object should be kept on system, before it will be automatically deleted. Retention period starts when collection ends for this collection object.

When collection object was set for permanent retention, retentionPeriod field is set to minus 1.


dftInterval

public int dftInterval
Default collection interval in seconds for this collection object. Individual performance categories may have different collection intervals.

timeCreated

public java.lang.String timeCreated
Date and time, when collection object was created. This is represented as YYYYMMDDHHMMSS, where:

timeUpdated

public java.lang.String timeUpdated
Date and time when last update to collection object data occurred. For collection object which is not active this is a time when collection ended to this collection object.

For the description of format of this field see timeCreated field.


logicalPSN

public java.lang.String logicalPSN
Logical serial number of a system partition, where collection object was created.

isActive

public byte isActive
Indicates whether collection is in progress for this collection object.

Possible values are:


isRepaired

public byte isRepaired
Indicates whether collection object required repair. When collection object is not correctly closed - for example, during abrupt system termination - it will be repaired, when it is touched first time after that. Such object may have corrupted data inside. Using such object may cause unpredictable results.

Possible values are:


sumStatus

public byte sumStatus
This field indicates a status of summarization process for this object. When Collection Services collector cycles Management Collection Object, summarization process is started. This process extracts performance summary information to be used for historical data analysis.

Possible values are:


repositoryInfo

public MgtcolObjRepositoryEntry[] repositoryInfo
This array contains an entry for every repository found in a Management Collection Object. See description of MgtcolObjRepositoryEntry class for details.

This array is returned only if format "MCOA0200" was requested from rtvAttributes() method. For format "MCOA0100" this field will be null.
It is also null, if Management Collection Object does not have any repositories.


SUMMARY_NOT_RUN

public static final byte SUMMARY_NOT_RUN
This is a constant value for sumStatus field.

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


SUMMARY_OK

public static final byte SUMMARY_OK
This is a constant value for sumStatus field.

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


SUMMARY_IN_PROGRESS

public static final byte SUMMARY_IN_PROGRESS
This is a constant value for sumStatus field.

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


SUMMARY_FAILED

public static final byte SUMMARY_FAILED
This is a constant value for sumStatus field.

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

Constructor Detail

MgtcolObjAttributes

public MgtcolObjAttributes()