com.ibm.jtopenlite.command.program.object

Class RetrieveUserSpace

  • java.lang.Object
    • com.ibm.jtopenlite.command.program.object.RetrieveUserSpace
  • All Implemented Interfaces:
    Program


    public class RetrieveUserSpace
    extends java.lang.Object
    implements Program
    • Constructor Summary

      Constructors 
      Constructor and Description
      RetrieveUserSpace(java.lang.String userSpaceName, java.lang.String userSpaceLibrary, int startingPosition, int lengthOfData) 
    • Constructor Detail

      • RetrieveUserSpace

        public RetrieveUserSpace(java.lang.String userSpaceName,
                         java.lang.String userSpaceLibrary,
                         int startingPosition,
                         int lengthOfData)
    >
    • Method Detail

      • getUserSpaceName

        public java.lang.String getUserSpaceName()
      • setUserSpaceName

        public void setUserSpaceName(java.lang.String name)
      • getUserSpaceLibrary

        public java.lang.String getUserSpaceLibrary()
      • setUserSpaceLibrary

        public void setUserSpaceLibrary(java.lang.String lib)
      • getStartingPosition

        public int getStartingPosition()
      • setStartingPosition

        public void setStartingPosition(int pos)
      • getLengthOfData

        public int getLengthOfData()
      • setLengthOfData

        public void setLengthOfData(int len)
      • getContents

        public byte[] getContents()
      • 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
      • 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
      • getTempDataBuffer

        public 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
      • setParameterOutputData

        public void setParameterOutputData(int parmIndex,
                                  byte[] tempData,
                                  int maxLength)
        Description copied from interface: Program
        Sets the output data for the parameter at the specified index.
        Specified by:
        setParameterOutputData 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