Docs For Class HarmoniScheduleItem

Class HarmoniScheduleItem

Description

ScheduleItem contains a set of AgentCommitments (e.g. calendar events) as well as the creator of the ScheduleItem and some date information.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/core/oki2/scheduling/HarmoniScheduleItem.class.php (line 22)

ScheduleItem
   |
   --HarmoniScheduleItem

Variable Summary

mixed $_id

mixed $_table

Method Summary

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

void addAgentCommitment (object Id $agentId, mixed $agentStatus, object Type $agentStatus )

void changeAgentCommitment (object Id $agentId, mixed $agentStatus, object Type $agentStatus )

object AgentCommitmentIterator getAgentCommitments ()

object Id getCreator ()

string getDescription ()

string getDisplayName ()

int getEnd ()

object Id getId ()

string getMasterIdentifier ()

object PropertiesIterator getProperties ()

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

object TypeIterator getPropertyTypes ()

int getStart ()

object Type getStatus ()

void removeAgentCommitment (mixed $agentId, object Id $agentId )

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateEnd (mixed $end, int $end )

void updateStart (mixed $start, int $start )

void updateStatus (mixed $status, object Type $status )

void _getField (mixed $key)

void _getProperties ()

void _getType (mixed $typename)

void _getTypes (mixed $typename)

void _setField (mixed $key, mixed $value)

void _typeToIndex (mixed $typename, mixed $type)

Variables

mixed $_id (line 37)

access: private

mixed $_table (line 38)

Methods

Constructor HarmoniScheduleItem (line 48)

The constructor.

access: public

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

object Id $id

addAgentCommitment (line 571)

Add an Agent commitment to this ScheduleItem.

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, UNKNOWN_ID, UNKNOWN_TYPE, ALREADY_ADDED

void addAgentCommitment (object Id $agentId, mixed $agentStatus, object Type $agentStatus )

object Id $agentId
object Type $agentStatus

Redefinition of:

ScheduleItem::addAgentCommitment(): Add an Agent commitment to this ScheduleItem.

changeAgentCommitment (line 523)

Change a previously added Agent commitment for this ScheduleItem.

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, UNKNOWN_ID, UNKNOWN_TYPE

void changeAgentCommitment (object Id $agentId, mixed $agentStatus, object Type $agentStatus )

object Id $agentId
object Type $agentStatus

Redefinition of:

ScheduleItem::changeAgentCommitment(): Change a previously added Agent commitment for this ScheduleItem.

getAgentCommitments (line 432)

Get all the Agent commitments for this ScheduleItem.

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

Redefinition of:

ScheduleItem::getAgentCommitments(): Get all the Agent commitments for this ScheduleItem.

getCreator (line 278)

Get the unique Id of the Agent that created this ScheduleItem.

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

Redefinition of:

ScheduleItem::getCreator(): Get the unique Id of the Agent that created this ScheduleItem.

getDescription (line 254)

Get the description of this ScheduleItem.

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

string getDescription ()

Redefinition of:

ScheduleItem::getDescription(): Get the description of this ScheduleItem.

getDisplayName (line 231)

Get the DisplayName of this ScheduleItem.

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

string getDisplayName ()

Redefinition of:

ScheduleItem::getDisplayName(): Get the DisplayName of this ScheduleItem.

getEnd (line 333)

Get the End for this ScheduleItem.

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

int getEnd ()

Redefinition of:

ScheduleItem::getEnd(): Get the End for this ScheduleItem.

getId (line 208)

Get the unique Id for this ScheduleItem. The unique Id is set when the ScheduleItem is created.

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

Redefinition of:

ScheduleItem::getId(): Get the unique Id for this ScheduleItem. The unique Id is set when the ScheduleItem is created.

getMasterIdentifier (line 382)

Get the Master Identifier for this ScheduleItem. A Master Identifier is a key, rule, or function that can be used to associated more than one ScheduleItem together. An example can be recurring items where each recurring item has the same Master Identifier.

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

string getMasterIdentifier ()

