RetrieveSystemStatus

java.lang.Object
- com.ibm.jtopenlite.command.program.workmgmt.RetrieveSystemStatus

All Implemented Interfaces:

Program
```
public class RetrieveSystemStatus
extends java.lang.Object
implements Program
```
QWCRSSTS This class fully implements the V5R4 specification of QWCRSSTS.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`DEDICATED`
`static int`	`FORMAT_SSTS0100`
`static int`	`FORMAT_SSTS0200`
`static int`	`FORMAT_SSTS0300`
`static int`	`FORMAT_SSTS0400`
`static int`	`FORMAT_SSTS0500`
`static java.lang.String`	`SELECT_ALL`
`static java.lang.String`	`SELECT_BASE`
`static java.lang.String`	`SELECT_INTERACT`
`static java.lang.String`	`SELECT_MACHINE`
`static java.lang.String`	`SELECT_SPOOL`
`static byte`	`SHARED_CAPPED`
`static byte`	`SHARED_UNCAPPED`
`static java.lang.String`	`TYPE_SHARED`
`static java.lang.String`	`TYPE_SYSTEM`

Constructor Summary

Constructors
Constructor and Description

RetrieveSystemStatus(int format, boolean resetStatistics)

Constructors
Constructor and Description
`RetrieveSystemStatus(int format, boolean resetStatistics)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getActiveJobsInSystem()` FORMAT_SSTS0200.
`int`	`getActiveThreadsInSystem()` FORMAT_SSTS0200.
`int`	`getBatchJobsEndedWithPrinterOutputWaitingToPrint()` FORMAT_SSTS0100.
`int`	`getBatchJobsEnding()` FORMAT_SSTS0100.
`int`	`getBatchJobsHeldOnAJobQueue()` FORMAT_SSTS0100.
`int`	`getBatchJobsHeldWhileRunning()` FORMAT_SSTS0100.
`int`	`getBatchJobsOnAHeldJobQueue()` FORMAT_SSTS0100.
`int`	`getBatchJobsOnAnUnassignedJobQueue()` FORMAT_SSTS0100.
`int`	`getBatchJobsRunning()` FORMAT_SSTS0100.
`int`	`getBatchJobsWaitingForMessages()` FORMAT_SSTS0100.
`int`	`getBatchJobsWaitingToRunOrAlreadyScheduled()` FORMAT_SSTS0100.
`int`	`getBytesAvailable()`
`int`	`getBytesReturned()`
`long`	`getCurrentDateAndTime()` All formats.
`int`	`getCurrentProcessingCapacity()` FORMAT_SSTS0200.
`int`	`getCurrentUnprotectedStorageUsed()` FORMAT_SSTS0200.
`java.lang.String`	`getElapsedTime()` FORMAT_SSTS0200, FORMAT_SSTS0300.
`int`	`getJobsInSystem()` FORMAT_SSTS0200.
`int`	`getLengthOfReceiverVariable()`
`int`	`getMainStorageSize()` FORMAT_SSTS0200, FORMAT_SSTS0400.
`long`	`getMainStorageSizeLong()` FORMAT_SSTS0200, FORMAT_SSTS0400.
`int`	`getMaximumJobsInSystem()` FORMAT_SSTS0200.
`int`	`getMaximumUnprotectedStorageUsed()` FORMAT_SSTS0200.
`int`	`getMinimumBasePoolSize()` FORMAT_SSTS0400.
`int`	`getMinimumMachinePoolSize()` FORMAT_SSTS0400.
`int`	`getNumberOfParameters()` Returns the number of parameters for this program.
`int`	`getNumberOfPartitions()` FORMAT_SSTS0200.
`int`	`getNumberOfPools()` FORMAT_SSTS0300, FORMAT_SSTS0400.
`int`	`getNumberOfProcessors()` FORMAT_SSTS0200.
`int`	`getNumberOfSubsystemsAvailable()` FORMAT_SSTS0500.
`int`	`getNumberOfSubsystemsReturned()` FORMAT_SSTS0500.
`byte[]`	`getParameterInputData(int parmIndex)` Returns the input data of the parameter at the specified index.
`int`	`getParameterInputLength(int parmIndex)` Returns the input length of the parameter at the specified index.
`int`	`getParameterOutputLength(int parmIndex)` Returns the output length of the parameter at the specified index.
`int`	`getParameterType(int parmIndex)` Returns the type of parameter at the specified index.
`int`	`getPartitionIdentifier()` FORMAT_SSTS0200.
`int`	`getPercentCurrentInteractivePerformance()` FORMAT_SSTS0200.
`int`	`getPercentDBCapability()` FORMAT_SSTS0200.
`int`	`getPercentPermanent256MBSegmentsUsed()` FORMAT_SSTS0200.
`int`	`getPercentPermanent4GBSegmentsUsed()` FORMAT_SSTS0200.
`int`	`getPercentPermanentAddresses()` FORMAT_SSTS0200.
`int`	`getPercentProcessingUnitUsed()` FORMAT_SSTS0200.
`int`	`getPercentSharedProcessorPoolUsed()` FORMAT_SSTS0200.
`int`	`getPercentSystemASPUsed()` FORMAT_SSTS0200.
`int`	`getPercentTemporary256MBSegmentsUsed()` FORMAT_SSTS0200.
`int`	`getPercentTemporary4GBSegmentsUsed()` FORMAT_SSTS0200.
`int`	`getPercentTemporaryAddresses()` FORMAT_SSTS0200.
`int`	`getPercentUncappedCPUCapacityUsed()` FORMAT_SSTS0200.
`byte`	`getProcessorSharingAttribute()` FORMAT_SSTS0200.
`java.lang.String`	`getProgramLibrary()` Returns the library of the program object.
`java.lang.String`	`getProgramName()` Returns the name of the program object.
`int`	`getSystemASP()` FORMAT_SSTS0200.
`java.lang.String`	`getSystemName()` All formats.
`byte[]`	`getTempDataBuffer()` The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call.
`int`	`getTotalAuxiliaryStorage()` FORMAT_SSTS0200.
`int`	`getUsersCurrentlySignedOn()` FORMAT_SSTS0100.
`int`	`getUsersSignedOffWithPrinterOutputWaitingToPrint()` FORMAT_SSTS0100.
`int`	`getUsersSuspendedByGroupJobs()` FORMAT_SSTS0100.
`int`	`getUsersSuspendedBySystemRequest()` FORMAT_SSTS0100.
`int`	`getUsersTemporarilySignedOff()` FORMAT_SSTS0100.
`void`	`newCall()` Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
`void`	`setFormat(int format)`
`void`	`setLengthOfReceiverVariable(int length)`
`void`	`setParameterOutputData(int parmIndex, byte[] data, int maxLength)` Sets the output data for the parameter at the specified index.
`void`	`setPoolListener(RetrieveSystemStatusPoolListener listener)`
`void`	`setPoolSelectionInformation(java.lang.String typeOfPool, java.lang.String sharedPoolName, int systemPoolIdentifier)` FORMAT_SSTS0400, FORMAT_SSTS0500.
`void`	`setResetStatistics(boolean resetStatistics)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FORMAT_SSTS0100
```
public static final int FORMAT_SSTS0100
```
    See Also:
    Constant Field Values
  - FORMAT_SSTS0200
```
public static final int FORMAT_SSTS0200
```
    See Also:
    Constant Field Values
  - FORMAT_SSTS0300
```
public static final int FORMAT_SSTS0300
```
    See Also:
    Constant Field Values
  - FORMAT_SSTS0400
```
public static final int FORMAT_SSTS0400
```
    See Also:
    Constant Field Values
  - FORMAT_SSTS0500
```
public static final int FORMAT_SSTS0500
```
    See Also:
    Constant Field Values
  - DEDICATED
```
public static final byte DEDICATED
```
    See Also:
    Constant Field Values
  - SHARED_CAPPED
```
public static final byte SHARED_CAPPED
```
    See Also:
    Constant Field Values
  - SHARED_UNCAPPED
```
public static final byte SHARED_UNCAPPED
```
    See Also:
    Constant Field Values
  - TYPE_SHARED
```
public static final java.lang.String TYPE_SHARED
```
    See Also:
    Constant Field Values
  - TYPE_SYSTEM
```
public static final java.lang.String TYPE_SYSTEM
```
    See Also:
    Constant Field Values
  - SELECT_ALL
```
public static final java.lang.String SELECT_ALL
```
    See Also:
    Constant Field Values
  - SELECT_MACHINE
```
public static final java.lang.String SELECT_MACHINE
```
    See Also:
    Constant Field Values
  - SELECT_BASE
```
public static final java.lang.String SELECT_BASE
```
    See Also:
    Constant Field Values
  - SELECT_INTERACT
```
public static final java.lang.String SELECT_INTERACT
```
    See Also:
    Constant Field Values
  - SELECT_SPOOL
```
public static final java.lang.String SELECT_SPOOL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RetrieveSystemStatus
```
public RetrieveSystemStatus(int format,
                    boolean resetStatistics)
```
- Method Detail
  - getTempDataBuffer
