OSID - osid.OsidProfile Service Interface Definition

Interface	osid.OsidProfile
Implements	`osid.Sourceable`
Implemented By	`osid.course.CourseProfile`
	`osid.repository.rules.RepositoryRulesProfile`
	`osid.control.batch.ControlBatchProfile`
	`osid.assessment.authoring.AssessmentAuthoringProfile`
	`osid.configuration.rules.ConfigurationRulesProfile`
	`osid.ordering.OrderingProfile`
	`osid.topology.TopologyProfile`
	`osid.inventory.shipment.InventoryShipmentProfile`
	`osid.orchestration.OrchestrationProfile`
	`osid.authentication.keys.AuthenticationKeysProfile`
	`osid.profile.rules.ProfileRulesProfile`
	`osid.bidding.rules.BiddingRulesProfile`
	`osid.financials.FinancialsProfile`
	`osid.inventory.shipment.batch.InventoryShipmentBatchProfile`
	`osid.workflow.event.WorkflowEventProfile`
	`osid.authentication.AuthenticationProfile`
	`osid.relationship.RelationshipProfile`
	`osid.personnel.batch.PersonnelBatchProfile`
	`osid.contact.ContactProfile`
	`osid.provisioning.ProvisioningProfile`
	`osid.cataloging.rules.CatalogingRulesProfile`
	`osid.recognition.batch.RecognitionBatchProfile`
	`osid.inventory.batch.InventoryBatchProfile`
	`osid.calendaring.batch.CalendaringBatchProfile`
	`osid.authentication.keys.batch.AuthenticationKeysBatchProfile`
	`osid.hold.HoldProfile`
	`osid.contact.rules.ContactRulesProfile`
	`osid.voting.rules.VotingRulesProfile`
	`osid.subscription.SubscriptionProfile`
	`osid.subscription.rules.SubscriptionRulesProfile`
	`osid.filing.FilingProfile`
	`osid.course.chronicle.batch.CourseChronicleBatchProfile`
	`osid.hierarchy.HierarchyProfile`
	`osid.ontology.batch.OntologyBatchProfile`
	`osid.acknowledgement.batch.AcknowledgementBatchProfile`
	`osid.hold.rules.HoldRulesProfile`
	`osid.forum.ForumProfile`
	`osid.authorization.AuthorizationProfile`
	`osid.grading.transform.GradingTransformProfile`
	`osid.grading.calculation.GradingCalculationProfile`
	`osid.room.construction.batch.RoomConstructionBatchProfile`
	`osid.OsidManager`
	`osid.OsidProxyManager`
	`osid.OsidRuntimeProfile`
	`osid.checklist.batch.ChecklistBatchProfile`
	`osid.control.rules.ControlRulesProfile`
	`osid.repository.batch.RepositoryBatchProfile`
	`osid.resource.demographic.ResourceDemographicProfile`
	`osid.course.batch.CourseBatchProfile`
	`osid.configuration.batch.ConfigurationBatchProfile`
	`osid.profile.batch.ProfileBatchProfile`
	`osid.journaling.batch.JournalingBatchProfile`
	`osid.lexicon.LexiconProfile`
	`osid.bidding.batch.BiddingBatchProfile`
	`osid.inventory.InventoryProfile`
	`osid.calendaring.cycle.CalendaringCycleProfile`
	`osid.learning.LearningProfile`
	`osid.installation.InstallationProfile`
	`osid.cataloging.CatalogingProfile`
	`osid.course.program.batch.CourseProgramBatchProfile`
	`osid.messaging.MessagingProfile`
	`osid.checklist.mason.ChecklistMasonProfile`
	`osid.contact.batch.ContactBatchProfile`
	`osid.course.registration.batch.CourseRegistrationBatchProfile`
`osid.calendaring.rules.CalendaringRulesProfile`
`osid.search.SearchProfile`
`osid.voting.batch.VotingBatchProfile`
`osid.resource.batch.ResourceBatchProfile`
`osid.room.construction.RoomConstructionProfile`
`osid.subscription.batch.SubscriptionBatchProfile`
`osid.recognition.RecognitionProfile`
`osid.lexicon.batch.LexiconBatchProfile`
`osid.grading.GradingProfile`
`osid.id.batch.IdBatchProfile`
`osid.ontology.rules.OntologyRulesProfile`
`osid.hold.batch.HoldBatchProfile`
`osid.room.squatting.RoomSquattingProfile`
`osid.billing.batch.BillingBatchProfile`
`osid.learning.batch.LearningBatchProfile`
`osid.room.batch.RoomBatchProfile`
`osid.resourcing.ResourcingProfile`
`osid.proxy.ProxyProfile`
`osid.transaction.TransactionProfile`
`osid.financials.budgeting.FinancialsBudgetingProfile`
`osid.rules.check.RulesCheckProfile`
`osid.course.plan.CoursePlanProfile`
`osid.repository.RepositoryProfile`
`osid.bidding.BiddingProfile`
`osid.workflow.rules.WorkflowRulesProfile`
`osid.topology.rules.TopologyRulesProfile`
`osid.authentication.batch.AuthenticationBatchProfile`
`osid.profile.ProfileProfile`
`osid.relationship.batch.RelationshipBatchProfile`
`osid.mapping.batch.MappingBatchProfile`
`osid.recipe.RecipeProfile`
`osid.course.registration.CourseRegistrationProfile`
`osid.provisioning.batch.ProvisioningBatchProfile`
`osid.dictionary.batch.DictionaryBatchProfile`
`osid.tracking.TrackingProfile`
`osid.authorization.batch.AuthorizationBatchProfile`
`osid.course.requisite.CourseRequisiteProfile`
`osid.financials.batch.FinancialsBatchProfile`
`osid.mapping.route.MappingRouteProfile`
`osid.journaling.JournalingProfile`
`osid.offering.OfferingProfile`
`osid.mapping.MappingProfile`
`osid.grading.batch.GradingBatchProfile`
`osid.locale.LocaleProfile`
`osid.assessment.AssessmentProfile`
`osid.blogging.BloggingProfile`
`osid.voting.VotingProfile`
`osid.calendaring.CalendaringProfile`
`osid.resourcing.batch.ResourcingBatchProfile`
`osid.tracking.batch.TrackingBatchProfile`
`osid.authentication.process.AuthenticationProcessProfile`
`osid.logging.batch.LoggingBatchProfile`
`osid.offering.rules.OfferingRulesProfile`
`osid.mapping.path.batch.MappingPathBatchProfile`
`osid.ordering.rules.OrderingRulesProfile`
`osid.messaging.batch.MessagingBatchProfile`
`osid.metering.MeteringProfile`
`osid.commenting.CommentingProfile`
`osid.dictionary.DictionaryProfile`
`osid.inquiry.rules.InquiryRulesProfile`
`osid.configuration.ConfigurationProfile`
`osid.resource.ResourceProfile`
`osid.logging.LoggingProfile`
`osid.topology.batch.TopologyBatchProfile`
`osid.workflow.batch.WorkflowBatchProfile`
`osid.personnel.PersonnelProfile`
`osid.relationship.rules.RelationshipRulesProfile`
`osid.type.TypeProfile`
`osid.course.program.CourseProgramProfile`
`osid.course.syllabus.batch.CourseSyllabusBatchProfile`
`osid.process.ProcessProfile`
`osid.provisioning.rules.ProvisioningRulesProfile`
`osid.checklist.ChecklistProfile`
`osid.sequencing.SequencingProfile`
`osid.billing.BillingProfile`
`osid.inquiry.InquiryProfile`
`osid.course.chronicle.CourseChronicleProfile`
`osid.authorization.rules.AuthorizationRulesProfile`
`osid.transport.TransportProfile`
`osid.calendaring.cycle.batch.CalendaringCycleBatchProfile`
`osid.metering.batch.MeteringBatchProfile`
`osid.workflow.WorkflowProfile`
`osid.rules.RulesProfile`
`osid.room.squatting.batch.RoomSquattingBatchProfile`
`osid.installation.batch.InstallationBatchProfile`
`osid.acknowledgement.AcknowledgementProfile`
`osid.assessment.batch.AssessmentBatchProfile`
`osid.commenting.batch.CommentingBatchProfile`
`osid.tracking.rules.TrackingRulesProfile`
`osid.resourcing.rules.ResourcingRulesProfile`
`osid.blogging.batch.BloggingBatchProfile`
`osid.billing.payment.BillingPaymentProfile`
`osid.communication.CommunicationProfile`
`osid.forum.batch.ForumBatchProfile`
`osid.financials.posting.batch.FinancialsPostingBatchProfile`
`osid.room.RoomProfile`
`osid.offering.batch.OfferingBatchProfile`
`osid.mapping.path.MappingPathProfile`
`osid.ordering.batch.OrderingBatchProfile`
`osid.mapping.path.rules.MappingPathRulesProfile`
`osid.topology.path.TopologyPathProfile`
`osid.course.syllabus.CourseSyllabusProfile`
`osid.financials.posting.FinancialsPostingProfile`
`osid.recipe.batch.RecipeBatchProfile`
`osid.course.registration.request.RegistrationRequestProfile`
`osid.id.IdProfile`
`osid.financials.budgeting.batch.FinancialsBudgetingBatchProfile`
`osid.filing.allocation.FilingAllocationProfile`
`osid.billing.payment.batch.BillingPaymentBatchProfile`
`osid.ontology.OntologyProfile`
`osid.inquiry.batch.InquiryBatchProfile`
`osid.control.ControlProfile`
Description	The `OsidProfile` defines the interoperability areas of an OSID. An `OsidProfile` is implemented by an `OsidManager`. The top level `OsidProfile` tests for version compatibility. Each OSID extends this interface to include its own interoperability definitions within its managers.
Method	getId
Description	Gets an identifier for this service implementation. The identifier is unique among services but multiple instantiations of the same service use the same `Id`. This identifier is the same identifier used in managing OSID installations.
Return	`osid.id.Id`		the `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getDisplayName
Description	Gets a display name for this service implementation.
Return	`osid.locale.DisplayText`		a display name
Compliance	`mandatory`		This method must be implemented.
Method	getDescription
Description	Gets a description of this service implementation.
Return	`osid.locale.DisplayText`		a description
Compliance	`mandatory`		This method must be implemented.
Method	getVersion
Description	Gets the version of this service implementation.
Return	`osid.installation.Version`		the service implementation version
Compliance	`mandatory`		This method must be implemented.
Method	getReleaseDate
Description	Gets the date this service implementation was released.
Return	`osid.calendaring.DateTime`		the release date
Compliance	`mandatory`		This method must be implemented.
Method	supportsOSIDVersion
Description	Test for support of an OSID specification version.
Parameters	`osid.installation.Version`	`version`	the specification version to test
Return	`boolean`		`true` if this manager supports the given OSID version, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Provider Notes	An implementation may support multiple versions of an OSID.
Method	getLocales
Description	Gets the locales supported in this service.
Return	`osid.locale.LocaleList`		list of locales supported
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalRollback
Description	Test for support of a journaling rollback service.
Return	`boolean`		`true` if this manager supports the journal rollback, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalBranching
Description	Test for support of a journal branching service.
Return	`boolean`		`true` if this manager supports the journal branching, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBranchId
Description	Gets the `Branch Id` representing this service branch.
Return	`osid.id.Id`		the branch `Id`
Errors	UNIMPLEMENTED		`supportsJournalBranching()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getBranch
Description	Gets this service branch.
Return	`osid.journaling.Branch`		the service branch
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalBranching()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProxyRecordTypes
Description	Gets the proxy record `Types` supported in this service. If no proxy manager is available, an empty list is returned.
Return	`osid.type.TypeList`		list of proxy record types supported
Compliance	`mandatory`		This method must be implemented.
Method	supportsProxyRecordType
Description	Test for support of a proxy type.
Parameters	`osid.type.Type`	`proxyRecordType`	a proxy record type
Return	`boolean`		`true` if this service supports the given proxy record type, `false` otherwise
Errors	NULL_ARGUMENT		`proxyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.