com.ibm.j2ca.base
Class WBIInteractionSpec

java.lang.Object
  extended bycom.ibm.j2ca.base.WBIInteractionSpec
All Implemented Interfaces:
javax.resource.cci.InteractionSpec, java.io.Serializable

public class WBIInteractionSpec
extends java.lang.Object
implements javax.resource.cci.InteractionSpec

This class provides information to the resource adapter regarding the operation to perform on the data provided to an Interaction.execute invocation.

See Also:
Serialized Form

Field Summary
static java.lang.String APPLY_CHANGES_OP
          This is a catch-all operation that enables users to send any CUD (Create/Update/Delete) business object to the adapter and have it be processed accordingly.
static java.lang.String CREATE_OP
          The purpose of this operation is to create a new entity in the EIS that matches the data and structure of the input business object.
static java.lang.String DELETE_OP
          The purpose of this operation is to remove an existing entity from the EIS and any contained child entities.
static java.lang.String EXECUTE_OP
          This is a generic operation and its behavior is specific to the adapters that support it.
static java.lang.String RETRIEVE_ALL_OP
          This operation is akin to retrieve except that dapters should return a "batch" of records that match the values provided in the request business object.
static java.lang.String RETRIEVE_OP
          The purpose of this operation is to rebuild the complete business object hierarchy.
static java.lang.String UPDATE_OP
          The purpose of this operation is to modify an entity in the EIS so that it and any children match the data and structure of the input business object.
 
Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE
 
Constructor Summary
WBIInteractionSpec()
           
 
Method Summary
 java.lang.String getFunctionName()
          Returns the function to be performed by the adapter for the given record.
 int getMaxRecords()
          Returns the maximum number of records to be retrieved by the adapter.
 void setFunctionName(java.lang.String functionName)
          Sets the function to be performed by the adapter for the given record.
 void setMaxRecords(int maxRecords)
          Sets that maximum number of records that should be retrieved by the adapter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CREATE_OP

public static final java.lang.String CREATE_OP
The purpose of this operation is to create a new entity in the EIS that matches the data and structure of the input business object. The business object returned by this operation should accurately reflect the newly created entity in the EIS.

See Also:
Constant Field Values

UPDATE_OP

public static final java.lang.String UPDATE_OP
The purpose of this operation is to modify an entity in the EIS so that it and any children match the data and structure of the input business object.

See Also:
Constant Field Values

DELETE_OP

public static final java.lang.String DELETE_OP
The purpose of this operation is to remove an existing entity from the EIS and any contained child entities.

See Also:
Constant Field Values

RETRIEVE_OP

public static final java.lang.String RETRIEVE_OP
The purpose of this operation is to rebuild the complete business object hierarchy. The adapter ensures that the returned business object exactly matches the date and structure of the corresponding EIS entity.

See Also:
Constant Field Values

RETRIEVE_ALL_OP

public static final java.lang.String RETRIEVE_ALL_OP
This operation is akin to retrieve except that dapters should return a "batch" of records that match the values provided in the request business object. The operation always returns a result set irrespective of how many (if any) matches are found.

See Also:
Constant Field Values

EXECUTE_OP

public static final java.lang.String EXECUTE_OP
This is a generic operation and its behavior is specific to the adapters that support it. It is intended to represent the execution of a stored procedure (in a database) or its equivalent in a given EIS.

See Also:
Constant Field Values

APPLY_CHANGES_OP

public static final java.lang.String APPLY_CHANGES_OP
This is a catch-all operation that enables users to send any CUD (Create/Update/Delete) business object to the adapter and have it be processed accordingly.

See Also:
Constant Field Values
Constructor Detail

WBIInteractionSpec

public WBIInteractionSpec()
Method Detail

setFunctionName

public void setFunctionName(java.lang.String functionName)
Sets the function to be performed by the adapter for the given record.

Parameters:
functionName - The operation to be performed by the adapter.

getFunctionName

public java.lang.String getFunctionName()
Returns the function to be performed by the adapter for the given record.

Returns:
The operation to be performed by the adapter.

setMaxRecords

public void setMaxRecords(int maxRecords)
Sets that maximum number of records that should be retrieved by the adapter. This method applies only to those operations that support result sets, such as RETRIEVE_ALL_OP).

Parameters:
maxRecords - The maximum number of records to be retrieved

getMaxRecords

public int getMaxRecords()
Returns the maximum number of records to be retrieved by the adapter. This method applies only to those operations that support result sets, such as RETRIEVE_ALL_OP).

Returns:
The maximum number of records