Docs For Class HarmoniAgentCommitment

Description

AgentCommitment joins an Agent to a Status Type. This is the Status of the Commitment and not the Status of the Agent.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/core/oki2/scheduling/HarmoniAgentCommitment.class.php (line 20)

AgentCommitment
   |
   --HarmoniAgentCommitment

Variable Summary

mixed $_id

mixed $_table

Method Summary

void HarmoniAgentCommitment (mixed $id, object Id $id )

object Id getAgentId ()

object ScheduleItem getScheduleItem ()

object Type getStatus ()

void _getField (mixed $key)

void _getType (mixed $typename)

void _getTypes (mixed $typename)

void _setField (mixed $key, mixed $value)

void _typeToIndex (mixed $typename, mixed $type)

Variables

mixed $_id (line 30)

access: private

mixed $_table (line 31)

Methods

Constructor HarmoniAgentCommitment (line 41)

The constructor.

access: public

void HarmoniAgentCommitment (mixed $id, object Id $id )

object Id $id

getAgentId (line 69)

Get the agentId of the individual associated with this Commitment.

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

object Id getAgentId ()

Redefinition of:

AgentCommitment::getAgentId(): Get the agentId of the individual associated with this Commitment.

getScheduleItem (line 124)

Get the Schedule Item this AgentCommitment is associated with.

Warning: NOT IN OSID -- Will probably be added to the OSID, but may be a little iffy.

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

object ScheduleItem getScheduleItem ()

getStatus (line 97)

Get the Status associated with this Commitment. For example, if the commitment is a meeting, each particpant might have one of the Status Type values "invited", "confirmed", "declined".

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

object Type getStatus ()

Redefinition of:

AgentCommitment::getStatus(): Get the Status associated with this Commitment. For example, if the commitment is a meeting, each particpant might have one of the Status Type values "invited", "confirmed", "declined".

_getField (line 142)

void _getField (mixed $key)

_getType (line 149)

void _getType (mixed $typename)

_getTypes (line 136)

void _getTypes (mixed $typename)

_setField (line 154)

void _setField (mixed $key, mixed $value)

_typeToIndex (line 130)

void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From AgentCommitment

AgentCommitment::getAgentId()
AgentCommitment::getStatus()