GetDocumentMetadataStatement Class

DEPRECATED

com.bea.p13n.content.document.jdbc
GetDocumentMetadataStatement Class

public class GetDocumentMetadataStatement

    extends com.bea.p13n.content.document.jdbc.CallableStatement

A callable statement which handles getting a single document metadata.

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


Hierarchy
Object
  com.bea.p13n.content.document.jdbc.CallableStatement
    GetDocumentMetadataStatement
All Implemented Interfaces

CallableStatement, PreparedStatement, Statement

Field Summary

protected String
documentId
The id of the document metadata to get.
protected com.bea.p13n.content.document.spi.DocumentMetadataDef
metadata
The metadata gotten.
   
Fields from  com.bea.p13n.content.document.jdbc.com.bea.p13n.content.document.jdbc.CallableStatement
connection
 
Fields from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
 

Constructor Summary

GetDocumentMetadataStatement(Connection con)

Constructor.
 

Method Summary

public void
clearParameters()
Clear the parameters.
public void
close()
Close the statement.
public boolean
execute()
Execute the statement.
public Object
getObject(int index)
Get the output parameter.
public void
setObject(int index, Object obj)
Set the input parameter.
public void
setString(int index, String str)
Set the input parameter string.
public boolean
wasNull()
Tell if the metadata out param was null.
 
Methods from  com.bea.p13n.content.document.jdbc.com.bea.p13n.content.document.jdbc.CallableStatement
addBatch, addBatch, cancel, clearBatch, clearWarnings, execute, execute, execute, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getArray, getArray, getBigDecimal, getBigDecimal, getBigDecimal, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getClob, getClob, getConnection, getDate, getDate, getDate, getDate, getDocumentProvider, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getGeneratedKeys, getInt, getInt, getLong, getLong, getMaxFieldSize, getMaxRows, getMetaData, getMoreResults, getMoreResults, getObject, getObject, getObject, getParameterMetaData, getQueryTimeout, getRef, getRef, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getShort, getShort, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getUpdateCount, getURL, getURL, getWarnings, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setArray, setAsciiStream, setAsciiStream, setBigDecimal, setBigDecimal, setBinaryStream, setBinaryStream, setBlob, setBoolean, setBoolean, setByte, setByte, setBytes, setBytes, setCharacterStream, setCharacterStream, setClob, setCursorName, setDate, setDate, setDate, setDate, setDouble, setDouble, setEscapeProcessing, setFetchDirection, setFetchSize, setFloat, setFloat, setInt, setInt, setLong, setLong, setMaxFieldSize, setMaxRows, setNull, setNull, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setQueryTimeout, setRef, setShort, setShort, setString, setTime, setTime, setTime, setTime, setTimestamp, setTimestamp, setTimestamp, setTimestamp, setUnicodeStream, setURL, setURL,
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface java.sql.CallableStatement
getArray, getArray, getBigDecimal, getBigDecimal, getBigDecimal, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getClob, getClob, getDate, getDate, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getObject, getObject, getObject, getObject, getRef, getRef, getShort, getShort, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getURL, getURL, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setAsciiStream, setBigDecimal, setBinaryStream, setBoolean, setByte, setBytes, setCharacterStream, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setURL, wasNull
 
Methods from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
 
Methods from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

Field Detail

documentId

protected String documentId
The id of the document metadata to get.


metadata

protected com.bea.p13n.content.document.spi.DocumentMetadataDef metadata
The metadata gotten.

 

Constructor Detail

GetDocumentMetadataStatement

public GetDocumentMetadataStatement(Connection con)
Constructor.
 

Method Detail

clearParameters() Method

public void clearParameters()
Clear the parameters.

Overrides
CallableStatement.clearParameters()

close() Method

public void close()
Close the statement.

Overrides
CallableStatement.close()

execute() Method

public boolean execute()
throws SQLException
Execute the statement.

Overrides
CallableStatement.execute()

Exceptions

SQLException
thrown on an error.

getObject(int) Method

public Object getObject(int index)
throws SQLException
Get the output parameter.

Overrides
CallableStatement.getObject(int)

Parameters

index
the output parameter index.

Exceptions

SQLException
thrown on an error.

setObject(int, Object) Method

public void setObject(int index, 
                      Object obj)
throws SQLException
Set the input parameter.

Overrides
CallableStatement.setObject(int, Object)

Exceptions

SQLException
thrown on invalid args.

setString(int, String) Method

public void setString(int index, 
                      String str)
throws SQLException
Set the input parameter string.

Overrides
CallableStatement.setString(int, String)

Exceptions

SQLException
thrown on invlid args.

Related Topics

GetDocumentMetadataStatement.setObject(int, Object)


wasNull() Method

public boolean wasNull()
Tell if the metadata out param was null.

Overrides
CallableStatement.wasNull()