Interface | osid.OsidProfile | ||
---|---|---|---|
Implements | osid.Sourceable | ||
Description |
The | ||
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 | ||
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 | ||
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 | |
UNIMPLEMENTED | supportsJournalBranching() is false | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProxyRecordTypes | ||
Description |
Gets the proxy record | ||
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. |