com.ibm.websphere.batch.ilc

Interface ILProcedure



  • public interface ILProcedure
    ILProcedure represents a target native procedure to be invoked through an ILContainer instance in a WAS z/OS environment. An ILProcedure encapsulates the module name, procedure name, and parameter list of a native language procedure.

    Note: the ILProcedure representation of a native procedure is that a named module contains one or more named procedures. Each procedure receives one or more input parameters and may return an optional return code.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getBuildCorrelator()
      Returns the build correlator string associated with this ILProcedure.
      java.lang.String getBuildDate()
      Returns the build date string associated with this ILProcedure.
      int getHandle()
      Get native handle to this ILProcedure.
      java.lang.String getModuleName()
      Returns the module name of this ILProcedure.
      byte[] getParm(int index)
      Get specified parameter from parameter list of this ILProcedure.
      byte[][] getParmList()
      Returns the parameter list for this ILProcedure.
      java.lang.String getProcedureName()
      Returns the procedure name of this ILProcedure.
      int getReturnCode()
      Get the return code from the last invocation of this ILProcedure.
      void setParm(int index, byte[] parm)
      Set specified parameter in parameter list of this ILProcedure.
      void setParmList(byte[][] parmlist)
      Sets the parameter list for this ILProcedure.
      void setReturnCode(int rc)
      Set the return code for this ILProcedure.
    • Method Detail

      • getBuildCorrelator

        java.lang.String getBuildCorrelator()
        Returns the build correlator string associated with this ILProcedure. This value is specified when the ILProcedure is created.
        Returns:
        build correlator string.
      • getBuildDate

        java.lang.String getBuildDate()
        Returns the build date string associated with this ILProcedure. This value is specified when the ILProcedure is created.
        Returns:
        build date string.
      • getModuleName

        java.lang.String getModuleName()
        Returns the module name of this ILProcedure. This value is specified when the ILProcedure is created.
        Returns:
        the module name of this ILProcedure.
      • getProcedureName

        java.lang.String getProcedureName()
        Returns the procedure name of this ILProcedure. This value is specified when the ILProcedure is created.
        Returns:
        the procedure name of this ILProcedure.
      • getParmList

        byte[][] getParmList()
        Returns the parameter list for this ILProcedure. The parameter list format is an array of byte arrays. Each byte array in the returned array corresponds to a positional parameter specified by the target native language procedure. Each parameter is in binary (byte) format.
        Returns:
        the parameter list from this ILProcedure.
      • setParmList

        void setParmList(byte[][] parmlist)
        Sets the parameter list for this ILProcedure. The parameter list format is an array of byte arrays. Each byte array in the returned array corresponds to a positional parameter specified by the target native language procedure. Each parameter is in binary (byte) format.
        Parameters:
        parmlist - specifies the parameter list in array of byte array format
      • getParm

        byte[] getParm(int index)
        Get specified parameter from parameter list of this ILProcedure. The parameter list format is an array of byte arrays. Each byte array in the returned array corresponds to a positional parameter specified by the target native language procedure. Each parameter is in binary (byte) format.
        Parameters:
        index - specifies parameter to get from the ILProcedure parameter list.
        Returns:
        specified parameter from ILProcedure parameter list.
      • setParm

        void setParm(int index,
                   byte[] parm)
        Set specified parameter in parameter list of this ILProcedure. The parameter list format is an array of byte arrays. Each byte array in the returned array corresponds to a positional parameter specified by the target native language procedure. Each parameter is in binary (byte) format.
        Parameters:
        index - specifies parameter to set within the ILProcedure parameter list.
        parm - specifies parameter to set in ILProcedure.
      • getHandle

        int getHandle()
        Get native handle to this ILProcedure. A setter is not supplied on the public interface.
        Returns:
        handle.
      • getReturnCode

        int getReturnCode()
        Get the return code from the last invocation of this ILProcedure. If a return code is never set, this method will always return 0.
      • setReturnCode

        void setReturnCode(int rc)
        Set the return code for this ILProcedure. This method is used by the IL container to set the return code after the IL invocation completes.
IBM WebSphere Application ServerTM
Release 9.0