Source for file ResultMetaData.php

<?php 
 
/**
 * ResultMetaData contains information about a specific column in the
 * ResultTable.  You may retrieve the ResultMetaData for each column by
 * calling the ResultTable method getResultMetaData().
 * 
 * <p>
 * OSID Version: 2.0
 * </p>
 * 
 * <p>
 * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
 * O.K.I&#46; OSID Definition License}.
 * </p>
 * 
 * @package org.osid.sql
 */
class ResultMetaData
{
    /**
     * return the column index.  Columns are numbered beginning with one.
     *  
     * @return int 
     * 
     * @throws object SqlException An exception with one of the following
     *          messages defined in org.osid.sql.SqlException may be thrown:
     *          {@link org.osid.sql.SqlException#OPERATION_FAILED}
     *          OPERATION_FAILED}, {@link }
     *          org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
     *          {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getColumnIndex () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * return the column name. Every column in a ResultTable has a name.
     *  
     * @return string 
     * 
     * @throws object SqlException An exception with one of the following
     *          messages defined in org.osid.sql.SqlException may be thrown:
     *          {@link org.osid.sql.SqlException#OPERATION_FAILED}
     *          OPERATION_FAILED}, {@link }
     *          org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
     *          {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getColumnName () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * 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.
     *  
     * @return object Type 
     * 
     * @throws object SqlException An exception with one of the following
     *          messages defined in org.osid.sql.SqlException may be thrown:
     *          {@link org.osid.sql.SqlException#OPERATION_FAILED}
     *          OPERATION_FAILED}, {@link }
     *          org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
     *          {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getColumnType () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * return whether this column allows nulls
     *  
     * @return boolean 
     * 
     * @throws object SqlException An exception with one of the following
     *          messages defined in org.osid.sql.SqlException may be thrown:
     *          {@link org.osid.sql.SqlException#OPERATION_FAILED}
     *          OPERATION_FAILED}, {@link }
     *          org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
     *          {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function areNullsAllowed () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>