oracle.toplink.eis.interactions
Class EISInteraction

java.lang.Object
  oracle.toplink.internal.databaseaccess.DatasourceCall
      oracle.toplink.eis.interactions.EISInteraction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Call

Direct Known Subclasses:

IndexedInteraction, MappedInteraction

public abstract class EISInteraction
extends DatasourceCall

Defines the specification for a call to a JCA interaction. Builds the input and output records from the arguments.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

Serialized Form

Constructor Summary

EISInteraction()
Default constructor.

Method Summary

void	addOutputArgument(java.lang.String parameterAndArgumentFieldName) Define the output argument to the interaction and the field/argument name to be substitute for it.
void	addOutputArgument(java.lang.String parameterName, java.lang.String argumentFieldName) Define the output argument to the interaction and the field/argument name to be substitute for it.
java.util.Vector	buildRows(javax.resource.cci.Record record, EISAccessor accessor) Build a collection of database rows from the Record returned from the interaction.
abstract javax.resource.cci.Record	createInputRecord(EISAccessor accessor) Create the appropriate input record for this interaction.
java.lang.Object	createRecordElement(java.lang.String elementName, java.lang.Object value, EISAccessor accessor) Create the appropriate record element for the data value.
java.util.Vector	getArguments() The argument fields or values to the interaction that map into the input record.
java.lang.String	getFunctionName() Return the function name of the interaction.
java.lang.String	getInputRecordName() Return the input record name.
javax.resource.cci.InteractionSpec	getInteractionSpec() Return the JCA InteractionSpec that defines this EIS interaction.
java.lang.String	getLogString(Accessor accessor) Return the string for logging purposes.
java.util.Vector	getOutputArgumentNames() The argument names for the output record.
java.util.Vector	getOutputArguments() The argument fields to the interaction that map into the output record.
java.lang.String	getOutputResultPath() The output result path defines the root key for the MappedRecord that the desired interaction result is nested into.
java.util.Map	getProperties() Returns the adapter specific properties.
java.lang.Object	getProperty(java.lang.String name) Returns the adapter property associated the given name.
boolean	hasArguments() Return if argumented.
boolean	hasOutputArguments() Return if argumented.
void	prepare(oracle.toplink.internal.sessions.AbstractSession session) Set the default record name from the descriptor.
void	setFunctionName(java.lang.String functionName) Set the function name of the interaction.
void	setInputRecordName(java.lang.String recordName) Set the input record name.
void	setInputRow(oracle.toplink.internal.sessions.AbstractRecord inputRow) Set the input database row.
void	setInteractionSpec(javax.resource.cci.InteractionSpec interactionSpec) Set the JCA InteractionSpec that defines this EIS interaction.
void	setOutputArgumentNames(java.util.Vector outputArgumentNames) Set the output argument names.
void	setOutputArguments(java.util.Vector outputArguments) The output arguments.
void	setOutputResultPath(java.lang.String outputResultPath) The output result path defines the root key for the MappedRecord that the desired interaction result is nested into.
void	setProperties(java.util.Map properties) Set the adapter specific properties.
void	setProperty(java.lang.String name, java.lang.Object value) Set the adapter specific property.
java.lang.String	toString()
void	translate(oracle.toplink.internal.sessions.AbstractRecord translationRow, oracle.toplink.internal.sessions.AbstractRecord modifyRow, oracle.toplink.internal.sessions.AbstractSession session) Arguments to the interaction can be passed two ways.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EISInteraction

public EISInteraction()

Default constructor.

Method Detail

addOutputArgument

public void addOutputArgument(java.lang.String parameterAndArgumentFieldName)

Define the output argument to the interaction and the field/argument name to be substitute for it. This is only required if an output row is not used. The parameterAndArgumentFieldName is the name of the output record argument expected, and is the field or argument name to be used to be used for it. These names are assumed to be the same, if not this method can be called with two arguments.

addOutputArgument

public void addOutputArgument(java.lang.String parameterName,
                              java.lang.String argumentFieldName)

Define the output argument to the interaction and the field/argument name to be substitute for it. This is only required if an output row is not used. The parameterName is the name of the output record argument expected. The argumentFieldName is the field or argument name to be used to be used for it. If these names are the same (as they normally are) this method can be called with a single argument.

