OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidProfile
Implementsosid.Sourceable
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.

MethodgetId
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.

Returnosid.id.Idthe Id
CompliancemandatoryThis method must be implemented.
MethodgetDisplayName
Description

Gets a display name for this service implementation.

Returnosid.locale.DisplayTexta display name
CompliancemandatoryThis method must be implemented.
MethodgetDescription
Description

Gets a description of this service implementation.

Returnosid.locale.DisplayTexta description
CompliancemandatoryThis method must be implemented.
MethodgetVersion
Description

Gets the version of this service implementation.

Returnosid.installation.Versionthe service implementation version
CompliancemandatoryThis method must be implemented.
MethodgetReleaseDate
Description

Gets the date this service implementation was released.

Returnosid.calendaring.DateTimethe release date
CompliancemandatoryThis method must be implemented.
MethodsupportsOSIDVersion
Description

Test for support of an OSID specification version.

Parametersosid.installation.Versionversionthe specification version to test
Returnboolean true if this manager supports the given OSID version, false otherwise
CompliancemandatoryThis method must be implemented.
Provider Notes

An implementation may support multiple versions of an OSID.

MethodgetLocales
Description

Gets the locales supported in this service.

Returnosid.locale.LocaleListlist of locales supported
CompliancemandatoryThis method must be implemented.
MethodsupportsJournalRollback
Description

Test for support of a journaling rollback service.

Returnboolean true if this manager supports the journal rollback, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsJournalBranching
Description

Test for support of a journal branching service.

Returnboolean true if this manager supports the journal branching, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBranchId
Description

Gets the Branch Id representing this service branch.

Returnosid.id.Idthe branch Id
ErrorsUNIMPLEMENTED supportsJournalBranching() is false
CompliancemandatoryThis method must be implemented.
MethodgetBranch
Description

Gets this service branch.

Returnosid.journaling.Branchthe service branch
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalBranching() is false
CompliancemandatoryThis method must be implemented.
MethodgetProxyRecordTypes
Description

Gets the proxy record Types supported in this service. If no proxy manager is available, an empty list is returned.

Returnosid.type.TypeListlist of proxy record types supported
CompliancemandatoryThis method must be implemented.
MethodsupportsProxyRecordType
Description

Test for support of a proxy type.

Parametersosid.type.TypeproxyRecordTypea proxy record type
Returnboolean true if this service supports the given proxy record type, false otherwise
ErrorsNULL_ARGUMENT proxyRecordType is null
CompliancemandatoryThis method must be implemented.