com.beasys.commerce.axiom.document.jdbc
Class GetDocumentStatement

java.lang.Object
  |
  +--com.beasys.commerce.axiom.document.jdbc.CallableStatement
        |
        +--com.beasys.commerce.axiom.document.jdbc.GetDocumentStatement

All Implemented Interfaces:

java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement

public class GetDocumentStatement

extends CallableStatement

A callable statement which handles getting a single document.

This expects InParam1 to be the string id of the document to retrieve. OutParam1 will be the DocumentDef (or null if id not found).

Field Summary

protected DocumentDef	document The document gotten.
protected java.lang.String	documentId The id of the document to get.

Fields inherited from class com.beasys.commerce.axiom.document.jdbc.CallableStatement

connection

Constructor Summary

GetDocumentStatement(Connection con)
Constructor.

Method Summary

void	clearParameters() Clear the parameters.
void	close() Close the statement.
boolean	execute() Execute the statement.
java.lang.Object	getObject(int index) Get the output parameter.
void	setObject(int index, java.lang.Object obj) Set the input parameter.
void	setString(int index, java.lang.String str) Set the input parameter string.
boolean	wasNull() Tell if the metadata out param was null.

Methods inherited from class com.beasys.commerce.axiom.document.jdbc.CallableStatement

addBatch, addBatch, cancel, clearBatch, clearWarnings, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, getArray, getBigDecimal, getBigDecimal, getBlob, getBoolean, getByte, getBytes, getClob, getConnection, getDate, getDate, getDocumentProvider, getDouble, getFetchDirection, getFetchSize, getFloat, getInt, getLong, getMaxFieldSize, getMaxRows, getMetaData,

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

documentId

protected java.lang.String documentId

The id of the document to get.

document

protected DocumentDef document

The document gotten.

Constructor Detail

GetDocumentStatement

public GetDocumentStatement(Connection con)

Constructor.

Method Detail

close

public void close()

Close the statement.

Overrides:

close in class CallableStatement

Following copied from class: com.beasys.commerce.axiom.document.jdbc.CallableStatement

Throws:

java.sql.SQLException - thrown on an error.

clearParameters

public void clearParameters()

Clear the parameters.

Overrides:

clearParameters in class CallableStatement

Following copied from class: com.beasys.commerce.axiom.document.jdbc.CallableStatement

Throws:

java.sql.SQLException - thrown on an error.

execute

public boolean execute()
                throws java.sql.SQLException

Execute the statement.

Overrides:

execute in class CallableStatement

Throws:

java.sql.SQLException - thrown on an error.

setObject

public void setObject(int index,
                      java.lang.Object obj)
               throws java.sql.SQLException

Set the input parameter.

Overrides:

setObject in class CallableStatement

Throws:

java.sql.SQLException - thrown on invalid args.

setString

public void setString(int index,
                      java.lang.String str)
               throws java.sql.SQLException

Set the input parameter string.

Overrides:

setString in class CallableStatement

Throws:

java.sql.SQLException - thrown on invlid args.

See Also:

setObject(int, java.lang.Object)

getObject

public java.lang.Object getObject(int index)
                           throws java.sql.SQLException

Get the output parameter.

Overrides:

getObject in class CallableStatement

Throws:

java.sql.SQLException - thrown on an error.

wasNull

public boolean wasNull()

Tell if the metadata out param was null.

Overrides:

wasNull in class CallableStatement

Following copied from class: com.beasys.commerce.axiom.document.jdbc.CallableStatement

Throws:

java.sql.SQLException - always thrown.