com.ibm.jtopenlite.command.program.object

Class OpenListOfObjects

java.lang.Object

com.ibm.jtopenlite.command.program.object.OpenListOfObjects

All Implemented Interfaces:

Program, OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

public class OpenListOfObjects
extends java.lang.Object
implements OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

QGYOLOBJ

Constructor Summary

Constructors

Constructor and Description
OpenListOfObjects()
OpenListOfObjects(OpenListOfObjectsFormat format, int lengthOfReceiverVariable, int numberOfRecordsToReturn, SortListener sortInformation, java.lang.String objectName, java.lang.String libraryName, java.lang.String objectType, OpenListOfObjectsAuthorityListener authorityControl, OpenListOfObjectsSelectionListener selectionControl, int[] keysToReturn)

Method Summary

Methods

Modifier and Type	Method and Description
OpenListOfObjectsFormatListener	getFormatListener() The format listener gets called by the formatter once the output data has been formatted.
OpenListOfObjectsFormat	getFormatter() The formatter is the class that handles formatting the output data for each entry in the list.
int	getLengthOfReceiverVariable()
ListInformation	getListInformation()
int	getNumberOfParameters() Returns the number of parameters for this program.
int	getNumberOfRecordsToReturn()
java.lang.String	getObjectLibrary()
java.lang.String	getObjectName()
java.lang.String	getObjectType()
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.
SortListener	getSortListener()
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.
void	newCall() Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
void	setFormatListener(OpenListOfObjectsFormatListener listener)
void	setFormatter(OpenListOfObjectsFormat formatter)
void	setLengthOfReceiverVariable(int length)
void	setNumberOfRecordsToReturn(int numberOfRecordsToReturn)
void	setObjectLibrary(java.lang.String library)
void	setObjectName(java.lang.String name)
void	setObjectType(java.lang.String type)
void	setParameterOutputData(int parmIndex, byte[] data, int maxLength) Sets the output data for the parameter at the specified index.
void	setSortListener(SortListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenListOfObjects

public OpenListOfObjects()

OpenListOfObjects

public OpenListOfObjects(OpenListOfObjectsFormat format,
                 int lengthOfReceiverVariable,
                 int numberOfRecordsToReturn,
                 SortListener sortInformation,
                 java.lang.String objectName,
                 java.lang.String libraryName,
                 java.lang.String objectType,
                 OpenListOfObjectsAuthorityListener authorityControl,
                 OpenListOfObjectsSelectionListener selectionControl,
                 int[] keysToReturn)

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

getFormatter

public OpenListOfObjectsFormat getFormatter()

Description copied from interface: OpenListProgram

The formatter is the class that handles formatting the output data for each entry in the list.

Specified by:

getFormatter in interface OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

setFormatter

public void setFormatter(OpenListOfObjectsFormat formatter)

Specified by:

setFormatter in interface OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

getFormatListener

public OpenListOfObjectsFormatListener getFormatListener()

Description copied from interface: OpenListProgram

The format listener gets called by the formatter once the output data has been formatted.

Specified by:

getFormatListener in interface OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

setFormatListener

public void setFormatListener(OpenListOfObjectsFormatListener listener)

Specified by:

setFormatListener in interface OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

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

getListInformation

public ListInformation getListInformation()

Specified by:

getListInformation in interface OpenListProgram<OpenListOfObjectsFormat,OpenListOfObjectsFormatListener>

getLengthOfReceiverVariable

public int getLengthOfReceiverVariable()

setLengthOfReceiverVariable

public void setLengthOfReceiverVariable(int length)

getNumberOfRecordsToReturn

public int getNumberOfRecordsToReturn()

setNumberOfRecordsToReturn

public void setNumberOfRecordsToReturn(int numberOfRecordsToReturn)

getSortListener

public SortListener getSortListener()

setSortListener

public void setSortListener(SortListener listener)

getObjectName

public java.lang.String getObjectName()

setObjectName

public void setObjectName(java.lang.String name)

getObjectLibrary

public java.lang.String getObjectLibrary()

setObjectLibrary

public void setObjectLibrary(java.lang.String library)

getObjectType

public java.lang.String getObjectType()

setObjectType

public void setObjectType(java.lang.String type)

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