Docs For Class Agent

Description

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

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/agent/Agent.php (line 19)

Direct descendents

Class	Description
Group	Group contains members that are either Agents or other Groups. There are management methods for adding, removing, and getting members and Groups.

Method Summary

string getDisplayName ()

object Id getId ()

object PropertiesIterator getProperties ()

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

object TypeIterator getPropertyTypes ()

object Type getType ()

Methods

getDisplayName (line 39)

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 ()

getId (line 59)

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 ()

getProperties (line 144)

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 104)

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 124)

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 79)

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 ()

Interface Agent