```
public final byte[] getTempDataBuffer()
```
    Description copied from interface: Program
    
    The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call. The implementor can choose to ignore this, and simply return null. The command connection checks to see if the buffer returned by this method is not null and large enough to accommodate the output parameter size.
    
    Specified by:
    
    getTempDataBuffer in interface Program
  - getProgramName
```
public java.lang.String getProgramName()
```
    Description copied from interface: Program
    
    Returns the name of the program object.
    
    Specified by:
    
    getProgramName in interface Program
  - getProgramLibrary
```
public java.lang.String getProgramLibrary()
```
    Description copied from interface: Program
    
    Returns the library of the program object.
    
    Specified by:
    
    getProgramLibrary in interface Program
  - newCall
```
public void newCall()
```
    Description copied from interface: Program
    
    Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
    
    Specified by:
    
    newCall in interface Program
  - getNumberOfParameters
```
public int getNumberOfParameters()
```
    Description copied from interface: Program
    
    Returns the number of parameters for this program.
    
    Specified by:
    
    getNumberOfParameters in interface Program
  - setPoolListener
```
public void setPoolListener(RetrieveSystemStatusPoolListener listener)
```
  - getLengthOfReceiverVariable
```
public int getLengthOfReceiverVariable()
```
  - setLengthOfReceiverVariable
