Managers¶

Osid Profile¶

class dlkit.osid.managers.OsidProfile¶

Bases: dlkit.osid.markers.Sourceable

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.

ident¶

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.

Returns:	the `Id`
Return type:	`osid.id.Id`

display_name¶

Gets a display name for this service implementation.

Returns:	a display name
Return type:	`osid.locale.DisplayText`

description¶

Gets a description of this service implementation.

Returns:	a description
Return type:	`osid.locale.DisplayText`

version¶

Gets the version of this service implementation.

Returns:	the service implementation version
Return type:	`osid.installation.Version`

release_date¶

Gets the date this service implementation was released.

Returns:	the release date
Return type:	`osid.calendaring.DateTime`

supports_osid_version(version)¶

Test for support of an OSID specification version.

Parameters:	version (`osid.installation.Version`) – the specification version to test
Returns:	`true` if this manager supports the given OSID version, `false` otherwise
Return type:	`boolean`

locales¶

Gets the locales supported in this service.

Returns:	list of locales supported
Return type:	`osid.locale.LocaleList`

supports_journal_rollback()¶

Test for support of a journaling rollback service.

Returns:	`true` if this manager supports the journal rollback, `false` otherwise
Return type:	`boolean`

supports_journal_branching()¶

Test for support of a journal branching service.

Returns:	`true` if this manager supports the journal branching, `false` otherwise
Return type:	`boolean`

branch_id¶

Gets the Branch Id representing this service branch.

Returns:	the branch `Id`
Return type:	`osid.id.Id`
Raise:	`Unimplemented` – `supports_journal_branching()` is `false`

branch¶

Gets this service branch.

Returns:	the service branch
Return type:	`osid.journaling.Branch`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unimplemented` – `supports_journal_branching()` is `false`

proxy_record_types¶

Gets the proxy record Types supported in this service.

If no proxy manager is available, an empty list is returned.

Returns:	list of proxy record types supported
Return type:	`osid.type.TypeList`

supports_proxy_record_type(proxy_record_type)¶

Test for support of a proxy type.

Parameters:	proxy_record_type (`osid.type.Type`) – a proxy record type
Returns:	`true` if this service supports the given proxy record type, `false` otherwise
Return type:	`boolean`
Raise:	`NullArgument` – `proxy_record_type` is `null`