Interface OsidManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidProfile, Sourceable
- All Known Subinterfaces:
AcknowledgementBatchManager, AcknowledgementManager, AssessmentAuthoringManager, AssessmentBatchManager, AssessmentManager, AuthenticationBatchManager, AuthenticationKeysBatchManager, AuthenticationKeysManager, AuthenticationManager, AuthenticationProcessManager, AuthorizationBatchManager, AuthorizationManager, AuthorizationRulesManager, BiddingBatchManager, BiddingManager, BiddingRulesManager, BillingBatchManager, BillingManager, BillingPaymentBatchManager, BillingPaymentManager, BloggingBatchManager, BloggingManager, CalendaringBatchManager, CalendaringCycleBatchManager, CalendaringCycleManager, CalendaringManager, CalendaringRulesManager, CatalogingManager, CatalogingRulesManager, ChecklistBatchManager, ChecklistManager, ChecklistMasonManager, CommentingBatchManager, CommentingManager, CommunicationManager, ConfigurationBatchManager, ConfigurationManager, ConfigurationRulesManager, ContactBatchManager, ContactManager, ContactRulesManager, ControlBatchManager, ControlManager, ControlRulesManager, CourseBatchManager, CourseChronicleBatchManager, CourseChronicleManager, CourseManager, CoursePlanManager, CourseProgramBatchManager, CourseProgramManager, CourseRegistrationBatchManager, CourseRegistrationManager, CourseRequisiteManager, CourseSyllabusBatchManager, CourseSyllabusManager, DictionaryBatchManager, DictionaryManager, FilingAllocationManager, FilingManager, FinancialsBatchManager, FinancialsBudgetingBatchManager, FinancialsBudgetingManager, FinancialsManager, FinancialsPostingBatchManager, FinancialsPostingManager, ForumBatchManager, ForumManager, GradingBatchManager, GradingCalculationManager, GradingManager, GradingTransformManager, HierarchyManager, HoldBatchManager, HoldManager, HoldRulesManager, IdBatchManager, IdManager, InquiryBatchManager, InquiryManager, InquiryRulesManager, InstallationBatchManager, InstallationManager, InventoryBatchManager, InventoryManager, InventoryShipmentBatchManager, InventoryShipmentManager, JournalingBatchManager, JournalingManager, LearningBatchManager, LearningManager, LexiconBatchManager, LexiconManager, LocaleManager, LoggingBatchManager, LoggingManager, MappingBatchManager, MappingManager, MappingPathBatchManager, MappingPathManager, MappingPathRulesManager, MappingRouteManager, MessagingBatchManager, MessagingManager, MeteringBatchManager, MeteringManager, OfferingBatchManager, OfferingManager, OfferingRulesManager, OntologyBatchManager, OntologyManager, OntologyRulesManager, OrchestrationManager, OrderingBatchManager, OrderingManager, OrderingRulesManager, OsidRuntimeManager, PersonnelBatchManager, PersonnelManager, ProcessManager, ProfileBatchManager, ProfileManager, ProfileRulesManager, ProvisioningBatchManager, ProvisioningManager, ProvisioningRulesManager, ProxyManager, RecipeBatchManager, RecipeManager, RecognitionBatchManager, RecognitionManager, RegistrationRequestManager, RelationshipBatchManager, RelationshipManager, RelationshipRulesManager, RepositoryBatchManager, RepositoryManager, RepositoryRulesManager, ResourceBatchManager, ResourceDemographicManager, ResourceManager, ResourcingBatchManager, ResourcingManager, ResourcingRulesManager, RoomBatchManager, RoomConstructionBatchManager, RoomConstructionManager, RoomManager, RoomSquattingBatchManager, RoomSquattingManager, RulesCheckManager, RulesManager, SearchManager, SequencingManager, SubscriptionBatchManager, SubscriptionManager, SubscriptionRulesManager, TopologyBatchManager, TopologyManager, TopologyPathManager, TopologyRulesManager, TrackingBatchManager, TrackingManager, TrackingRulesManager, TransactionManager, TransportManager, TypeManager, VotingBatchManager, VotingManager, VotingRulesManager, WorkflowBatchManager, WorkflowEventManager, WorkflowManager, WorkflowRulesManager
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 Summary
Modifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime) Rolls back this service to a point in time.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
initialize
void initialize(OsidRuntimeManager runtime) throws ConfigurationErrorException, OperationFailedException Initializes this manager. A manager is initialized once at the time of creation.- Parameters:
runtime- the runtime environment- Throws:
ConfigurationErrorException- an error with implementation configurationIllegalStateException- this manager has already been initialized by theOsidRuntimeNullArgumentException-runtimeisnullOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.- 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 {@code initialize()} and must set an {@code ILLEGAL_STATE} error.
-
rollbackService
JournalEntry rollbackService(Date rollbackTime) throws OperationFailedException, PermissionDeniedException Rolls back this service to a point in time.- Parameters:
rollbackTime- the requested time- Returns:
- the journal entry corresponding to the actual state of this service
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalRollback()isfalse- Compliance:
mandatory- This method must be implemented.
-
changeBranch
void changeBranch(Id branchId) throws NotFoundException, OperationFailedException, PermissionDeniedException Changes the service branch.- Parameters:
branchId- the new service branch- Throws:
NotFoundException-branchIdnot foundNullArgumentException-branchIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalBranching()isfalse- Compliance:
mandatory- This method must be implemented.
-