WSInteractionSpec (IBM WebSphere Application Server, Release 8.5)

All Superinterfaces:

javax.resource.cci.InteractionSpec, java.io.Serializable
```
public interface WSInteractionSpec
extends javax.resource.cci.InteractionSpec
```
An InteractionSpec holds properties for driving an Interaction with a backend store instance. An InteractionSpec is used by an Interaction to execute the specified function on a backend store instance. The CCI specification defines a set of standard properties for an InteractionSpec.
This WSInteractionSpec interface extends from cci.InteractionSpec. It defines all the getter and setter methods for the supported properties. The supported properties are:
- FunctionName - refers to a method in the DataStoreFunctionSet class
- InteractionVerb - the mode of interaction with the backend store instance. The corresponding int values are:
  - 0 = SYNC_SEND
  - 1 = SYNC_SEND_RECEIVE
  - 2 = SYNC_RECEIVE
- ExecutionTimeout - the number of milliseconds an Interaction waits for a backend store to execute the specified function
- FetchSize - the number of rows that are fetched from a backend store
- FetchDirection - the direction in which the rows in a result set are processed. The corresponding int values are:
  - 1000 = FETCH_FORWARD
  - 1001 = FETCH_REVERSE
  - 1002 = FETCH_UNKNOWN
- MaxFieldSize - maximum number of bytes allowed for any value in a column of a result set or a value in a record
- ResultSetType - type of the result set produced by an execution of the InteractionSpec. The corresponding int values are:
  - 1003 = TYPE_FORWARD_ONLY
  - 1004 = TYPE_SCROLL_INSENSITIVE
  - 1005 = TYPE_SCROLL_SENSITIVE
- ResultSetConcurrency - the concurrency type of the result set produced by the execution of the InteractionSpec. The concurrency int values are:
  - 1007 = CONCUR_READ_ONLY
  - 1008 = CONCUR_UPDATABLE
