Source for file Qualifier.php

<?php 
 
/**
 * Qualifier is the context in which an Authorization is valid and consists of
 * an Id, a description 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 Qualifier
{
    /**
     * Get the unique Id for this Qualifier.
     *  
     * @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 Qualifier.
     *  
     * @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 Qualifier.
     *  
     * @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."); 
    } 
 
    /**
     * Return true if this Qualifier has any children; false otherwise
     *  
     * @return boolean 
     * 
     * @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 isParent () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the QualifierType for this Qualifier.
     *  
     * @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 getQualifierType () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the description for this Qualifier.
     * 
     * @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."); 
    } 
 
    /**
     * Adds a parent to this Qualifier supported by the Authorization
     * implementation.
     * 
     * @param object Id $parentQualifierId 
     * 
     * @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}, {@link }
     *          org.osid.authorization.AuthorizationException#UNKNOWN_ID
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function addParent ( $parentQualifierId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Removes a parent from this Qualifier.  If this is the last parent the
     * delete will fail and an AuthorizationException will be thrown.  For a
     * non-Root Qualifier there must always be a parent.
     * 
     * @param object Id $parentQualifierId 
     * 
     * @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}, {@link }
     *          org.osid.authorization.AuthorizationException#UNKNOWN_ID
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function removeParent ( $parentQualifierId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Changes the parent of this Qualifier by adding a new parent and removing
     * the old parent.
     * 
     * @param object Id $oldParentId 
     * @param object Id $newParentId 
     * 
     * @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}, {@link }
     *          org.osid.authorization.AuthorizationException#UNKNOWN_ID
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function changeParent ( $oldParentId, $newParentId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Determines if this Qualifier is the child a given parent
     * 
     * @param object Id $parentId 
     *  
     * @return boolean 
     * 
     * @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}, {@link }
     *          org.osid.authorization.AuthorizationException#UNKNOWN_ID
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function isChildOf ( $parentId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Determines if this Qualifier is a descendant of the given qualifierId.
     * 
     * @param object Id $ancestorId 
     *  
     * @return boolean 
     * 
     * @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}, {@link }
     *          org.osid.authorization.AuthorizationException#UNKNOWN_ID
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function isDescendantOf ( $ancestorId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Gets the children of this Qualifier.
     *  
     * @return object QualifierIterator 
     * 
     * @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 getChildren () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Gets the parents of this Qualifier.
     *  
     * @return object QualifierIterator 
     * 
     * @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 getParents () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>