Redefinition of:

ScheduleItem::getMasterIdentifier(): Get the Master Identifier for this ScheduleItem. A Master Identifier is a key, rule, or function that can be used to associated more than one ScheduleItem together. An example can be recurring items where each recurring item has the same Master Identifier.

getProperties (line 657)

Get the Properties associated with this ScheduleItem.

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

Redefinition of:

ScheduleItem::getProperties(): Get the Properties associated with this ScheduleItem.

getPropertiesByType (line 628)

Get the Properties of this Type associated with this ScheduleItem.

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, NULL_ARGUMENT, UNKNOWN_TYPE

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

object Type $propertiesType

Redefinition of:

ScheduleItem::getPropertiesByType(): Get the Properties of this Type associated with this ScheduleItem.

getPropertyTypes (line 405)

Get all the Property Types for ScheduleItem.

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

Redefinition of:

ScheduleItem::getPropertyTypes(): Get all the Property Types for ScheduleItem.

getStart (line 310)

Get the Start for this ScheduleItem.

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

int getStart ()

Redefinition of:

ScheduleItem::getStart(): Get the Start for this ScheduleItem.

getStatus (line 356)

Get the Status Type for this ScheduleItem.

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:

ScheduleItem::getStatus(): Get the Status Type for this ScheduleItem.

removeAgentCommitment (line 482)

Remove a previously added Agent commitment for this ScheduleItem.

WARNING: NOT IN OSID -- Will likely be added in v3

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, UNKNOWN_ID, UNKNOWN_TYPE

void removeAgentCommitment (mixed $agentId, object Id $agentId )

object Id $agentId

updateDescription (line 106)

Get the description of this ScheduleItem.

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, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

Redefinition of:

ScheduleItem::updateDescription(): Get the description of this ScheduleItem.

updateDisplayName (line 81)

Update the DisplayName of this ScheduleItem.

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, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefinition of:

ScheduleItem::updateDisplayName(): Update the DisplayName of this ScheduleItem.

updateEnd (line 156)

Update the End for this ScheduleItem.

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, NULL_ARGUMENT

void updateEnd (mixed $end, int $end )

int $end

Redefinition of:

ScheduleItem::updateEnd(): Update the End for this ScheduleItem.

updateStart (line 131)

Update the Start for this ScheduleItem.

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, NULL_ARGUMENT

void updateStart (mixed $start, int $start )

int $start

Redefinition of:

ScheduleItem::updateStart(): Update the Start for this ScheduleItem.

updateStatus (line 183)

Update the Status Type for this ScheduleItem.

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, NULL_ARGUMENT, UNKNOWN_TYPE

void updateStatus (mixed $status, object Type $status )

object Type $status

Redefinition of:

ScheduleItem::updateStatus(): Update the Status Type for this ScheduleItem.

_getField (line 726)

void _getField (mixed $key)

_getProperties (line 664)

void _getProperties ()

_getType (line 733)

void _getType (mixed $typename)

_getTypes (line 720)

void _getTypes (mixed $typename)

_setField (line 738)

void _setField (mixed $key, mixed $value)

_typeToIndex (line 714)

void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From ScheduleItem

ScheduleItem::addAgentCommitment()
ScheduleItem::changeAgentCommitment()
ScheduleItem::getAgentCommitments()
ScheduleItem::getCreator()
ScheduleItem::getDescription()
ScheduleItem::getDisplayName()
ScheduleItem::getEnd()
ScheduleItem::getId()
ScheduleItem::getMasterIdentifier()
ScheduleItem::getProperties()
ScheduleItem::getPropertiesByType()
ScheduleItem::getPropertyTypes()
ScheduleItem::getStart()
ScheduleItem::getStatus()
ScheduleItem::updateDescription()
ScheduleItem::updateDisplayName()
ScheduleItem::updateEnd()
ScheduleItem::updateStart()
ScheduleItem::updateStatus()

Documentation generated on Wed, 19 Sep 2007 10:24:20 -0400 by phpDocumentor 1.3.0RC3