- FunctionSetName - the package-qualified DataAccessFunctionSet name that represents the current access EJB bean
- OldRecord - the IndexedRecord that contains the old values of an EJB instance
- ChangedFieldsIndexes - a boolean array of indexes identifying the changed fields. Each index represents a field in the Record.
- DataStoreHelperName - DataStoreHelper class name. Name must correspond to the datastore type (for example, DB2DataStoreHelper or OracleDataStoreHelper).
See Also:
ResultSet, Interaction, DataStoreHelper

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOCKTYPE_SELECT` public Constants - d139562.13.RA
`static int`	`LOCKTYPE_SELECT_FOR_UPDATE`
`static int`	`LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR`
`static int`	`LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS`

Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Add an event listener of PropertyChangeEvents.
`AccessIntent`	`getAccessIntent()` Returns the AccessIntent.
`boolean[]`	`getChangedFieldsIndexes()` This method returns a boolean array of indexes identifying the changed fields.
`java.lang.String`	`getCursorName()` Returns the cursor name.
`java.lang.String`	`getDataStoreHelperName()` This method returns the DataStoreHelper class name for this InteractionSpec.
`int`	`getExecutionTimeout()` This method returns an integer that represents the number of milliseconds an Interaction waits for a backend store to execute the specified function.
`int`	`getFetchDirection()` This method returns the direction in which the rows in a result set are processed.
`int`	`getFetchSize()` This method returns the number of rows that are fetched from a backend store when more rows are needed for a result set.
`java.lang.String`	`getFunctionName()` This method returns the function name that is used by the Interaction.execute() method to execute the specified function.
`java.lang.String`	`getFunctionSetName()` This method returns the package-qualified DataAccessFunctionSet name that represents the current access EJB bean.
`int`	`getInteractionVerb()` This method returns an integer that represents the mode of interaction with the backend store instance.
`int`	`getLockType()` Returns the update intent lock type constant.
`int`	`getMaxFieldSize()` This method returns the maximum number of bytes allowed for any value in a column of a result set or a value in a record.
`javax.resource.cci.IndexedRecord`	`getOldRecord()` This method returns the IndexedRecord that contains the old values of an EJB instance.
`int`	`getPrefetchRowSize()` Returns the prefetch row size.
`int`	`getResultSetConcurrency()` This method returns the concurrency setting of the result set produced by the execution of the InteractionSpec.
`int`	`getResultSetType()` This method returns the type of the result set produced by an execution of the InteractionSpec.
`boolean`	`isUpdateRequest()` Indicates if the request is an update.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Remove an event listener of PropertyChangeEvents.
`void`	`setAccessIntent(AccessIntent aIntent)` This method sets the AccessIntent for this InteractionSpec.
`void`	`setChangedFieldsIndexes(boolean[] changedFields)` This method sets a boolean array of indexes identifying the changed fields.
`void`	`setCursorName(java.lang.String cursorName)` Configures the cursor name.
`void`	`setDataStoreHelperName(java.lang.String dsHelperName)` This method sets the DataStoreHelper class name for this InteractionSpec.
`void`	`setExecutionTimeout(int milliseconds)` This method sets the number of milliseconds an Interaction waits for a backend store to execute the specified function.
`void`	`setFetchDirection(int direction)` This method sets the direction in which the rows in a result set are processed.
`void`	`setFetchSize(int size)` This method sets the number of rows that are fetched from a backend store when more rows are needed for a result set.
`void`	`setFunctionName(java.lang.String name)` This method sets the function name that is used by the Interaction.execute() method to execute the specified function.
`void`	`setFunctionSetName(java.lang.String name)` This method sets the package-qualified DataAccessFunctionSet name that represents the current access EJB bean.
`void`	`setInteractionVerb(int verb)` This method sets the mode of interaction with the backend store instance.
`void`	`setLockType(int locktype)` This method sets the update intent lock type in this InteractionSpec.
`void`	`setMaxFieldSize(int maxSize)` This method sets the maximum number of bytes allowed for any value in a column of a result set or a value in a record.
`void`	`setOldRecord(javax.resource.cci.IndexedRecord oldRecord)` This method sets the IndexedRecord that contains the old values of an EJB instance.
`void`	`setPrefetchRowSize(int num)` Configures the prefetch row size.
`void`	`setResultSetConcurrency(int concurrency)` This method configures the concurrency setting of the result set produced by the execution of the InteractionSpec.
`void`	`setResultSetType(int resultType)` This method sets the type of result set produced by an execution of the InteractionSpec.
`void`	`setUpdateRequest(boolean flag)` Configures an indicator of whether the request is for an update.

- Field Detail
  - LOCKTYPE_SELECT
```
static final int LOCKTYPE_SELECT
```
    public Constants - d139562.13.RA
    
    See Also:
    Constant Field Values
  - LOCKTYPE_SELECT_FOR_UPDATE
```
static final int LOCKTYPE_SELECT_FOR_UPDATE
```
    See Also:
    Constant Field Values
  - LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
```
static final int LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
```
    See Also:
    Constant Field Values
  - LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
```
static final int LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
```
    See Also:
    Constant Field Values
- Method Detail
  - addPropertyChangeListener
```
void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Add an event listener of PropertyChangeEvents. PropertyChangeEvents are fired whenever an InteractionSpec property changes.
    
    Parameters:
    listener - the event listener.
  - removePropertyChangeListener
```
void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Remove an event listener of PropertyChangeEvents. PropertyChangeEvents are fired whenever an InteractionSpec property changes.
    
    Parameters:
    listener - the event listener.
  - setFunctionName
```
void setFunctionName(java.lang.String name)
                     throws javax.resource.ResourceException
