Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

B32476-03

oracle.toplink.eis.interactions
Class QueryStringInteraction

java.lang.Object
  extended by oracle.toplink.internal.databaseaccess.DatasourceCall
      extended by oracle.toplink.eis.interactions.EISInteraction
          extended by oracle.toplink.eis.interactions.MappedInteraction
              extended by oracle.toplink.eis.interactions.QueryStringInteraction
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, oracle.toplink.internal.databaseaccess.QueryStringCall, Call

public class QueryStringInteraction
extends MappedInteraction
implements oracle.toplink.internal.databaseaccess.QueryStringCall

Defines the specification for a call to a JCA interaction that uses a query string. This can be used for generic query translation support (i.e. VSAM, BETRIEVE, ADA, etc.) Arguments are defined in the query string through # (i.e. #EMP_ID) Translates the query string from the query arguments. Builds the input and output records.

Since:
OracleAS TopLink 10g (10.0.3)
See Also:
Serialized Form

Constructor Summary
QueryStringInteraction()
          Default constructor.
QueryStringInteraction(java.lang.String queryString)
          Construct interaction with the query string.
 
Method Summary
 java.lang.String getLogString(Accessor accessor)
          Return the string for logging purposes.
 java.lang.String getQueryString()
          Return the query string.
 void prepare(oracle.toplink.internal.sessions.AbstractSession session)
          Translate the custom query markers.
 void setQueryString(java.lang.String queryString)
          Set the query string.
 void translate(oracle.toplink.internal.sessions.AbstractRecord translationRow, oracle.toplink.internal.sessions.AbstractRecord modifyRow, oracle.toplink.internal.sessions.AbstractSession session)
          Allow the call to translate the query arguments.
 
Methods inherited from class oracle.toplink.eis.interactions.MappedInteraction
addArgument, addArgument, addArgumentValue, buildRow, createInputRecord, getArgumentNames, getInputResultPath, setInputResultPath
 
Methods inherited from class oracle.toplink.eis.interactions.EISInteraction
addOutputArgument, addOutputArgument, buildRows, createRecordElement, getArguments, getFunctionName, getInputRecordName, getInteractionSpec, getOutputArgumentNames, getOutputArguments, getOutputResultPath, getProperties, getProperty, hasArguments, hasOutputArguments, isEISInteraction, setFunctionName, setInputRecordName, setInputRow, setInteractionSpec, setOutputArgumentNames, setOutputArguments, setOutputResultPath, setProperties, setProperty, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QueryStringInteraction

public QueryStringInteraction()
Default constructor.


QueryStringInteraction

public QueryStringInteraction(java.lang.String queryString)
Construct interaction with the query string.

Method Detail

getQueryString

public java.lang.String getQueryString()
Return the query string.

Specified by:
getQueryString in interface oracle.toplink.internal.databaseaccess.QueryStringCall
Overrides:
DatasourceCall in class oracle.toplink.internal.databaseaccess.DatasourceCall

setQueryString

public void setQueryString(java.lang.String queryString)
Set the query string.

Specified by:
setQueryString in interface oracle.toplink.internal.databaseaccess.QueryStringCall
Overrides:
DatasourceCall in class oracle.toplink.internal.databaseaccess.DatasourceCall

translate

public void translate(oracle.toplink.internal.sessions.AbstractRecord translationRow,
                      oracle.toplink.internal.sessions.AbstractRecord modifyRow,
                      oracle.toplink.internal.sessions.AbstractSession session)
Allow the call to translate the query arguments.

Specified by:
translate in interface oracle.toplink.internal.databaseaccess.QueryStringCall
Overrides:
translate in class EISInteraction

prepare

public void prepare(oracle.toplink.internal.sessions.AbstractSession session)
Translate the custom query markers.

Specified by:
prepare in interface oracle.toplink.internal.databaseaccess.QueryStringCall
Overrides:
prepare in class EISInteraction

getLogString

public java.lang.String getLogString(Accessor accessor)
Return the string for logging purposes.

Specified by:
getLogString in interface Call
Overrides:
getLogString in class EISInteraction

Copyright © 1998, 2010, Oracle. All Rights Reserved.