Source for file Function.php

<?php 
 
/**
 * Function is composed of Id, a displayName, a description, a category, and a
 * QualifierType.  Ids in Authorization are externally defined and their
 * uniqueness is enforced by the implementation.
 * 
 * <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.authorization
 */
class FunctionInterface
{
    /**
     * Get the unique Id for this Function.
     *  
     * @return object Id 
     * 
     * @throws object AuthorizationException An exception with
     *          one of the following messages defined in
     *          org.osid.authorization.AuthorizationException may be thrown:
     *          {@link }
     *          org.osid.authorization.AuthorizationException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.authorization.AuthorizationException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.authorization.AuthorizationException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.authorization.AuthorizationException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the permanent reference name for this Function.
     *  
     * @return string 
     * 
     * @throws object AuthorizationException An exception with
     *          one of the following messages defined in
     *          org.osid.authorization.AuthorizationException may be thrown:
     *          {@link }
     *          org.osid.authorization.AuthorizationException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.authorization.AuthorizationException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.authorization.AuthorizationException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.authorization.AuthorizationException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getReferenceName () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the description for this Function.
     *  
     * @return string 
     * 
     * @throws object AuthorizationException An exception with
     *          one of the following messages defined in
     *          org.osid.authorization.AuthorizationException may be thrown:
     *          {@link }
     *          org.osid.authorization.AuthorizationException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.authorization.AuthorizationException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.authorization.AuthorizationException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.authorization.AuthorizationException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getDescription () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the FunctionType for this Function.
     *  
     * @return object Type 
     * 
     * @throws object AuthorizationException An exception with
     *          one of the following messages defined in
     *          org.osid.authorization.AuthorizationException may be thrown:
     *          {@link }
     *          org.osid.authorization.AuthorizationException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.authorization.AuthorizationException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.authorization.AuthorizationException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.authorization.AuthorizationException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getFunctionType () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the QualifierHierarchyId for this Function.
     *  
     * @return object Id 
     * 
     * @throws object AuthorizationException An exception with
     *          one of the following messages defined in
     *          org.osid.authorization.AuthorizationException may be thrown:
     *          {@link }
     *          org.osid.authorization.AuthorizationException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.authorization.AuthorizationException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.authorization.AuthorizationException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.authorization.AuthorizationException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getQualifierHierarchyId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the description for this Function.
     * 
     * @param string $description 
     * 
     * @throws object AuthorizationException An exception with
     *          one of the following messages defined in
     *          org.osid.authorization.AuthorizationException may be thrown:
     *          {@link }
     *          org.osid.authorization.AuthorizationException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.authorization.AuthorizationException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.authorization.AuthorizationException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.authorization.AuthorizationException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.authorization.AuthorizationException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateDescription ( $description ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>