```
    This method sets the function name that is used by the Interaction.execute() method to execute the specified function. The function name refers to the method in the DataStoreFunctionSet class.
    
    Parameters:
    name - - function name that refers to a method in the DataStoreFunctionSet class
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getFunctionName
```
java.lang.String getFunctionName()
```
    This method returns the function name that is used by the Interaction.execute() method to execute the specified function. The function name refers to the method in the DataStoreFunctionSet class.
    
    Returns:
    - function name that refers to a method in the DataStoreFunctionSet class
  - setInteractionVerb
```
void setInteractionVerb(int verb)
                        throws javax.resource.ResourceException
```
    This method sets the mode of interaction with the backend store instance. The values are:
    - -- 0 = SYNC_SEND
    - -- 1 = SYNC_SEND_RECEIVE (default value)
    - -- 2 = SYNC_RECEIVE
    Refer to the J2EE Connection Architecture spec for the description of these values.
    Parameters:
    verb - - integer that represents the mode of interaction with the backend store instance
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getInteractionVerb
```
int getInteractionVerb()
```
    This method returns an integer that represents the mode of interaction with the backend store instance. The values are:
    - -- 0 = SYNC_SEND
    - -- 1 = SYNC_SEND_RECEIVE (default value)
    - -- 2 = SYNC_RECEIVE
    Refer to the J2EE Connection Architecture spec for the description of these values.
    Returns:
    - integer that represents the mode of interaction with the backend store instance
  - setExecutionTimeout
```
void setExecutionTimeout(int milliseconds)
                         throws javax.resource.ResourceException
```
    This method sets the number of milliseconds an Interaction waits for a backend store to execute the specified function. The default value of 0 stands for 'unlimited'.
    
    Parameters:
    milliseconds - - the number of milliseconds an Interaction waits for a backend store to execute the specified function
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getExecutionTimeout
```
int getExecutionTimeout()
```
    This method returns an integer that represents the number of milliseconds an Interaction waits for a backend store to execute the specified function. The default value of 0 stands for 'unlimited'.
    
    Returns:
    - the number of milliseconds an Interaction waits for a backend store to execute the specified function
  - setFetchSize
```
void setFetchSize(int size)
                  throws javax.resource.ResourceException
```
    This method sets the number of rows that are fetched from a backend store when more rows are needed for a result set. If the value is zero, then the hint is ignored. The default value is zero.
    
    Parameters:
    size - - the number of rows that are fetched from a backend store
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getFetchSize
```
int getFetchSize()
```
    This method returns the number of rows that are fetched from a backend store when more rows are needed for a result set. If the value is zero, then the hint is ignored. The default value is zero.
    
    Returns:
    - the number of rows that are fetched from a backend store
  - setFetchDirection
```
void setFetchDirection(int direction)
                       throws javax.resource.ResourceException
```
    This method sets the direction in which the rows in a result set are processed. The directions are:
    - -- 1000 = FETCH_FORWARD (default value)
    - -- 1001 = FETCH_REVERSE
    - -- 1002 = FETCH_UNKNOWN
    Parameters:
    direction - - an int value indicating the direction in which the rows in a result set are processed
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getFetchDirection
```
int getFetchDirection()
```
    This method returns the direction in which the rows in a result set are processed. The directions are:
    - -- 1000 = FETCH_FORWARD (default value)
    - -- 1001 = FETCH_REVERSE
    - -- 1002 = FETCH_UNKNOWN
    Returns:
    - an int value indicating the direction in which the rows in a result set are processed
  - setMaxFieldSize
```
void setMaxFieldSize(int maxSize)
                     throws javax.resource.ResourceException
```
    This method sets the maximum number of bytes allowed for any value in a column of a result set or a value in a record.
    
    Parameters:
    maxSize - - the maximum number of bytes allowed for any value in a column of a result set or a value in a record
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getMaxFieldSize
```
int getMaxFieldSize()
```
    This method returns the maximum number of bytes allowed for any value in a column of a result set or a value in a record.
    
    Returns:
    - the maximum number of bytes allowed for any value in a column of a result set or a value in a record
  - setResultSetType
```
void setResultSetType(int resultType)
                      throws javax.resource.ResourceException
