[geeklog-cvs] Auth_Enterprise/Enterprise/Server AdminInterface.php,NONE,1.1

[tony at iowaoutdoors.org]

Update of /var/cvs/Auth_Enterprise/Enterprise/Server
In directory www:/tmp/cvs-serv8341

Added Files:
	AdminInterface.php 
Log Message:
Initial release.


--- NEW FILE: AdminInterface.php ---
<?php

/**
* Auth_Enterprise
*
* This source file is subject to version 2.02 of the PHP license, that is bundled with this package
* in the file LICENSE, and is available at through the world-wide-web at
* http://www.php.net/license/2_02.txt. If you did not receive a copy of the PHP license and are
* unable to obtain it through the world-wide-web, please send a note to license at php.net so we can
* mail you a copy immediately.
*
* @author Tony Bibbs <tony at geeklog.net>
* @copyright 2004
* @version $Id: AdminInterface.php,v 1.1 2004/08/17 15:05:06 tony Exp $
*
*/

/**
* Auth_Enteprise Administrative Interfaces
*
* @author Tony Bibbs <tony at geeklog.net>
* @package net.geeklog.auth_enterprise.server
*
*/
interface Auth_Enterprise_Server_AdminInterface {
    /**
     * Creates a new application
     *
     * @author Tony Bibbs <tony at geeklog.net>
     * @access public
     * @param string $adminUserName Administrator's username
     * @param string $adminPassword Administrator's password
     * @param string $appId Application ID to give the application
     * @param string $appName Name to get application
     * @param string $appContactEmail Email for a contact person
     *
     */
    public function createApplication($adminUserName, $adminPassword, $appId, $appName, 
    	$appContactEmail);
    
    /**
     * Registers a new account with the service
     *
     * @author Tony Bibbs <tony at geeklog.net>
     * @access public
     * @param string $adminUserName Administrator's username
     * @param string $adminPassword Administrator's password
     * @param string $appId Application ID for application to delete
     *
     */
    public function removeApplication($adminUserName, $adminPassword, $appId);
    
    /**
     * Creates a new group for a given application
     *
     * @author Tony Bibbs <tony at geeklog.net>
     * @access public
     * @param string $adminUserName Administrator's username
     * @param string $adminPassword Administrator's password
     * @param string $appId Application ID for application to add group to
     * @param string $logicalName Group's logical name
     * @param string $displayName Group's name as shown to users
     * @param string $description Group Description
     *
     */
    public function createGroup($adminUserName, $adminPassword, $appId, $logicalName, $displayName,
    	$description);
    	
    /**
     * Deletes a group for the given application
     *
     * @author Tony Bibbs <tony at geeklog.net>
     * @access public
     * @param string $adminUserName Administrator's username
     * @param string $adminPassword Administrator's password
     * @param string $appId Application ID for application  to delete group from
     * @param string $groupID ID for the group to delete
     *
     */
    public function removeGroup($adminUserName, $adminPassword, $appId, $groupId);
    
    /**
     * Creates a new privilege for a given application
     *
     * @author Tony Bibbs <tony at geeklog.net>
     * @access public
     * @param string $adminUserName Administrator's username
     * @param string $adminPassword Administrator's password
     * @param string $appId Application ID for application to add privilege to
     * @param string $privCode Privilege Code
     * @param string $privDesc Privilege Description
     *
     */
    public function createPrivilege($adminUserName, $adminPassword, $appId, $privCode, $privDesc);
    
    /**
     * Deletes a privilege for the given application
     *
     * @author Tony Bibbs <tony at geeklog.net>
     * @access public
     * @param string $adminUserName Administrator's username
     * @param string $adminPassword Administrator's password
     * @param string $appId Application ID for application  to delete privilege from
     * @param string $privCode Privilege Code for the privilege to delete
     *
     */
    public function removePrivilege($adminUserName, $adminPassword, $appId, $privCode);
    
}

?>