RetrieveCurrentAttributes

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

All Implemented Interfaces:: Program

public class RetrieveCurrentAttributes
extends java.lang.Object
implements Program

QWCRTVCA

Field Summary

Fields
Modifier and Type Field and Description

static int FORMAT_RTVC0100

static int FORMAT_RTVC0200

static int FORMAT_RTVC0300

Fields
Modifier and Type	Field and Description
`static int`	`FORMAT_RTVC0100`
`static int`	`FORMAT_RTVC0200`
`static int`	`FORMAT_RTVC0300`

Constructor Summary

Constructors
Constructor and Description

RetrieveCurrentAttributes(int format, int lengthOfReceiverVariable, int[] attributesToReturn)

Constructors
Constructor and Description
`RetrieveCurrentAttributes(int format, int lengthOfReceiverVariable, int[] attributesToReturn)`

Method Summary

Methods
Modifier and Type	Method and Description
`int[]`	`getAttributesToReturn()`
`int`	`getBytesAvailable()`
`int`	`getBytesReturned()`
`int`	`getFormat()`
`int`	`getLengthOfReceiverVariable()`
`int`	`getNumberOfASPGroups()`
`int`	`getNumberOfAttributesReturned()`
`int`	`getNumberOfParameters()` Returns the number of parameters for this program.
`int`	`getNumberOfProductLibraries()`
`int`	`getNumberOfSystemLibraries()`
`int`	`getNumberOfUserLibraries()`
`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.
`java.lang.String`	`getProgramLibrary()` Returns the library of the program object.
`java.lang.String`	`getProgramName()` Returns the name of the program object.
`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.
`boolean`	`hasCurrentLibrary()`
`void`	`newCall()` Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
`void`	`setASPGroupListener(RetrieveCurrentAttributesASPGroupListener listener)`
`void`	`setAttributesToReturn(int[] attributesToReturn)`
`void`	`setFormat(int format)`
`void`	`setKeyDataListener(JobKeyDataListener listener)`
`void`	`setLengthOfReceiverVariable(int lengthOfReceiverVariable)`
`void`	`setLibraryListener(RetrieveCurrentAttributesLibraryListener listener)`
`void`	`setParameterOutputData(int parmIndex, byte[] data, int maxLength)` Sets the output data for the parameter at the specified index.

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

- Field Detail
  - FORMAT_RTVC0100
```
public static final int FORMAT_RTVC0100
```
    See Also:
    Constant Field Values
  - FORMAT_RTVC0200
```
public static final int FORMAT_RTVC0200
```
    See Also:
    Constant Field Values
  - FORMAT_RTVC0300
```
public static final int FORMAT_RTVC0300
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RetrieveCurrentAttributes
```
public RetrieveCurrentAttributes(int format,
                         int lengthOfReceiverVariable,
                         int[] attributesToReturn)
```
- 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
  - getNumberOfParameters
```
public int getNumberOfParameters()
```
    Description copied from interface: Program
    
    Returns the number of parameters for this program.
    
    Specified by:
    
    getNumberOfParameters 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
  - setFormat
```
public void setFormat(int format)
```
  - getFormat
```
public int getFormat()
```
  - getLengthOfReceiverVariable
```
public int getLengthOfReceiverVariable()
```
  - setLengthOfReceiverVariable
```
public void setLengthOfReceiverVariable(int lengthOfReceiverVariable)
```
  - getAttributesToReturn
```
public int[] getAttributesToReturn()
```
  - setAttributesToReturn
```
public void setAttributesToReturn(int[] attributesToReturn)
```
  - getNumberOfAttributesReturned
```
public int getNumberOfAttributesReturned()
```
  - getBytesAvailable
```
public int getBytesAvailable()
```
  - getBytesReturned
```
public int getBytesReturned()
```
  - getNumberOfSystemLibraries
```
public int getNumberOfSystemLibraries()
```
  - getNumberOfProductLibraries
```
public int getNumberOfProductLibraries()
```
  - hasCurrentLibrary
```
public boolean hasCurrentLibrary()
```
  - getNumberOfUserLibraries
```
public int getNumberOfUserLibraries()
```
  - getNumberOfASPGroups
```
public int getNumberOfASPGroups()
```
  - 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
  - setKeyDataListener
```
public void setKeyDataListener(JobKeyDataListener listener)
```
  - setLibraryListener
```
public void setLibraryListener(RetrieveCurrentAttributesLibraryListener listener)
```
  - setASPGroupListener
```
public void setASPGroupListener(RetrieveCurrentAttributesASPGroupListener listener)
```
  - 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_RTVC0100

FORMAT_RTVC0200

FORMAT_RTVC0300

RetrieveCurrentAttributes

getTempDataBuffer

getProgramName

getProgramLibrary

getNumberOfParameters

newCall

setFormat

getFormat

getLengthOfReceiverVariable

setLengthOfReceiverVariable

getAttributesToReturn

setAttributesToReturn

getNumberOfAttributesReturned

getBytesAvailable

getBytesReturned

getNumberOfSystemLibraries

getNumberOfProductLibraries

hasCurrentLibrary

getNumberOfUserLibraries

getNumberOfASPGroups

getParameterInputLength

getParameterOutputLength

getParameterType

getParameterInputData

setKeyDataListener

setLibraryListener

setASPGroupListener

setParameterOutputData