com.ibm.websphere.rsadapter

Interface WSInteractionSpec

All Superinterfaces:
javax.resource.cci.InteractionSpec, java.io.Serializable

  1. public interface WSInteractionSpec
  2. 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:

See Also:
ResultSet, Interaction, DataStoreHelper

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
LOCKTYPE_SELECT
public Constants - d139562.13.RA
  1. static
  2. int
LOCKTYPE_SELECT_FOR_UPDATE
  1. static
  2. int
LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
  1. static
  2. int
LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Method Summary

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

Field Detail

LOCKTYPE_SELECT

  1. static final int LOCKTYPE_SELECT
public Constants - d139562.13.RA
See Also:

LOCKTYPE_SELECT_FOR_UPDATE

  1. static final int LOCKTYPE_SELECT_FOR_UPDATE
See Also:

LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS

  1. static final int LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
See Also:

LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR

  1. static final int LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
See Also:

Method Detail

addPropertyChangeListener

  1. 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

  1. 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

  1. void setFunctionName(java.lang.String name)
  2. 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

  1. 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

  1. void setInteractionVerb(int verb)
  2. 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

  1. 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

  1. void setExecutionTimeout(int milliseconds)
  2. 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

  1. 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

  1. void setFetchSize(int size)
  2. 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

  1. 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

  1. void setFetchDirection(int direction)
  2. 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

  1. 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

  1. void setMaxFieldSize(int maxSize)
  2. 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

  1. 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

  1. void setResultSetType(int resultType)
  2. 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

  1. 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

  1. void setResultSetConcurrency(int concurrency)
  2. 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

  1. 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

  1. void setFunctionSetName(java.lang.String name)
  2. 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

  1. 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

  1. void setOldRecord(javax.resource.cci.IndexedRecord oldRecord)
  2. 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

  1. 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

  1. void setChangedFieldsIndexes(boolean[] changedFields)
  2. 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

  1. 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

  1. void setDataStoreHelperName(java.lang.String dsHelperName)
  2. 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

  1. 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

  1. void setCursorName(java.lang.String cursorName)
Configures the cursor name.
Parameters:
cursorName - the cursor name.

getCursorName

  1. java.lang.String getCursorName( )
Returns the cursor name.
Returns:
the cursor name.

setPrefetchRowSize

  1. 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

  1. int getPrefetchRowSize()
Returns the prefetch row size.
Returns:
the prefetch row size.

isUpdateRequest

  1. boolean isUpdateRequest()
Indicates if the request is an update.
Returns:
true if the request is an update, otherwise false.

setUpdateRequest

  1. 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

  1. 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

  1. int getLockType()
Returns the update intent lock type constant.
Returns:
the lock type.

setAccessIntent

  1. void setAccessIntent(AccessIntent aIntent)
This method sets the AccessIntent for this InteractionSpec.
Parameters:
aIntent - the AccessIntent.
See Also:

getAccessIntent

  1. AccessIntent getAccessIntent()
Returns the AccessIntent.
Returns:
the AccessIntent.
See Also: