OSID - osid.OsidManager Service Interface Definition

Interface	osid.OsidManager
Implements	`osid.OsidProfile`
Implemented By	`osid.course.CourseManager`
	`osid.repository.rules.RepositoryRulesManager`
	`osid.control.batch.ControlBatchManager`
	`osid.assessment.authoring.AssessmentAuthoringManager`
	`osid.configuration.rules.ConfigurationRulesManager`
	`osid.ordering.OrderingManager`
	`osid.topology.TopologyManager`
	`osid.inventory.shipment.InventoryShipmentManager`
	`osid.orchestration.OrchestrationManager`
	`osid.authentication.keys.AuthenticationKeysManager`
	`osid.profile.rules.ProfileRulesManager`
	`osid.bidding.rules.BiddingRulesManager`
	`osid.financials.FinancialsManager`
	`osid.inventory.shipment.batch.InventoryShipmentBatchManager`
	`osid.workflow.event.WorkflowEventManager`
	`osid.authentication.AuthenticationManager`
	`osid.relationship.RelationshipManager`
	`osid.personnel.batch.PersonnelBatchManager`
	`osid.contact.ContactManager`
	`osid.provisioning.ProvisioningManager`
	`osid.cataloging.rules.CatalogingRulesManager`
	`osid.recognition.batch.RecognitionBatchManager`
	`osid.inventory.batch.InventoryBatchManager`
	`osid.calendaring.batch.CalendaringBatchManager`
	`osid.authentication.keys.batch.AuthenticationKeysBatchManager`
	`osid.hold.HoldManager`
	`osid.contact.rules.ContactRulesManager`
	`osid.voting.rules.VotingRulesManager`
	`osid.subscription.SubscriptionManager`
	`osid.subscription.rules.SubscriptionRulesManager`
	`osid.filing.FilingManager`
	`osid.course.chronicle.batch.CourseChronicleBatchManager`
	`osid.hierarchy.HierarchyManager`
	`osid.ontology.batch.OntologyBatchManager`
	`osid.acknowledgement.batch.AcknowledgementBatchManager`
	`osid.hold.rules.HoldRulesManager`
	`osid.forum.ForumManager`
	`osid.authorization.AuthorizationManager`
	`osid.grading.transform.GradingTransformManager`
	`osid.grading.calculation.GradingCalculationManager`
	`osid.room.construction.batch.RoomConstructionBatchManager`
	`osid.OsidRuntimeManager`
	`osid.checklist.batch.ChecklistBatchManager`
	`osid.control.rules.ControlRulesManager`
	`osid.repository.batch.RepositoryBatchManager`
	`osid.resource.demographic.ResourceDemographicManager`
	`osid.course.batch.CourseBatchManager`
	`osid.configuration.batch.ConfigurationBatchManager`
	`osid.profile.batch.ProfileBatchManager`
	`osid.journaling.batch.JournalingBatchManager`
	`osid.lexicon.LexiconManager`
	`osid.bidding.batch.BiddingBatchManager`
	`osid.inventory.InventoryManager`
	`osid.calendaring.cycle.CalendaringCycleManager`
	`osid.learning.LearningManager`
	`osid.installation.InstallationManager`
	`osid.cataloging.CatalogingManager`
	`osid.course.program.batch.CourseProgramBatchManager`
	`osid.messaging.MessagingManager`
	`osid.checklist.mason.ChecklistMasonManager`
	`osid.contact.batch.ContactBatchManager`
	`osid.course.registration.batch.CourseRegistrationBatchManager`
	`osid.calendaring.rules.CalendaringRulesManager`
	`osid.search.SearchManager`
`osid.voting.batch.VotingBatchManager`
`osid.resource.batch.ResourceBatchManager`
`osid.room.construction.RoomConstructionManager`
`osid.subscription.batch.SubscriptionBatchManager`
`osid.recognition.RecognitionManager`
`osid.lexicon.batch.LexiconBatchManager`
`osid.grading.GradingManager`
`osid.id.batch.IdBatchManager`
`osid.ontology.rules.OntologyRulesManager`
`osid.hold.batch.HoldBatchManager`
`osid.room.squatting.RoomSquattingManager`
`osid.billing.batch.BillingBatchManager`
`osid.learning.batch.LearningBatchManager`
`osid.room.batch.RoomBatchManager`
`osid.resourcing.ResourcingManager`
`osid.proxy.ProxyManager`
`osid.transaction.TransactionManager`
`osid.financials.budgeting.FinancialsBudgetingManager`
`osid.rules.check.RulesCheckManager`
`osid.course.plan.CoursePlanManager`
`osid.repository.RepositoryManager`
`osid.bidding.BiddingManager`
`osid.workflow.rules.WorkflowRulesManager`
`osid.topology.rules.TopologyRulesManager`
`osid.authentication.batch.AuthenticationBatchManager`
`osid.profile.ProfileManager`
`osid.relationship.batch.RelationshipBatchManager`
`osid.mapping.batch.MappingBatchManager`
`osid.recipe.RecipeManager`
`osid.course.registration.CourseRegistrationManager`
`osid.provisioning.batch.ProvisioningBatchManager`
`osid.dictionary.batch.DictionaryBatchManager`
`osid.tracking.TrackingManager`
`osid.authorization.batch.AuthorizationBatchManager`
`osid.course.requisite.CourseRequisiteManager`
`osid.financials.batch.FinancialsBatchManager`
`osid.mapping.route.MappingRouteManager`
`osid.journaling.JournalingManager`
`osid.offering.OfferingManager`
`osid.mapping.MappingManager`
`osid.grading.batch.GradingBatchManager`
`osid.locale.LocaleManager`
`osid.assessment.AssessmentManager`
`osid.blogging.BloggingManager`
`osid.voting.VotingManager`
`osid.calendaring.CalendaringManager`
`osid.resourcing.batch.ResourcingBatchManager`
`osid.tracking.batch.TrackingBatchManager`
`osid.authentication.process.AuthenticationProcessManager`
`osid.logging.batch.LoggingBatchManager`
`osid.offering.rules.OfferingRulesManager`
`osid.mapping.path.batch.MappingPathBatchManager`
`osid.ordering.rules.OrderingRulesManager`
`osid.messaging.batch.MessagingBatchManager`
`osid.metering.MeteringManager`
`osid.commenting.CommentingManager`
`osid.dictionary.DictionaryManager`
`osid.inquiry.rules.InquiryRulesManager`
`osid.configuration.ConfigurationManager`
`osid.resource.ResourceManager`
`osid.logging.LoggingManager`
`osid.topology.batch.TopologyBatchManager`
`osid.workflow.batch.WorkflowBatchManager`
`osid.personnel.PersonnelManager`
`osid.relationship.rules.RelationshipRulesManager`
`osid.type.TypeManager`
`osid.course.program.CourseProgramManager`
`osid.course.syllabus.batch.CourseSyllabusBatchManager`
`osid.process.ProcessManager`
`osid.provisioning.rules.ProvisioningRulesManager`
`osid.checklist.ChecklistManager`
`osid.sequencing.SequencingManager`
`osid.billing.BillingManager`
`osid.inquiry.InquiryManager`
`osid.course.chronicle.CourseChronicleManager`
`osid.authorization.rules.AuthorizationRulesManager`
`osid.transport.TransportManager`
`osid.calendaring.cycle.batch.CalendaringCycleBatchManager`
`osid.metering.batch.MeteringBatchManager`
`osid.workflow.WorkflowManager`
`osid.rules.RulesManager`
`osid.room.squatting.batch.RoomSquattingBatchManager`
`osid.installation.batch.InstallationBatchManager`
`osid.acknowledgement.AcknowledgementManager`
`osid.assessment.batch.AssessmentBatchManager`
`osid.commenting.batch.CommentingBatchManager`
`osid.tracking.rules.TrackingRulesManager`
`osid.resourcing.rules.ResourcingRulesManager`
`osid.blogging.batch.BloggingBatchManager`
`osid.billing.payment.BillingPaymentManager`
`osid.communication.CommunicationManager`
`osid.forum.batch.ForumBatchManager`
`osid.financials.posting.batch.FinancialsPostingBatchManager`
`osid.room.RoomManager`
`osid.offering.batch.OfferingBatchManager`
`osid.mapping.path.MappingPathManager`
`osid.ordering.batch.OrderingBatchManager`
`osid.mapping.path.rules.MappingPathRulesManager`
`osid.topology.path.TopologyPathManager`
`osid.course.syllabus.CourseSyllabusManager`
`osid.financials.posting.FinancialsPostingManager`
`osid.recipe.batch.RecipeBatchManager`
`osid.course.registration.request.RegistrationRequestManager`
`osid.id.IdManager`
`osid.financials.budgeting.batch.FinancialsBudgetingBatchManager`
`osid.filing.allocation.FilingAllocationManager`
`osid.billing.payment.batch.BillingPaymentBatchManager`
`osid.ontology.OntologyManager`
`osid.inquiry.batch.InquiryBatchManager`
`osid.control.ControlManager`
Used By	`osid.OsidRuntimeManager`
Description	The `OsidManager` is the top level interface for all OSID managers. An OSID manager is instantiated through the `OsidRuntimeManager` and represents an instance of a service. An OSID manager is responsible for implementing a profile for a service and creating sessions that, in general, correspond to the profile. An application need only create a single `OsidManager` per service and implementors must ensure the `OsidManager` is thread-safe. The `OsidSessions` spawned from an OSID manager are dedicated to single processing threads. The `OsidManager` defines methods in common throughout all OSID managers which implement this interface.
Method	initialize
Description	Initializes this manager. A manager is initialized once at the time of creation.
Parameters	`osid.OsidRuntimeManager`	`runtime`	the runtime environment
Errors	CONFIGURATION_ERROR		an error with implementation configuration
	ILLEGAL_STATE		this manager has already been initialized by the `OsidRuntime`
	NULL_ARGUMENT		`runtime` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Provider Notes	In addition to loading its runtime configuration an implementation may create shared resources such as connection pools to be shared among all sessions of this service and released when this manager is closed. Providers must thread-protect any data stored in the manager. To maximize interoperability, providers should not honor a second call to `initialize()` and must set an `ILLEGAL_STATE` error.
Method	rollbackService
Description	Rolls back this service to a point in time.
Parameters	`timestamp`	`rollbackTime`	the requested time
Return	`osid.journaling.JournalEntry`		the journal entry corresponding to the actual state of this service
Errors	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNIMPLEMENTED		`supportsJournalRollback()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	changeBranch
Description	Changes the service branch.
Parameters	`osid.id.Id`	`branchId`	the new service branch
Errors	NOT_FOUND		`branchId` not found
	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNIMPLEMENTED		`supportsJournalBranching()` is `false`
Compliance	`mandatory`		This method must be implemented.