getArguments

public java.util.Vector getArguments()

The argument fields or values to the interaction that map into the input record.

hasArguments

public boolean hasArguments()

Return if argumented.

getOutputResultPath

public java.lang.String getOutputResultPath()

The output result path defines the root key for the MappedRecord that the desired interaction result is nested into. This is required for read interactions that need a nested record to build from the mapped object.

setOutputResultPath

public void setOutputResultPath(java.lang.String outputResultPath)

The output result path defines the root key for the MappedRecord that the desired interaction result is nested into. This is required for read interactions that need a nested record to build from the mapped object.

getOutputArgumentNames

public java.util.Vector getOutputArgumentNames()

The argument names for the output record.

getOutputArguments

public java.util.Vector getOutputArguments()

The argument fields to the interaction that map into the output record.

setOutputArguments

public void setOutputArguments(java.util.Vector outputArguments)

The output arguments.

setOutputArgumentNames

public void setOutputArgumentNames(java.util.Vector outputArgumentNames)

Set the output argument names.

hasOutputArguments

public boolean hasOutputArguments()

Return if argumented.

prepare

public void prepare(oracle.toplink.internal.sessions.AbstractSession session)

Set the default record name from the descriptor.

Overrides:

DatasourceCall in class oracle.toplink.internal.databaseaccess.DatasourceCall

createRecordElement

public java.lang.Object createRecordElement(java.lang.String elementName,
                                            java.lang.Object value,
                                            EISAccessor accessor)

Create the appropriate record element for the data value. If the value is a collection, create a collection of elements, if the value is a map, create a nested map, otherwise just return the value (primitive data).

getInteractionSpec

public javax.resource.cci.InteractionSpec getInteractionSpec()

Return the JCA InteractionSpec that defines this EIS interaction. The InteractionSpec is JCA adapter specific and typically defines the function name.

setInteractionSpec

public void setInteractionSpec(javax.resource.cci.InteractionSpec interactionSpec)

Set the JCA InteractionSpec that defines this EIS interaction. The InteractionSpec is JCA adapter specific and typically defines the function name.

getLogString

public java.lang.String getLogString(Accessor accessor)

Return the string for logging purposes.

Specified by:

getLogString in interface Call

Specified by:

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)

Arguments to the interaction can be passed two ways. The entire argument row can be converted to the input record, or the arguments from the row can be translated into the interaction parameters.

Overrides:

DatasourceCall in class oracle.toplink.internal.databaseaccess.DatasourceCall

createInputRecord

public abstract javax.resource.cci.Record createInputRecord(EISAccessor accessor)

Create the appropriate input record for this interaction. Populate the data into the record from this interaction's arguments.

buildRows

public java.util.Vector buildRows(javax.resource.cci.Record record,
                  EISAccessor accessor)

Build a collection of database rows from the Record returned from the interaction. This handles IndexedRecords used as sets of result records, and a single MappedRecord with a list of result records.

getFunctionName

public java.lang.String getFunctionName()

Return the function name of the interaction. A function name is a common properties for a CCI InteractionSpec. This cannot be generically set on the spec as it is not in the interface however the EIS platform may make use of this in build the interaction spec.

setFunctionName

public void setFunctionName(java.lang.String functionName)

Set the function name of the interaction. A function name is a common properties for a CCI InteractionSpec. This cannot be generically set on the spec as it is not in the interface however the EIS platform may make use of this in build the interaction spec.

getInputRecordName

public java.lang.String getInputRecordName()

Return the input record name. This is used as the name passed to the adapter when creating the input record.

setInputRecordName

public void setInputRecordName(java.lang.String recordName)

Set the input record name. This is used as the name passed to the adapter when creating the input record.

getProperties

public java.util.Map getProperties()

Returns the adapter specific properties.

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns the adapter property associated the given name. If the interaction is associated with a query that has a descriptor, The descriptor's properties are automatically inherited.

setProperties

public void setProperties(java.util.Map properties)

Set the adapter specific properties.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Set the adapter specific property.

setInputRow

public void setInputRow(oracle.toplink.internal.sessions.AbstractRecord inputRow)

Set the input database row.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object