Docs For Class HarmoniAgent

Description

Implements interfaces:

Agent

Agent is an abstraction that includes Id, display name, type, and Properties. Agents are created using implementations of org.osid.agent.AgentManager.

OSID Version: 2.0

version: $Id: HarmoniAgent.class.php,v 1.20 2007/08/22 14:45:44 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agent/HarmoniAgent.class.php (line 30)

Direct descendents

Class	Description
AnonymousAgent	The AnonymousAgent has Id "0" and can refer to a non-logged in user.
HarmoniEditableAgent	EditableAgent is an extension of the OSID Agent to allow for modifications.
HarmoniGroup	Group contains members that are either Agents or other Groups. There are management methods for adding, removing, and getting members and Groups.

Variable Summary

object $_hierarchy

string $_idString

object _node $_node

Method Summary

HarmoniAgent HarmoniAgent (object Hierarchy $hierarchy, object Node $node)

string getDisplayName ()

object Id getId ()

object PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

object Type getType ()

boolean isAgent ()

boolean isGroup ()

Variables

object $_hierarchy (line 46)

since: 8/30/05
access: private

string $_idString (line 53)

since: 9/10/05
access: protected

object _node $_node (line 39)

The node that this group corresponds to.

access: protected

Methods

Constructor HarmoniAgent (line 61)

The constructor.

access: public

HarmoniAgent HarmoniAgent (object Hierarchy $hierarchy, object Node $node)

object Hierarchy $hierarchy
object Node $node

getDisplayName (line 93)

Get the name of this Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

Redefined in descendants as:

UsersGroup::getDisplayName() : Get the name of this Agent.

getId (line 115)

Get the id of this Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

Redefined in descendants as:

UsersGroup::getId() : Get the id of this Agent.

getProperties (line 159)

Get the Properties associated with this Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object PropertiesIterator getProperties ()

getPropertiesByType (line 191)

Get the Properties of this Type associated with this Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

getPropertyTypes (line 228)

Get the Properties Types supported by this Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object TypeIterator getPropertyTypes ()

getType (line 137)

Get the type of this Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getType ()

Redefined in descendants as:

UsersGroup::getType() : Get the type of this Agent.

isAgent (line 255)

Answer true if this Agent is an Agent, not a group

WARNING: NOT IN OSID

since: 12/7/06
access: public

boolean isAgent ()

isGroup (line 268)

Answer true if this Agent is an Group

WARNING: NOT IN OSID

since: 12/7/06
access: public

boolean isGroup ()

Redefined in descendants as:

HarmoniGroup::isGroup() : Answer true if this Agent is an Group