```
    This method sets the type of result set produced by an execution of the InteractionSpec. The types are:
    - -- 1003 = TYPE_FORWARD_ONLY (default value)
    - -- 1004 = TYPE_SCROLL_INSENSITIVE
    - -- 1005 = TYPE_SCROLL_SENSITIVE
    Parameters:
    resultType - - an int value indicating the type of the result set produced by an execution of the InteractionSpec
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
    See Also:
    ResultSet
  - getResultSetType
```
int getResultSetType()
```
    This method returns the type of the result set produced by an execution of the InteractionSpec. The types are:
    - -- 1003 = TYPE_FORWARD_ONLY (default value)
    - -- 1004 = TYPE_SCROLL_INSENSITIVE
    - -- 1005 = TYPE_SCROLL_SENSITIVE
    Returns:
    - an int value indicating the type of result set produced by an execution of the InteractionSpec
    See Also:
    ResultSet
  - setResultSetConcurrency
```
void setResultSetConcurrency(int concurrency)
                             throws javax.resource.ResourceException
```
    This method configures the concurrency setting of the result set produced by the execution of the InteractionSpec. Valid concurrency values are :
    - -- 1007 = CONCUR_READ_ONLY (default value)
    - -- 1008 = CONCUR_UPDATABLE
    Parameters:
    concurrency - - the concurrency value of the result set produced by the execution of the InteractionSpec
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
    See Also:
    ResultSet
  - getResultSetConcurrency
```
int getResultSetConcurrency()
```
    This method returns the concurrency setting of the result set produced by the execution of the InteractionSpec. Valid concurrency values are :
    - -- 1007 = CONCUR_READ_ONLY (default value)
    - -- 1008 = CONCUR_UPDATABLE
    Returns:
    - the concurrency value of the result set produced by the execution of the InteractionSpec
    See Also:
    ResultSet
  - setFunctionSetName
```
void setFunctionSetName(java.lang.String name)
                        throws javax.resource.ResourceException
```
    This method sets the package-qualified DataAccessFunctionSet name that represents the current access EJB bean. This name is used to locate the correct DataAccessFunctionset object instance.
    
    Parameters:
    name - - the package-qualified DataAccessFunctionSet name that represents the current access EJB bean
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getFunctionSetName
```
java.lang.String getFunctionSetName()
```
    This method returns the package-qualified DataAccessFunctionSet name that represents the current access EJB bean. This name is used to locate the correct DataAccessFunctionset object instance.
    
    Returns:
    - the package-qualified DataAccessFunctionSet name that represents the current access EJB bean
  - setOldRecord
```
void setOldRecord(javax.resource.cci.IndexedRecord oldRecord)
                  throws javax.resource.ResourceException
```
    This method sets the IndexedRecord that contains the old values of an EJB instance. This EJB instance is used by the DataAccessFunctionSet class to get the old values of the fields to use as the over-qualified fields in a SQL statement for optimistic concurrency control support.
    
    Parameters:
    oldRecord - - the IndexedRecord that contains the old values of an EJB instance
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getOldRecord
```
javax.resource.cci.IndexedRecord getOldRecord()
```
    This method returns the IndexedRecord that contains the old values of an EJB instance. This EJB instance is used by the DataAccessFunctionSet class to get the old values of the fields to use as the over-qualified fields in a SQL statement for optimistic concurrency control support.
    
    Returns:
    - the IndexedRecord that contains the old values of an EJB instance
  - setChangedFieldsIndexes
```
void setChangedFieldsIndexes(boolean[] changedFields)
                             throws javax.resource.ResourceException