```
public void setLengthOfReceiverVariable(int length)
```
  - setFormat
```
public void setFormat(int format)
```
  - setResetStatistics
```
public void setResetStatistics(boolean resetStatistics)
```
  - getBytesAvailable
```
public int getBytesAvailable()
```
  - getBytesReturned
```
public int getBytesReturned()
```
  - getSystemName
```
public java.lang.String getSystemName()
```
    All formats.
  - getCurrentDateAndTime
```
public long getCurrentDateAndTime()
```
    All formats.
  - getUsersCurrentlySignedOn
```
public int getUsersCurrentlySignedOn()
```
    FORMAT_SSTS0100.
  - getUsersTemporarilySignedOff
```
public int getUsersTemporarilySignedOff()
```
    FORMAT_SSTS0100.
  - getUsersSuspendedBySystemRequest
```
public int getUsersSuspendedBySystemRequest()
```
    FORMAT_SSTS0100.
  - getUsersSuspendedByGroupJobs
```
public int getUsersSuspendedByGroupJobs()
```
    FORMAT_SSTS0100.
  - getUsersSignedOffWithPrinterOutputWaitingToPrint
```
public int getUsersSignedOffWithPrinterOutputWaitingToPrint()
```
    FORMAT_SSTS0100.
  - getBatchJobsWaitingForMessages
```
public int getBatchJobsWaitingForMessages()
```
    FORMAT_SSTS0100.
  - getBatchJobsRunning
```
public int getBatchJobsRunning()
```
    FORMAT_SSTS0100.
  - getBatchJobsHeldWhileRunning
```
public int getBatchJobsHeldWhileRunning()
```
    FORMAT_SSTS0100.
  - getBatchJobsEnding
```
public int getBatchJobsEnding()
```
    FORMAT_SSTS0100.
  - getBatchJobsWaitingToRunOrAlreadyScheduled
```
public int getBatchJobsWaitingToRunOrAlreadyScheduled()
```
    FORMAT_SSTS0100.
  - getBatchJobsHeldOnAJobQueue
```
public int getBatchJobsHeldOnAJobQueue()
```
    FORMAT_SSTS0100.
  - getBatchJobsOnAHeldJobQueue
```
public int getBatchJobsOnAHeldJobQueue()
```
    FORMAT_SSTS0100.
  - getBatchJobsOnAnUnassignedJobQueue
