com.ibm.websphere.batch.ilc
Interface ILProcedure
- public interface ILProcedure
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
Modifier and Type | Method and Description |
---|---|
|
getBuildCorrelator()
Returns the build correlator string associated with this
ILProcedure.
|
|
getBuildDate()
Returns the build date string associated with this
ILProcedure.
|
|
getHandle()
Get native handle to this ILProcedure.
|
|
getModuleName()
Returns the module name of this ILProcedure.
|
|
getParm(int index)
Get specified parameter from parameter list of this ILProcedure.
|
|
getParmList()
Returns the parameter list for this ILProcedure.
|
|
getProcedureName()
Returns the procedure name of this ILProcedure.
|
|
getReturnCode()
Get the return code from the last invocation of this ILProcedure.
|
|
setParm(int index,byte[] parm)
Set specified parameter in parameter list of this ILProcedure.
|
|
setParmList(byte[][] parmlist)
Sets the parameter list for this ILProcedure.
|
|
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.