```
    This method sets a boolean array of indexes identifying the changed fields. Each index represents a field in the Record.
    
    Parameters:
    changedFields - - a boolean array of indexes identifying the changed fields
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getChangedFieldsIndexes
```
boolean[] getChangedFieldsIndexes()
```
    This method returns a boolean array of indexes identifying the changed fields. Each index represents a field in the Record.
    
    Returns:
    - a boolean array of indexes identifying the changed fields
  - setDataStoreHelperName
```
void setDataStoreHelperName(java.lang.String dsHelperName)
                            throws javax.resource.ResourceException
```
    This method sets the DataStoreHelper class name for this InteractionSpec. The name must correspond to the datastore type (for example, DB2DataStoreHelper or OracleDataStoreHelper).
    
    Parameters:
    dsHelperName - - the DataStoreHelper class name
    
    Throws:
    
    javax.resource.ResourceException - - thrown if input parameters are not properly set
  - getDataStoreHelperName
```
java.lang.String getDataStoreHelperName()
```
    This method returns the DataStoreHelper class name for this InteractionSpec. The name must correspond to the datastore type (for example, DB2DataStoreHelper or OracleDataStoreHelper).
    
    Returns:
    - the DataStoreHelper class name
  - setCursorName
```
void setCursorName(java.lang.String cursorName)
```
    Configures the cursor name.
    
    Parameters:
    cursorName - the cursor name.
  - getCursorName
```
java.lang.String getCursorName()
```
    Returns the cursor name.
    
    Returns:
    the cursor name.
  - setPrefetchRowSize
```
void setPrefetchRowSize(int num)
```
    Configures the prefetch row size. The prefetch row size is the number of rows that are prefetched from the database.
    
    Parameters:
    num - a prefetch row size.
  - getPrefetchRowSize
```
int getPrefetchRowSize()
```
    Returns the prefetch row size.
    
    Returns:
    the prefetch row size.
  - isUpdateRequest
```
boolean isUpdateRequest()
```
    Indicates if the request is an update.
    
    Returns:
    true if the request is an update, otherwise false.
  - setUpdateRequest
```
void setUpdateRequest(boolean flag)
```
    Configures an indicator of whether the request is for an update.
    
    Parameters:
    flag - indicating whether the request is for an update.
  - setLockType
```
void setLockType(int locktype)
```
    This method sets the update intent lock type in this InteractionSpec. The possible values are:
    - LOCKTYPE_SELECT
    - LOCKTYPE_SELECT_FOR_UPDATE
    - LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
    - LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
    Parameters:
    locktype - one of the above lock type constants indicating the lock type.
  - getLockType
```
int getLockType()
```
    Returns the update intent lock type constant.
    
    Returns:
    the lock type.
  - setAccessIntent
```
void setAccessIntent(AccessIntent aIntent)
```
    This method sets the AccessIntent for this InteractionSpec.
    
    Parameters:
    aIntent - the AccessIntent.
    See Also:
    AccessIntent
  - getAccessIntent
```
AccessIntent getAccessIntent()
```
    Returns the AccessIntent.
    
    Returns:
    the AccessIntent.
    See Also:
    AccessIntent

Fields inherited from interface javax.resource.cci.InteractionSpec

LOCKTYPE_SELECT

LOCKTYPE_SELECT_FOR_UPDATE

LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS

LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR

addPropertyChangeListener

removePropertyChangeListener

setFunctionName

getFunctionName

setInteractionVerb

getInteractionVerb

setExecutionTimeout

getExecutionTimeout

setFetchSize

getFetchSize

setFetchDirection

getFetchDirection

setMaxFieldSize

getMaxFieldSize

setResultSetType

getResultSetType

setResultSetConcurrency

getResultSetConcurrency

setFunctionSetName

getFunctionSetName

setOldRecord

getOldRecord

setChangedFieldsIndexes

getChangedFieldsIndexes

setDataStoreHelperName

getDataStoreHelperName

setCursorName

getCursorName

setPrefetchRowSize

getPrefetchRowSize

isUpdateRequest

setUpdateRequest

setLockType

getLockType

setAccessIntent

getAccessIntent