```
public int getBatchJobsOnAnUnassignedJobQueue()
```
    FORMAT_SSTS0100.
  - getBatchJobsEndedWithPrinterOutputWaitingToPrint
```
public int getBatchJobsEndedWithPrinterOutputWaitingToPrint()
```
    FORMAT_SSTS0100.
  - getElapsedTime
```
public java.lang.String getElapsedTime()
```
    FORMAT_SSTS0200, FORMAT_SSTS0300.
  - getPercentProcessingUnitUsed
```
public int getPercentProcessingUnitUsed()
```
    FORMAT_SSTS0200.
  - getJobsInSystem
```
public int getJobsInSystem()
```
    FORMAT_SSTS0200.
  - getPercentPermanentAddresses
```
public int getPercentPermanentAddresses()
```
    FORMAT_SSTS0200.
  - getPercentTemporaryAddresses
```
public int getPercentTemporaryAddresses()
```
    FORMAT_SSTS0200.
  - getSystemASP
```
public int getSystemASP()
```
    FORMAT_SSTS0200.
  - getPercentSystemASPUsed
```
public int getPercentSystemASPUsed()
```
    FORMAT_SSTS0200.
  - getTotalAuxiliaryStorage
```
public int getTotalAuxiliaryStorage()
```
    FORMAT_SSTS0200.
  - getCurrentUnprotectedStorageUsed
```
public int getCurrentUnprotectedStorageUsed()
```
    FORMAT_SSTS0200.
  - getMaximumUnprotectedStorageUsed
```
public int getMaximumUnprotectedStorageUsed()
```
    FORMAT_SSTS0200.
  - getPercentDBCapability
```
public int getPercentDBCapability()
```
    FORMAT_SSTS0200.
  - getMainStorageSize
```
public int getMainStorageSize()
```
    FORMAT_SSTS0200, FORMAT_SSTS0400.
  - getNumberOfPartitions
```
public int getNumberOfPartitions()
```
    FORMAT_SSTS0200.
  - getPartitionIdentifier
```
public int getPartitionIdentifier()
```
    FORMAT_SSTS0200.
  - getCurrentProcessingCapacity
```
public int getCurrentProcessingCapacity()
```
    FORMAT_SSTS0200.
  - getProcessorSharingAttribute
```
public byte getProcessorSharingAttribute()
```
    FORMAT_SSTS0200.
  - getNumberOfProcessors
```
public int getNumberOfProcessors()
```
    FORMAT_SSTS0200.
  - getActiveJobsInSystem
```
public int getActiveJobsInSystem()
```
    FORMAT_SSTS0200.
  - getActiveThreadsInSystem
```
public int getActiveThreadsInSystem()
```
    FORMAT_SSTS0200.
  - getMaximumJobsInSystem
```
public int getMaximumJobsInSystem()
```
    FORMAT_SSTS0200.
  - getPercentTemporary256MBSegmentsUsed
```
public int getPercentTemporary256MBSegmentsUsed()
```
    FORMAT_SSTS0200.
  - getPercentTemporary4GBSegmentsUsed
```
public int getPercentTemporary4GBSegmentsUsed()
```
    FORMAT_SSTS0200.
  - getPercentPermanent256MBSegmentsUsed
```
public int getPercentPermanent256MBSegmentsUsed()
```
    FORMAT_SSTS0200.
  - getPercentPermanent4GBSegmentsUsed
```
public int getPercentPermanent4GBSegmentsUsed()
```
    FORMAT_SSTS0200.
  - getPercentCurrentInteractivePerformance
```
public int getPercentCurrentInteractivePerformance()
```
    FORMAT_SSTS0200.
  - getPercentUncappedCPUCapacityUsed
```
public int getPercentUncappedCPUCapacityUsed()
```
    FORMAT_SSTS0200.
  - getPercentSharedProcessorPoolUsed
```
public int getPercentSharedProcessorPoolUsed()
```
    FORMAT_SSTS0200.
  - getMainStorageSizeLong
```
public long getMainStorageSizeLong()
```
    FORMAT_SSTS0200, FORMAT_SSTS0400.
  - getNumberOfPools
```
public int getNumberOfPools()
```
    FORMAT_SSTS0300, FORMAT_SSTS0400.
  - getMinimumMachinePoolSize
```
public int getMinimumMachinePoolSize()
```
    FORMAT_SSTS0400.
  - getMinimumBasePoolSize
