|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
ResultSet
,
Interaction
,
DataStoreHelper
Field Summary | |
---|---|
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 | |
---|---|
com.ibm.websphere.appprofile.accessintent.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 |
setAccessIntent(com.ibm.websphere.appprofile.accessintent.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 |
public static final int LOCKTYPE_SELECT
public static final int LOCKTYPE_SELECT_FOR_UPDATE
public static final int LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
public static final int LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
Method Detail |
public void setFunctionName(java.lang.String name) throws javax.resource.ResourceException
name
- - function name that refers to a method in the
DataStoreFunctionSet class
javax.resource.ResourceException
- - thrown if input parameters are
not properly setpublic java.lang.String getFunctionName()
public void setInteractionVerb(int verb) throws javax.resource.ResourceException
Refer to the J2EE Connection Architecture spec for the description of these values.
verb
- - integer that represents the mode of interaction with
the backend store instance
javax.resource.ResourceException
- - thrown if input parameters are not
properly setpublic int getInteractionVerb()
Refer to the J2EE Connection Architecture spec for the description of these values.
public void setExecutionTimeout(int milliseconds) throws javax.resource.ResourceException
milliseconds
- - the number of milliseconds an Interaction waits
for a backend store to execute the specified function
javax.resource.ResourceException
- - thrown if input parameters are not
properly setpublic int getExecutionTimeout()
public void setFetchSize(int size) throws javax.resource.ResourceException
size
- - the number of rows that are fetched from a
backend store
javax.resource.ResourceException
- - thrown if input parameters are not
properly setpublic int getFetchSize()
public void setFetchDirection(int direction) throws javax.resource.ResourceException
direction
- - an int value indicating the direction in which the
rows in a result set are processed
javax.resource.ResourceException
- - thrown if input parameters are not
properly setpublic int getFetchDirection()
public void setMaxFieldSize(int maxSize) throws javax.resource.ResourceException
maxSize
- - the maximum number of bytes allowed for any value
in a column of a result set or a value in a record
javax.resource.ResourceException
- - thrown if input parameters are not
properly setpublic int getMaxFieldSize()
public void setResultSetType(int resultType) throws javax.resource.ResourceException
resultType
- - an int value indicating the type of the result
set produced by an execution of the InteractionSpec
javax.resource.ResourceException
- - thrown if input parameters are not
properly setResultSet
public int getResultSetType()
ResultSet
public void setResultSetConcurrency(int concurrency) throws javax.resource.ResourceException
concurrency
- - the concurrency value
of the result set produced by the execution of the
InteractionSpec
javax.resource.ResourceException
- - thrown if input parameters are
not properly setResultSet
public int getResultSetConcurrency()
ResultSet
public void setFunctionSetName(java.lang.String name) throws javax.resource.ResourceException
name
- - the package-qualified DataAccessFunctionSet name
that represents the current access EJB bean
javax.resource.ResourceException
- - thrown if input parameters are not
properly setpublic java.lang.String getFunctionSetName()
public void setOldRecord(javax.resource.cci.IndexedRecord oldRecord) throws javax.resource.ResourceException
oldRecord
- - the IndexedRecord that contains the old values
of an EJB instance
javax.resource.ResourceException
- - thrown if input parameters are
not properly setpublic javax.resource.cci.IndexedRecord getOldRecord()
public void setChangedFieldsIndexes(boolean[] changedFields) throws javax.resource.ResourceException
changedFields
- - a boolean array of indexes identifying the
changed fields
javax.resource.ResourceException
- - thrown if input parameters are
not properly setpublic boolean[] getChangedFieldsIndexes()
public void setDataStoreHelperName(java.lang.String dsHelperName) throws javax.resource.ResourceException
dsHelperName
- - the DataStoreHelper class name
javax.resource.ResourceException
- - thrown if input parameters are
not properly setpublic java.lang.String getDataStoreHelperName()
public void setCursorName(java.lang.String cursorName)
cursorName
- the cursor name.public java.lang.String getCursorName()
public void setPrefetchRowSize(int num)
num
- a prefetch row size.public int getPrefetchRowSize()
public boolean isUpdateRequest()
public void setUpdateRequest(boolean flag)
flag
- indicating whether the request is for an update.public void setLockType(int locktype)
locktype
- one of the above lock type constants indicating the lock type.public int getLockType()
public void setAccessIntent(com.ibm.websphere.appprofile.accessintent.AccessIntent aIntent)
aIntent
- the AccessIntent.AccessIntent
public com.ibm.websphere.appprofile.accessintent.AccessIntent getAccessIntent()
AccessIntent
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |