OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.OsidProxyManager
Implementsosid.OsidProfile
Implemented Byosid.course.CourseProxyManager
osid.repository.rules.RepositoryRulesProxyManager
osid.control.batch.ControlBatchProxyManager
osid.assessment.authoring.AssessmentAuthoringProxyManager
osid.configuration.rules.ConfigurationRulesProxyManager
osid.ordering.OrderingProxyManager
osid.topology.TopologyProxyManager
osid.inventory.shipment.InventoryShipmentProxyManager
osid.authentication.keys.AuthenticationKeysProxyManager
osid.profile.rules.ProfileRulesProxyManager
osid.bidding.rules.BiddingRulesProxyManager
osid.financials.FinancialsProxyManager
osid.inventory.shipment.batch.InventoryShipmentBatchProxyManager
osid.workflow.event.WorkflowEventProxyManager
osid.authentication.AuthenticationProxyManager
osid.relationship.RelationshipProxyManager
osid.personnel.batch.PersonnelBatchProxyManager
osid.contact.ContactProxyManager
osid.provisioning.ProvisioningProxyManager
osid.cataloging.rules.CatalogingRulesProxyManager
osid.recognition.batch.RecognitionBatchProxyManager
osid.inventory.batch.InventoryBatchProxyManager
osid.calendaring.batch.CalendaringBatchProxyManager
osid.authentication.keys.batch.AuthenticationKeysBatchProxyManager
osid.hold.HoldProxyManager
osid.contact.rules.ContactRulesProxyManager
osid.voting.rules.VotingRulesProxyManager
osid.subscription.SubscriptionProxyManager
osid.subscription.rules.SubscriptionRulesProxyManager
osid.filing.FilingProxyManager
osid.course.chronicle.batch.CourseChronicleBatchProxyManager
osid.hierarchy.HierarchyProxyManager
osid.ontology.batch.OntologyBatchProxyManager
osid.acknowledgement.batch.AcknowledgementBatchProxyManager
osid.hold.rules.HoldRulesProxyManager
osid.forum.ForumProxyManager
osid.authorization.AuthorizationProxyManager
osid.grading.transform.GradingTransformProxyManager
osid.grading.calculation.GradingCalculationProxyManager
osid.room.construction.batch.RoomConstructionBatchProxyManager
osid.checklist.batch.ChecklistBatchProxyManager
osid.control.rules.ControlRulesProxyManager
osid.repository.batch.RepositoryBatchProxyManager
osid.resource.demographic.ResourceDemographicProxyManager
osid.course.batch.CourseBatchProxyManager
osid.configuration.batch.ConfigurationBatchProxyManager
osid.profile.batch.ProfileBatchProxyManager
osid.journaling.batch.JournalingBatchProxyManager
osid.lexicon.LexiconProxyManager
osid.bidding.batch.BiddingBatchProxyManager
osid.inventory.InventoryProxyManager
osid.calendaring.cycle.CalendaringCycleProxyManager
osid.learning.LearningProxyManager
osid.installation.InstallationProxyManager
osid.cataloging.CatalogingProxyManager
osid.course.program.batch.CourseProgramBatchProxyManager
osid.messaging.MessagingProxyManager
osid.checklist.mason.ChecklistMasonProxyManager
osid.contact.batch.ContactBatchProxyManager
osid.course.registration.batch.CourseRegistrationBatchProxyManager
osid.calendaring.rules.CalendaringRulesProxyManager
osid.search.SearchProxyManager
osid.voting.batch.VotingBatchProxyManager
osid.resource.batch.ResourceBatchProxyManager
osid.room.construction.RoomConstructionProxyManager
osid.subscription.batch.SubscriptionBatchProxyManager
osid.recognition.RecognitionProxyManager
osid.lexicon.batch.LexiconBatchProxyManager
osid.grading.GradingProxyManager
osid.id.batch.IdBatchProxyManager
osid.ontology.rules.OntologyRulesProxyManager
osid.hold.batch.HoldBatchProxyManager
osid.room.squatting.RoomSquattingProxyManager
osid.billing.batch.BillingBatchProxyManager
osid.learning.batch.LearningBatchProxyManager
osid.room.batch.RoomBatchProxyManager
osid.resourcing.ResourcingProxyManager
osid.proxy.ProxyProxyManager
osid.transaction.TransactionProxyManager
osid.financials.budgeting.FinancialsBudgetingProxyManager
osid.rules.check.RulesCheckProxyManager
osid.course.plan.CoursePlanProxyManager
osid.repository.RepositoryProxyManager
osid.bidding.BiddingProxyManager
osid.workflow.rules.WorkflowRulesProxyManager
osid.topology.rules.TopologyRulesProxyManager
osid.authentication.batch.AuthenticationBatchProxyManager
osid.profile.ProfileProxyManager
osid.relationship.batch.RelationshipBatchProxyManager
osid.mapping.batch.MappingBatchProxyManager
osid.recipe.RecipeProxyManager
osid.course.registration.CourseRegistrationProxyManager
osid.provisioning.batch.ProvisioningBatchProxyManager
osid.dictionary.batch.DictionaryBatchProxyManager
osid.tracking.TrackingProxyManager
osid.authorization.batch.AuthorizationBatchProxyManager
osid.course.requisite.CourseRequisiteProxyManager
osid.financials.batch.FinancialsBatchProxyManager
osid.mapping.route.MappingRouteProxyManager
osid.journaling.JournalingProxyManager
osid.offering.OfferingProxyManager
osid.mapping.MappingProxyManager
osid.grading.batch.GradingBatchProxyManager
osid.locale.LocaleProxyManager
osid.assessment.AssessmentProxyManager
osid.blogging.BloggingProxyManager
osid.voting.VotingProxyManager
osid.calendaring.CalendaringProxyManager
osid.resourcing.batch.ResourcingBatchProxyManager
osid.tracking.batch.TrackingBatchProxyManager
osid.authentication.process.AuthenticationProcessProxyManager
osid.logging.batch.LoggingBatchProxyManager
osid.offering.rules.OfferingRulesProxyManager
osid.mapping.path.batch.MappingPathBatchProxyManager
osid.ordering.rules.OrderingRulesProxyManager
osid.messaging.batch.MessagingBatchProxyManager
osid.metering.MeteringProxyManager
osid.commenting.CommentingProxyManager
osid.dictionary.DictionaryProxyManager
osid.inquiry.rules.InquiryRulesProxyManager
osid.configuration.ConfigurationProxyManager
osid.resource.ResourceProxyManager
osid.logging.LoggingProxyManager
osid.topology.batch.TopologyBatchProxyManager
osid.workflow.batch.WorkflowBatchProxyManager
osid.personnel.PersonnelProxyManager
osid.relationship.rules.RelationshipRulesProxyManager
osid.type.TypeProxyManager
osid.course.program.CourseProgramProxyManager
osid.course.syllabus.batch.CourseSyllabusBatchProxyManager
osid.process.ProcessProxyManager
osid.provisioning.rules.ProvisioningRulesProxyManager
osid.checklist.ChecklistProxyManager
osid.sequencing.SequencingProxyManager
osid.billing.BillingProxyManager
osid.inquiry.InquiryProxyManager
osid.course.chronicle.CourseChronicleProxyManager
osid.authorization.rules.AuthorizationRulesProxyManager
osid.transport.TransportProxyManager
osid.calendaring.cycle.batch.CalendaringCycleBatchProxyManager
osid.metering.batch.MeteringBatchProxyManager
osid.workflow.WorkflowProxyManager
osid.rules.RulesProxyManager
osid.room.squatting.batch.RoomSquattingBatchProxyManager
osid.installation.batch.InstallationBatchProxyManager
osid.acknowledgement.AcknowledgementProxyManager
osid.assessment.batch.AssessmentBatchProxyManager
osid.commenting.batch.CommentingBatchProxyManager
osid.tracking.rules.TrackingRulesProxyManager
osid.resourcing.rules.ResourcingRulesProxyManager
osid.blogging.batch.BloggingBatchProxyManager
osid.billing.payment.BillingPaymentProxyManager
osid.communication.CommunicationProxyManager
osid.forum.batch.ForumBatchProxyManager
osid.financials.posting.batch.FinancialsPostingBatchProxyManager
osid.room.RoomProxyManager
osid.offering.batch.OfferingBatchProxyManager
osid.mapping.path.MappingPathProxyManager
osid.ordering.batch.OrderingBatchProxyManager
osid.mapping.path.rules.MappingPathRulesProxyManager
osid.topology.path.TopologyPathProxyManager
osid.course.syllabus.CourseSyllabusProxyManager
osid.financials.posting.FinancialsPostingProxyManager
osid.recipe.batch.RecipeBatchProxyManager
osid.course.registration.request.RegistrationRequestProxyManager
osid.id.IdProxyManager
osid.financials.budgeting.batch.FinancialsBudgetingBatchProxyManager
osid.filing.allocation.FilingAllocationProxyManager
osid.billing.payment.batch.BillingPaymentBatchProxyManager
osid.ontology.OntologyProxyManager
osid.inquiry.batch.InquiryBatchProxyManager
osid.control.ControlProxyManager
Used Byosid.OsidRuntimeManager
Description

The OsidProxyManager is the top level interface for all OSID proxy managers. A proxy manager accepts parameters to pass through end-user authentication credentials and other necessary request parameters in a server environment. Native applications should use an OsidManager to maintain a higher degree of interoperability by avoiding this coupling.

An OSID proxy manager is instantiated through the OsidRuntimeManager and represents an instance of a service. An OSID manager is responsible for defining clusters of interoperability within a service and creating sessions that generally correspond to these clusters, An application need only create a single OsidProxyManager per service and implementors must ensure the OsidProxyManager is thread-safe. The OsidSessions spawned from an OSID manager are dedicated to single processing threads. The OsidProxyManager defines methods in common throughout all OSID managers which implement this interface.

Methodinitialize
Description

Initializes this manager. A manager is initialized once at the time of creation.

Parametersosid.OsidRuntimeManagerruntime the runtime environment
ErrorsCONFIGURATION_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
Compliancemandatory 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.

MethodrollbackService
Description

Rolls back this service to a point in time.

ParameterstimestamprollbackTime the requested time
osid.proxy.Proxyproxy a proxy
Returnosid.journaling.JournalEntry the journal entry corresponding to the actual state of this service
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNIMPLEMENTED supportsJournalRollback() is false
Compliancemandatory This method must be implemented.
MethodchangeBranch
Description

Changes the service branch.

Parametersosid.id.IdbranchId the new service branch
osid.proxy.Proxyproxy a proxy
ErrorsNOT_FOUND branchId not found
NULL_ARGUMENT branchId or proxy is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNIMPLEMENTED supportsJournalBranching() is false
Compliancemandatory This method must be implemented.