```
public int getMinimumBasePoolSize()
```
    FORMAT_SSTS0400.
  - getNumberOfSubsystemsAvailable
```
public int getNumberOfSubsystemsAvailable()
```
    FORMAT_SSTS0500.
  - getNumberOfSubsystemsReturned
```
public int getNumberOfSubsystemsReturned()
```
    FORMAT_SSTS0500.
  - setPoolSelectionInformation
```
public void setPoolSelectionInformation(java.lang.String typeOfPool,
                               java.lang.String sharedPoolName,
                               int systemPoolIdentifier)
```
    FORMAT_SSTS0400, FORMAT_SSTS0500.
  - getParameterInputLength
```
public int getParameterInputLength(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the input length of the parameter at the specified index.
    
    Specified by:
    
    getParameterInputLength in interface Program
  - getParameterOutputLength
```
public int getParameterOutputLength(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the output length of the parameter at the specified index.
    
    Specified by:
    
    getParameterOutputLength in interface Program
  - getParameterType
```
public int getParameterType(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the type of parameter at the specified index.
    
    Specified by:
    
    getParameterType in interface Program
    
    See Also:
    Parameter
  - getParameterInputData
```
public byte[] getParameterInputData(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the input data of the parameter at the specified index.
    
    Specified by:
    
    getParameterInputData in interface Program
  - setParameterOutputData
```
public void setParameterOutputData(int parmIndex,
                          byte[] data,
                          int maxLength)
```
    Description copied from interface: Program
    
    Sets the output data for the parameter at the specified index.
    
    Specified by:
    
    setParameterOutputData in interface Program

Methods inherited from class java.lang.Object

FORMAT_SSTS0100

FORMAT_SSTS0200

FORMAT_SSTS0300

FORMAT_SSTS0400

FORMAT_SSTS0500

DEDICATED

SHARED_CAPPED

SHARED_UNCAPPED

TYPE_SHARED

TYPE_SYSTEM

SELECT_ALL

SELECT_MACHINE

SELECT_BASE

SELECT_INTERACT

SELECT_SPOOL

RetrieveSystemStatus

getTempDataBuffer

getProgramName

getProgramLibrary

newCall

getNumberOfParameters

setPoolListener

getLengthOfReceiverVariable

setLengthOfReceiverVariable

setFormat

setResetStatistics

getBytesAvailable

getBytesReturned

getSystemName

getCurrentDateAndTime

getUsersCurrentlySignedOn

getUsersTemporarilySignedOff

getUsersSuspendedBySystemRequest

getUsersSuspendedByGroupJobs

getUsersSignedOffWithPrinterOutputWaitingToPrint

getBatchJobsWaitingForMessages

getBatchJobsRunning

getBatchJobsHeldWhileRunning

getBatchJobsEnding

getBatchJobsWaitingToRunOrAlreadyScheduled

getBatchJobsHeldOnAJobQueue

getBatchJobsOnAHeldJobQueue

getBatchJobsOnAnUnassignedJobQueue

getBatchJobsEndedWithPrinterOutputWaitingToPrint

getElapsedTime

getPercentProcessingUnitUsed

getJobsInSystem

getPercentPermanentAddresses

getPercentTemporaryAddresses

getSystemASP

getPercentSystemASPUsed

getTotalAuxiliaryStorage

getCurrentUnprotectedStorageUsed

getMaximumUnprotectedStorageUsed

getPercentDBCapability

getMainStorageSize

getNumberOfPartitions

getPartitionIdentifier

getCurrentProcessingCapacity

getProcessorSharingAttribute

getNumberOfProcessors

getActiveJobsInSystem

getActiveThreadsInSystem

getMaximumJobsInSystem

getPercentTemporary256MBSegmentsUsed

getPercentTemporary4GBSegmentsUsed

getPercentPermanent256MBSegmentsUsed

getPercentPermanent4GBSegmentsUsed

getPercentCurrentInteractivePerformance

getPercentUncappedCPUCapacityUsed

getPercentSharedProcessorPoolUsed

getMainStorageSizeLong

getNumberOfPools

getMinimumMachinePoolSize

getMinimumBasePoolSize

getNumberOfSubsystemsAvailable

getNumberOfSubsystemsReturned

setPoolSelectionInformation

getParameterInputLength