|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bea.adapter.cci.AbstractInteraction
com.bea.adapter.cci.AbstractDocumentRecordInteraction
public abstract class AbstractDocumentRecordInteraction
Provides a base implementation for adapter providers to extend. An
Interaction
enables a component to execute EIS functions. This
class makes sure the client passed a com.bea.connector.DocumentRecord.
A DocumentRecord represents a runtime request for a service. A service represents functionality available in an EIS system. A service is comprised of four components:
Field Summary |
---|
Fields inherited from class com.bea.adapter.cci.AbstractInteraction |
---|
m_warning |
Constructor Summary | |
---|---|
AbstractDocumentRecordInteraction(AbstractConnection connectionHandle)
Constructs an instance |
Method Summary | |
---|---|
boolean |
allowsNamespacesInRequest()
Indicates whether this adapter allows namespace information in the request documents it receives. |
boolean |
allowsNullRequest()
Indicates whether this adapter can allow null request records. |
boolean |
allowsNullResponse()
Indicates whether this adapter can return null response records. |
protected abstract DocumentRecord |
execute(javax.resource.cci.InteractionSpec ixSpec,
DocumentRecord inputDoc)
Adapter developers must provide an implementation for this method rather than overriding execute(InteractionSpec, Record) |
protected abstract boolean |
execute(javax.resource.cci.InteractionSpec ixSpec,
DocumentRecord inputDoc,
DocumentRecord outputDoc)
Adapter developers must provide an implementation for this method rather than execute(InteractionSpec, Record, Record). |
javax.resource.cci.Record |
execute(javax.resource.cci.InteractionSpec ixSpec,
javax.resource.cci.Record input)
Executes the EIS function represented by the InteractionSpec
and produces the output Record as a return value. |
boolean |
execute(javax.resource.cci.InteractionSpec ixSpec,
javax.resource.cci.Record input,
javax.resource.cci.Record output)
Executes the EIS function represented by the InteractionSpec
and updates the output Record . |
protected String |
getContent(DocumentRecord rec,
String strPath,
boolean bIsMandatory)
A convenience method for retrieving String content from a DocumentRecord. |
protected Calendar |
getDateContent(DocumentRecord rec,
String strPath,
boolean bIsMandatory)
A convenience method for retrieving date content as a Java Calendar from a DocumentRecord. |
protected Calendar |
getDateTimeContent(DocumentRecord rec,
String strPath,
boolean bIsMandatory)
A convenience method for retrieving dateTime content as a Java Calendar from a DocumentRecord. |
protected Calendar |
getTimeContent(DocumentRecord rec,
String strPath,
boolean bIsMandatory)
A convenience method for retrieving time content as a Java Calendar from a DocumentRecord. |
protected void |
validateRequestDocument(DocumentInteractionSpec ixSpec,
DocumentRecord inputDoc)
Convenience method for validating request documents |
Methods inherited from class com.bea.adapter.cci.AbstractInteraction |
---|
clearWarnings, getConnection, getLogContext, getLogger, getRecordFactory, getWarnings |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.resource.cci.Interaction |
---|
close |
Constructor Detail |
---|
public AbstractDocumentRecordInteraction(AbstractConnection connectionHandle) throws javax.resource.ResourceException
connectionHandle
- - the connection to execute an EIS function against
must not be null.
javax.resource.ResourceException
- - the supplied handle or the log context object
is nullMethod Detail |
---|
public boolean allowsNullRequest()
public boolean allowsNullResponse()
public boolean allowsNamespacesInRequest()
public boolean execute(javax.resource.cci.InteractionSpec ixSpec, javax.resource.cci.Record input, javax.resource.cci.Record output) throws javax.resource.ResourceException
InteractionSpec
and updates the output Record
. Specifically, this method
ensures that the input and output records are DocumentRecords.
javax.resource.ResourceException
protected abstract boolean execute(javax.resource.cci.InteractionSpec ixSpec, DocumentRecord inputDoc, DocumentRecord outputDoc) throws javax.resource.ResourceException
javax.resource.ResourceException
public javax.resource.cci.Record execute(javax.resource.cci.InteractionSpec ixSpec, javax.resource.cci.Record input) throws javax.resource.ResourceException
InteractionSpec
and produces the output Record
as a return value.
javax.resource.ResourceException
protected abstract DocumentRecord execute(javax.resource.cci.InteractionSpec ixSpec, DocumentRecord inputDoc) throws javax.resource.ResourceException
javax.resource.ResourceException
protected void validateRequestDocument(DocumentInteractionSpec ixSpec, DocumentRecord inputDoc) throws javax.resource.ResourceException
javax.resource.ResourceException
protected String getContent(DocumentRecord rec, String strPath, boolean bIsMandatory) throws javax.resource.ResourceException
rec
- - the DocumentRecord with the desired contentstrPath
- - a valid XPath in the DocumentbIsMandatory
- - a flag to indicate if the value is mandatory.
javax.resource.ResourceException
- if the DocumentRecord does not
contain mandatory content, i.e. if the String value is null or empty.protected Calendar getDateContent(DocumentRecord rec, String strPath, boolean bIsMandatory) throws javax.resource.ResourceException
rec
- - the DocumentRecord with the desired contentstrPath
- - a valid XPath in the DocumentbIsMandatory
- - a flag to indicate if the value is mandatory.
javax.resource.ResourceException
- if the DocumentRecord does not
contain mandatory content, i.e. if the String value is null or empty.protected Calendar getDateTimeContent(DocumentRecord rec, String strPath, boolean bIsMandatory) throws javax.resource.ResourceException
rec
- - the DocumentRecord with the desired contentstrPath
- - a valid XPath in the DocumentbIsMandatory
- - a flag to indicate if the value is mandatory.
javax.resource.ResourceException
- if the DocumentRecord does not
contain mandatory content, i.e. if the String value is null or empty.protected Calendar getTimeContent(DocumentRecord rec, String strPath, boolean bIsMandatory) throws javax.resource.ResourceException
rec
- - the DocumentRecord with the desired contentstrPath
- - a valid XPath in the DocumentbIsMandatory
- - a flag to indicate if the value is mandatory.
javax.resource.ResourceException
- if the DocumentRecord does not
contain mandatory content, i.e. if the String value is null or empty.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |