Class OsidManager

Description

OsidManager is the key to binding an application to an OSID implementation.

An OSID is required to define an interface that extends OsidManager. The OSID implementation is required to have a class that implements its OsidManager. The application loads an OSID implementation by using the OsidLoader to get an instance of the OSID's OsidManager. The application accesses all OSID objects directly or indirectly through the OSID's OsidManager.

<p> OsidManager defines three methods: getOsidContext, assignOsidContext, assignConfiguration. The assign methods are called by the OsidLoader.getManager method. An application can use the assign methods, but this would only be for overriding the default behavior of the OsidLoader.getManager method. </p>

<p> The OsidLoader.getManager method checks its OsidContext argument to make sure it is not null, and then calls the Osidmanager implementation class assignOsidContext method. </p>

<p> The OsidLoader.getManager method loads a properties file that contains the configuration information if one exists. The configuration information is set by the system integrator who has installed an implementation. The configuration properties file is loaded by by the OsidLoader.getManager method using the getResourceAsStream method of the OSID's OsidManager class to search for the configuration properties file. The properties from the loaded configuration file are overlaid with any configuration properties supplied by the application in the call to the OsidLoader.getManager call in the additionalConfiguration argument. The assignConfiguration method is then called. </p>

<p> Typically, the application calls the getOsidContext method only. It is unusual for the application to override the OsidLoader.getManager and call assignOsidContext or assignConfiguration. </p>

<p> The implementation of OsidManager can use both the OsidContext and the Configuration properties as needed. </p>

<p> OSID Version: 2.0 </p>

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

Located in /harmoni/oki2/osid/OsidManager.php (line 61)


	
			
Direct descendents
Class Description
OutputHandler The OutputHander abstract class defines methods for the interaction between the Harmoni framework object and output handling classes.
AgentTokenMappingManager The AgentTokenMappingManager manages the mappings between AgentIds and one or more sets of authentication tokens per AgentId.
AuthNMethodManager The AuthNMethodManager handles the management of Authentication Types and the AuthNMethods that correspond to those types. Neither the AuthNMethodManager nor AuthNMethods maintain any information about authentication states. They simply provide the means of checking that authentication when desired.
TagManager The TagManager handles the creation and retreval of tags.
AgentManager <p> AgentManager handles creating, deleting, and getting Agents and Groups.
AssessmentManager <p> AssessmentManager handles creating and deleting:
AuthenticationManager <p> AuthenticationManager:
AuthorizationManager AuthorizationManager allows an application to create Authorizations, get Authorizations given selection criterias, ask questions of Authorization such as what agentId can do a Function in a Qualifier context, etc.
CourseManagementManager <p> CourseManagementManager handles creating and deleting
DictionaryManager <p> DictionaryManager handles creating, deleting, and getting Dictionaries.
FilingManager <p> FilingManager:
GradingManager <p> GradingManager handles creating and deleting:
HierarchyManager <p> HierarchyManager handles creating, deleting, and getting Hierarchies.
IdManager IdManager creates and gets Ids. Ids are used in many different contexts throughout the OSIDs. As with other Managers, use the OsidLoader to load an implementation of this interface.
LoggingManager <p> LoggingManager handles creating, deleting, and getting logs for reading or writing. All log Entries have a formatType, a priorityType, and a timestamp.
OsidRomiManager OsidRomiManager is the key binding for accessing remote computing environments either by the application or by an OSID implementation.
OsidTransactionManager OsidTransactionManager is the key binding for controlling persistent store transactions from an application or an implementation of an OSID.
RepositoryManager <p> The RepositoryManager supports creating and deleting Repositories and Assets as well as getting the various Types used.
SchedulingManager <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.
SqlManager The SqlManager provides a means to retrieve a connection to the database.
UsermessagingManager <p> The Manager sends and receives messages and returns the Types of messages and delivery supported by the implementation. A message is not created explicitly; it is created when it is sent.
WorkflowManager <p> WorkflowManager handles the management of Processes and the discovery of unfinished or completed work.
Method Summary
Methods
assignConfiguration (line 108)

Assign the configuration of this OsidManager.

  • access: public
  • throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void assignConfiguration (object Properties $configuration)

Redefined in descendants as:
assignOsidContext (line 87)

Assign the context of this OsidManager.

  • access: public
  • throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: NULL_ARGUMENT
void assignOsidContext (mixed $context, object OsidContext $context )

Redefined in descendants as:
getOsidContext (line 72)

Return context of this OsidManager.

  • access: public
  • throws: object OsidException
object OsidContext getOsidContext ()

Redefined in descendants as:
osidVersion_2_0 (line 124)

Verify to OsidLoader that it is loading

OSID Version: 2.0

.

  • access: public
  • throws: object OsidException
void osidVersion_2_0 ()

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