Source for file AgentManager.php

<?php 
 
include_once(dirname(__FILE__)."/../OsidManager.php");
/**
 * <p>
 * AgentManager handles creating, deleting, and getting Agents and Groups.
 * Group is a subclass of Agent. Groups contain members. Group members are
 * Agents or other Groups.
 * </p>
 * 
 * <p>
 * All implementations of OsidManager (manager) provide methods for accessing
 * and manipulating the various objects defined in the OSID package. A manager
 * defines an implementation of an OSID. All other OSID objects come either
 * directly or indirectly from the manager. New instances of the OSID objects
 * are created either directly or indirectly by the manager.  Because the OSID
 * objects are defined using interfaces, create methods must be used instead
 * of the new operator to create instances of the OSID objects. Create methods
 * are used both to instantiate and persist OSID objects.  Using the
 * OsidManager class to define an OSID's implementation allows the application
 * to change OSID implementations by changing the OsidManager package name
 * used to load an implementation. Applications developed using managers
 * permit OSID implementation substitution without changing the application
 * source code. As with all managers, use the OsidLoader to load an
 * implementation of this interface.
 * </p>
 * 
 * <p></p>
 * 
 * <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.agent
 */
class AgentManager
    extends OsidManager
{
    /**
     * Create an Agent with the display name, Type, and Properties specified.
     * All are immutable.
     * 
     * @param string $displayName 
     * @param object Type $agentType 
     * @param object Properties $properties 
     *  
     * @return object Agent 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function createAgent ( $displayName, $agentType, $properties ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete the Agent with the specified unique Id.
     * 
     * @param object Id $id 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link org.osid.agent.AgentException#UNKNOWN_ID}
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteAgent ( $id ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Agent with the specified unique Id. Getting an Agent by name is
     * not supported since names are not guaranteed to be unique.
     * 
     * @param object Id $id 
     *  
     * @return object Agent 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link org.osid.agent.AgentException#UNKNOWN_ID}
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function getAgent ( $id ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Agents.  The returned iterator provides access to the Agents
     * one at a time.  Iterators have a method hasNextAgent() which returns
     * <code>true</code> if there is an Agent available and a method
     * nextAgent() which returns the next Agent.
     *  
     * @return object AgentIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getAgents () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the agent Types.  The returned iterator provides access to the
     * agent Types from this implementation one at a time.  Iterators have a
     * method hasNext() which returns true if there is an agent Type
     * available and a method next() which returns the next agent Type.
     *  
     * @return object TypeIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getAgentTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the property Types.  The returned iterator provides access to
     * the property Types from this implementation one at a time.  Iterators
     * have a method hasNext() which returns true if there is another
     * property Type available and a method next() which returns the next
     * property Type.
     *  
     * @return object TypeIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getPropertyTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create a Group with the display name, Type, description, and Properties
     * specified.  All but description are immutable.
     * 
     * @param string $displayName 
     * @param object Type $groupType 
     * @param string $description 
     * @param object Properties $properties 
     *  
     * @return object Group 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function createGroup ( $displayName, $groupType, $description, $properties ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete the Group with the specified unique Id.
     * 
     * @param object Id $id 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link org.osid.agent.AgentException#UNKNOWN_ID}
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteGroup ( $id ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Gets the Group with the specified unique Id. Getting a Group by name is
     * not supported since names are not guaranteed to be unique.
     * 
     * @param object Id $id 
     *  
     * @return object Group 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link org.osid.agent.AgentException#UNKNOWN_ID}
     *          UNKNOWN_ID}
     * 
     * @access public
     */
    function getGroup ( $id ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Groups.  Note since Groups subclass Agents, we are returning
     * an AgentIterator and there is no GroupIterator. the returned iterator
     * provides access to the Groups one at a time.  Iterators have a method
     * hasNextAgent() which returns true if there is a Group available and a
     * method nextAgent() which returns the next Group.
     *  
     * @return object AgentIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getGroups () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the group Types.  The returned iterator provides access to the
     * group Types from this implementation one at a time.  Iterators have a
     * method hasNext() which returns true if there is a group Type
     * available and a method next() which returns the next group Type.
     *  
     * @return object TypeIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function getGroupTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Agents of the specified Type.
     * 
     * @param object Type $agentType 
     *  
     * @return object AgentIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getAgentsByType ( $agentType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Groups of the specified Type.
     * 
     * @param object Type $groupType 
     *  
     * @return object AgentIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getGroupsByType ( $groupType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the agent search Types supported by this implementation.
     *  
     * @return object TypeIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getAgentSearchTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Agents with the specified search criteria and search Type.
     * 
     * @param object mixed $searchCriteria (original type: java.io.Serializable)
     * @param object Type $agentSearchType 
     *  
     * @return object AgentIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getAgentsBySearch ( $searchCriteria, $agentSearchType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the group search types supported by this implementation.
     *  
     * @return object TypeIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getGroupSearchTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the groups with the specified search criteria and search Type.
     * 
     * @param object mixed $searchCriteria (original type: java.io.Serializable)
     * @param object Type $groupSearchType 
     *  
     * @return object AgentIterator 
     * 
     * @throws object AgentException An exception with one of the
     *          following messages defined in org.osid.agent.AgentException may
     *          be thrown:  {@link }
     *          org.osid.agent.AgentException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.agent.AgentException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.agent.AgentException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.agent.AgentException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link org.osid.agent.AgentException#NULL_ARGUMENT}
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.agent.AgentException#UNKNOWN_TYPE UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getGroupsBySearch ( $searchCriteria, $groupSearchType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>