Skip navigation links

Oracle TopLink Java API Reference
10g Release 3 (10.1.3.1)

B28219-01


oracle.toplink.eis.interactions
Class XMLInteraction

java.lang.Object
  extended byDatasourceCall
      extended byoracle.toplink.eis.interactions.EISInteraction
          extended byoracle.toplink.eis.interactions.MappedInteraction
              extended byoracle.toplink.eis.interactions.XMLInteraction

Direct Known Subclasses:
XQueryInteraction

public class XMLInteraction
extends MappedInteraction

Defines the specification for a call to a JCA interaction that uses XML. Builds the input and output XML records from the arguments. This extends MappedInteraction to allow for mapped style of argument input and output.

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

Constructor Summary
XMLInteraction()
          Default constructor.

 

Method Summary
 DatabaseRow buildRow(javax.resource.cci.Record record, EISAccessor accessor)
          Build a database row from the record returned from the interaction.
 java.util.Vector buildRows(javax.resource.cci.Record record, EISAccessor accessor)
          Build a collection of database rows from the Record returned from the interaction.
 org.w3c.dom.Element createInputDOM(EISAccessor accessor)
          Create a DOM for this interaction.
 javax.resource.cci.Record createInputRecord(EISAccessor accessor)
          Create a DOM input record for this interaction.
 java.lang.String getInputRootElementName()
          PUBLIC: Return the root element name to use for the input DOM.
 java.lang.String getLogString(Accessor accessor)
          Return the string for logging purposes.
 java.lang.String getOutputRootElementName()
          PUBLIC: Return the root element name to use for the output DOM.
 void prepare(Session session)
          Set the default record name from the descriptor.
 void setInputRootElementName(java.lang.String inputRootElementName)
          PUBLIC: Set the root element name to use for the input DOM.
 void setOutputRootElementName(java.lang.String outputRootElementName)
          PUBLIC: Set the root element name to use for the output DOM.

 

Methods inherited from class oracle.toplink.eis.interactions.MappedInteraction
addArgument, addArgument, addArgumentValue, getArgumentNames, getInputResultPath, setInputResultPath

 

Methods inherited from class oracle.toplink.eis.interactions.EISInteraction
addOutputArgument, addOutputArgument, createRecordElement, getArguments, getFunctionName, getInputRecordName, getInteractionSpec, getOutputArgumentNames, getOutputArguments, getOutputResultPath, getProperties, getProperty, hasArguments, hasOutputArguments, isEISInteraction, setFunctionName, setInputRecordName, setInputRow, setInteractionSpec, setOutputArgumentNames, setOutputArguments, setOutputResultPath, setProperties, setProperty, toString, translate

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

XMLInteraction

public XMLInteraction()
Default constructor.

Method Detail

getInputRootElementName

public java.lang.String getInputRootElementName()
PUBLIC: Return the root element name to use for the input DOM.

setInputRootElementName

public void setInputRootElementName(java.lang.String inputRootElementName)
PUBLIC: Set the root element name to use for the input DOM.

getOutputRootElementName

public java.lang.String getOutputRootElementName()
PUBLIC: Return the root element name to use for the output DOM.

setOutputRootElementName

public void setOutputRootElementName(java.lang.String outputRootElementName)
PUBLIC: Set the root element name to use for the output DOM.

prepare

public void prepare(Session session)
Set the default record name from the descriptor.
Overrides:
prepare in class EISInteraction

createInputRecord

public javax.resource.cci.Record createInputRecord(EISAccessor accessor)
Create a DOM input record for this interaction. Convet the database row or arguments into an XML DOM tree.
Overrides:
createInputRecord in class MappedInteraction

createInputDOM

public org.w3c.dom.Element createInputDOM(EISAccessor accessor)
Create a DOM for this interaction. Convet the database row or arguments into an XML DOM tree.

buildRow

public DatabaseRow buildRow(javax.resource.cci.Record record,
                            EISAccessor accessor)
Build a database row from the record returned from the interaction.
Overrides:
buildRow in class MappedInteraction

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.
Overrides:
buildRows in class EISInteraction

getLogString

public java.lang.String getLogString(Accessor accessor)
Return the string for logging purposes.
Overrides:
getLogString in class EISInteraction

Skip navigation links

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