com.ibm.jtopenlite.command

Interface Program

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getNumberOfParameters()
      Returns the number of parameters for this program.
      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.
      void newCall()
      Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
      void setParameterOutputData(int parmIndex, byte[] tempData, int maxLength)
      Sets the output data for the parameter at the specified index.
  • >
    • Method Detail

      • newCall

        void newCall()
        Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
      • getNumberOfParameters

        int getNumberOfParameters()
        Returns the number of parameters for this program.
      • getParameterInputLength

        int getParameterInputLength(int parmIndex)
        Returns the input length of the parameter at the specified index.
      • getParameterOutputLength

        int getParameterOutputLength(int parmIndex)
        Returns the output length of the parameter at the specified index.
      • getParameterType

        int getParameterType(int parmIndex)
        Returns the type of parameter at the specified index.
        See Also:
        Parameter
      • getParameterInputData

        byte[] getParameterInputData(int parmIndex)
        Returns the input data of the parameter at the specified index.
      • getTempDataBuffer

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

        void setParameterOutputData(int parmIndex,
                                  byte[] tempData,
                                  int maxLength)
        Sets the output data for the parameter at the specified index.
      • getProgramName

        java.lang.String getProgramName()
        Returns the name of the program object.
      • getProgramLibrary

        java.lang.String getProgramLibrary()
        Returns the library of the program object.