Docs For Class HarmoniEditableAgent

Description

EditableAgent is an extension of the OSID Agent to allow for modifications.

WARNING: NOT IN OSID! Use at your own risk

version: $Id: HarmoniEditableAgent.class.php,v 1.5 2007/09/04 20:25:36 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agent/HarmoniEditableAgent.class.php (line 21)

HarmoniAgent
   |
   --HarmoniEditableAgent

Method Summary

boolean addProperty (object Type $type, string $key, mixed $value, mixed $value )

void clearAllProperties ()

void deleteAllProperties ()

boolean deleteProperty (object Type $type, mixed $key, string $key )

boolean updateDisplayName (mixed $newDisplayName, string $newDisplayName )

boolean updateProperty (object Type $type, string $key, mixed $value, mixed $value )

Variables

Inherited Variables

Inherited from HarmoniAgent

HarmoniAgent::$_hierarchy
HarmoniAgent::$_idString
HarmoniAgent::$_node

Methods

addProperty (line 55)

* adds a property to the agent and stores it

access: public

boolean addProperty (object Type $type, string $key, mixed $value, mixed $value )

object Type $type
string $key
mixed $value

clearAllProperties (line 169)

* Clears the values (replaces them with false) but leaves the properties in in existence. The function above destroys them completely.

access: public

void clearAllProperties ()

deleteAllProperties (line 195)

* Deletes the values for all the properties.

access: public

void deleteAllProperties ()

deleteProperty (line 129)

* Removes a property key/value pair from an agent and agent DB entries

access: public

boolean deleteProperty (object Type $type, mixed $key, string $key )

object Type $type
string $key

updateDisplayName (line 35)

* changes the agent's display name to $newDisplayName and store it in the DB

access: public

boolean updateDisplayName (mixed $newDisplayName, string $newDisplayName )

string $newDisplayName

updateProperty (line 90)

* Updates a property of the agent

access: public

boolean updateProperty (object Type $type, string $key, mixed $value, mixed $value )

object Type $type
string $key
mixed $value

Inherited Methods

Inherited From HarmoniAgent

HarmoniAgent::HarmoniAgent()
HarmoniAgent::getDisplayName()
HarmoniAgent::getId()
HarmoniAgent::getProperties()
HarmoniAgent::getPropertiesByType()
HarmoniAgent::getPropertyTypes()
HarmoniAgent::getType()
HarmoniAgent::isAgent()
HarmoniAgent::isGroup()