Docs For Class ResultMetaData

Class ResultMetaData

Description

ResultMetaData contains information about a specific column in the ResultTable. You may retrieve the ResultMetaData for each column by calling the ResultTable method getResultMetaData().

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/sql/ResultMetaData.php (line 19)

Method Summary

boolean areNullsAllowed ()

int getColumnIndex ()

string getColumnName ()

object Type getColumnType ()

Methods

areNullsAllowed (line 98)

return whether this column allows nulls

access: public
throws: object SqlException An exception with one of the following messages defined in org.osid.sql.SqlException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

boolean areNullsAllowed ()

getColumnIndex (line 37)

return the column index. Columns are numbered beginning with one.

access: public
throws: object SqlException An exception with one of the following messages defined in org.osid.sql.SqlException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

int getColumnIndex ()

getColumnName (line 57)

return the column name. Every column in a ResultTable has a name.

access: public
throws: object SqlException An exception with one of the following messages defined in org.osid.sql.SqlException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getColumnName ()

getColumnType (line 78)

The SQL data type of this column is an instance of org.osid.shared.Type.

It represents one of the data types supported by the implementation.

access: public
throws: object SqlException An exception with one of the following messages defined in org.osid.sql.SqlException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getColumnType ()

Documentation generated on Wed, 19 Sep 2007 10:26:04 -0400 by phpDocumentor 1.3.0RC3