Class SchedulingManager

Description
Description | Descendents | Methods (details)

<p> SchedulingManager creates, deletes, and gets ScheduleItems. Items include Agent Commitments (e.g. Calendar events). The Manager also enumerates the commitment Status Types supported by the implementation.

</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/scheduling/SchedulingManager.php (line 41) 

OsidManager
   |
   --SchedulingManager
Direct descendents
Description | Descendents | Methods (details)
Class Description
HarmoniSchedulingManager <p> SchedulingManager creates, deletes, and gets ScheduleItems. Items include Agent Commitments (e.g. Calendar events). The Manager also enumerates the commitment Status Types supported by the implementation.
Method Summary
Description | Descendents | Methods (details)
object ScheduleItem createScheduleItem (string $displayName, string $description, object Id[] $agents, int $start, int $end, mixed $masterIdentifier, string $masterIdentifier )
void deleteScheduleItem (mixed $scheduleItemId, object Id $scheduleItemId )
object TimespanIterator getAvailableTimes (object Id[] $agents, int $start, mixed $end, int $end )
object TypeIterator getCommitmentStatusTypes ()
object TypeIterator getItemStatusTypes ()
object ScheduleItem getScheduleItem (mixed $scheduleItemId, object Id $scheduleItemId )
object ScheduleItemIterator getScheduleItems (int $start, int $end, mixed $status, object Type $status )
object ScheduleItemIterator getScheduleItemsByMasterId (mixed $masterIdentifier, string $masterIdentifier )
object ScheduleItemIterator getScheduleItemsForAgents (int $start, int $end, object Type $status, mixed $agents, object Id[] $agents )
Methods
Description | Descendents | Methods (details)
createScheduleItem (line 80)

Create a ScheduleItem. The masterIdentifier argument is optional. 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. An unique Id is generated for this ScheduleItem by the implementation.

  • 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_ID, END_BEFORE_START
object ScheduleItem createScheduleItem (string $displayName, string $description, object Id[] $agents, int $start, int $end, mixed $masterIdentifier, string $masterIdentifier )
  • string $displayName
  • string $description
  • object Id[] $agents
  • int $start
  • int $end
  • string $masterIdentifier
Redefined in descendants as:
  • HarmoniSchedulingManager::createScheduleItem() : WARNING: NOT IN OSID -- This method is designed to comply with V3 of the OSIDs, at least How Tom suggested they were headed <a href="http://okicommunity.mit.edu/forum/viewtopic.php?forum=1&showtopic=67&show=10&page=2"> here </a>. Leave out the agent parameter, and add a statusType instead.
deleteScheduleItem (line 106)

Delete a ScheduleItem by unique Id.

  • 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_ID
void deleteScheduleItem (mixed $scheduleItemId, object Id $scheduleItemId )
Redefined in descendants as:
getAvailableTimes (line 138)

Get the Timespans during which all Agents are uncommitted.

  • 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_ID, END_BEFORE_START
object TimespanIterator getAvailableTimes (object Id[] $agents, int $start, mixed $end, int $end )
  • object Id[] $agents
  • int $start
  • int $end
Redefined in descendants as:
getCommitmentStatusTypes (line 315)

Get the Status Types for Agents' Commitment supported by the implementation.

  • 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 getCommitmentStatusTypes ()
Redefined in descendants as:
getItemStatusTypes (line 291)

Get the Status Types for ScheduleItem supported by the implementation.

  • 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 getItemStatusTypes ()
Redefined in descendants as:
getScheduleItem (line 166)

Get a ScheduleItem by unique Id.

  • 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_ID
object ScheduleItem getScheduleItem (mixed $scheduleItemId, object Id $scheduleItemId )
Redefined in descendants as:
getScheduleItems (line 200)

Get all the ScheduleItems for any Agent, with the specified Item Status and that start or end between the start and end specified, inclusive.

  • 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, END_BEFORE_START
object ScheduleItemIterator getScheduleItems (int $start, int $end, mixed $status, object Type $status )
Redefined in descendants as:
getScheduleItemsByMasterId (line 268)

Get all ScheduleItems with the specified master identifier reference. 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, NULL_ARGUMENT
object ScheduleItemIterator getScheduleItemsByMasterId (mixed $masterIdentifier, string $masterIdentifier )
  • string $masterIdentifier
Redefined in descendants as:
getScheduleItemsForAgents (line 237)

Get all the ScheduleItems for the specified Agents, with the specified Item Status and that start or end between the start and end specified, inclusive.

  • 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, END_BEFORE_START, UNKNOWN_ID
object ScheduleItemIterator getScheduleItemsForAgents (int $start, int $end, object Type $status, mixed $agents, object Id[] $agents )
  • int $start
  • int $end
  • object Type $status
  • object Id[] $agents
Redefined in descendants as:

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

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