Interface | osid.repository.RepositoryManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.repository.RepositoryProfile | |||
Description |
The repository manager provides access to asset lookup and creation session and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getAssetLookupSession | ||
Description |
Gets the | ||
Return | osid.repository.AssetLookupSession | the new AssetLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAssetLookup() is
true. | |
Method | getAssetLookupSessionForRepository | ||
Description |
Gets the | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetLookupSession | the new AssetLookupSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAssetLookup() and
supportsVisibleFederation() are true. | |
Method | getAssetQuerySession | ||
Description |
Gets an asset query session. | ||
Return | osid.repository.AssetQuerySession | an AssetQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAssetQuery() is
true. | |
Method | getAssetQuerySessionForRepository | ||
Description |
Gets an asset query session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetQuerySession | an AssetQuerySession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAssetQuery() and
supportsVisibleFederation() are true. | |
Method | getAssetSearchSession | ||
Description |
Gets an asset search session. | ||
Return | osid.repository.AssetSearchSession | an AssetSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetSearch() is false | ||
Compliance | optional | This method must be implemented if supportsAssetSearch() is
true. | |
Method | getAssetSearchSessionForRepository | ||
Description |
Gets an asset search session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetSearchSession | an AssetSearchSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAssetSearch() and
supportsVisibleFederation() are true. | |
Method | getAssetAdminSession | ||
Description |
Gets an asset administration session for creating, updating and deleting assets. | ||
Return | osid.repository.AssetAdminSession | an AssetAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAssetAdmin() is
true. | |
Method | getAssetAdminSessionForRepository | ||
Description |
Gets an asset administration session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetAdminSession | an AssetAdminSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAssetAdmin() and
supportsVisibleFederation() are true. | |
Method | getAssetNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to asset changes. | ||
Parameters | osid.repository.AssetReceiver | assetReceiver | the notification callback |
Return | osid.repository.AssetNotificationSession | an AssetNotificationSession | |
Errors | NULL_ARGUMENT | assetReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAssetNotification()
is true. | |
Method | getAssetNotificationSessionForRepository | ||
Description |
Gets the asset notification session for the given repository. | ||
Parameters | osid.repository.AssetReceiver | assetReceiver | the notification callback |
osid.id.Id | repositoryId | the Id of the repository | |
Return | osid.repository.AssetNotificationSession | an AssetNotificationSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | assetReceiver or repositoryId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAssetNotfication()
and supportsVisibleFederation() are true.
| |
Method | getAssetRepositorySession | ||
Description |
Gets the session for retrieving asset to repository mappings. | ||
Return | osid.repository.AssetRepositorySession | an AssetRepositorySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetRepository() is false | ||
Compliance | optional | This method must be implemented if supportsAssetRepository()
is true. | |
Method | getAssetRepositoryAssignmentSession | ||
Description |
Gets the session for assigning asset to repository mappings. | ||
Return | osid.repository.AssetRepositoryAssignmentSession | an AssetRepositoryAsignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetRepositoryAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsAssetRepositoryAssignment() is true. | |
Method | getAssetSmartRepositorySession | ||
Description |
Gets an asset smart repository session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetSmartRepositorySession | an AssetSmartRepositorySession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetSmartRepository() false | ||
Compliance | optional | This method must be implemented if supportsAssetSmartRepository()
is true. | |
Method | getAssetTemporalSession | ||
Description |
Gets the session for retrieving temporal coverage of an asset. | ||
Return | osid.repository.AssetTemporalSession | an AssetTemporalSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetTemporal() is false | ||
Compliance | optional | This method must be implemented if supportsAssetTemporal()
is true. | |
Method | getAssetTemporalSessionForRepository | ||
Description |
Gets the session for retrieving temporal coverage of an asset for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetTemporalSession | an AssetTemporalSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetTemporal() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAssetTemporal()
and supportsVisibleFederation() are true. | |
Method | getAssetTemporalAssignmentSession | ||
Description |
Gets the session for assigning temporal coverage to an asset. | ||
Return | osid.repository.AssetTemporalAssignmentSession | an AssetTemporalAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetTemporalAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsAssetTemporalAssignment()
is true. | |
Method | getAssetTemporalAssignmentSessionForRepository | ||
Description |
Gets the session for assigning temporal coverage of an asset for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetTemporalAssignmentSession | an AssetTemporalAssignmentSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetTemporalAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAssetTemporalAssignment()
and supportsVisibleFederation() are true.
| |
Method | getAssetSpatialSession | ||
Description |
Gets the session for retrieving spatial coverage of an asset. | ||
Return | osid.repository.AssetSpatialSession | an AssetSpatialSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSpatialAssets() is false | ||
Compliance | optional | This method must be implemented if supportsSpatialAssets()
is true. | |
Method | getAssetSpatialSessionForRepository | ||
Description |
Gets the session for retrieving spatial coverage of an asset for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetSpatialSession | an AssetSpatialSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetSpatial() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAssetSpatial()
and supportsVisibleFederation() are true. | |
Method | getAssetSpatialAssignmentSession | ||
Description |
Gets the session for assigning spatial coverage to an asset. | ||
Return | osid.repository.AssetSpatialAssignmentSession | an AssetSpatialAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetSpatialAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsAssetSpatialAssignment()
is true. | |
Method | getAssetSpatialAssignmentSessionForRepository | ||
Description |
Gets the session for assigning spatial coverage of an asset for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.AssetSpatialAssignmentSession | an AssetSpatialAssignmentSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAssetSpatialAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAssetSpatialAssignment()
and supportsVisibleFederation() are true.
| |
Method | getAssetCompositionSession | ||
Description |
Gets the session for retrieving asset compositions. | ||
Return | osid.repository.AssetCompositionSession | an AssetCompositionSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetComposition() is false | ||
Compliance | optional | This method must be implemented if supportsAssetComposition()
is true. | |
Method | getAssetCompositionDesignSession | ||
Description |
Gets the session for creating asset compositions. | ||
Return | osid.repository.AssetCompositionDesignSession | an AssetCompositionDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAssetCompositionDesign() is false | ||
Compliance | optional | This method must be implemented if supportsAssetCompositionDesign()
is true. | |
Method | getCompositionLookupSession | ||
Description |
Gets the | ||
Return | osid.repository.CompositionLookupSession | the new CompositionLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCompositionLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionLookup()
is true. | |
Method | getCompositionLookupSessionForRepository | ||
Description |
Gets the | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.CompositionLookupSession | the new CompositionLookupSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionLookup()
and supportsVisibleFederation() are true.
| |
Method | getCompositionQuerySession | ||
Description |
Gets a composition query session. | ||
Return | osid.repository.CompositionQuerySession | a CompositionQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCompositionQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionQuery()
is true. | |
Method | getCompositionQuerySessionForRepository | ||
Description |
Gets a composition query session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.CompositionQuerySession | a CompositionQuerySession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionQuery()
and supportsVisibleFederation() are true.
| |
Method | getCompositionSearchSession | ||
Description |
Gets a composition search session. | ||
Return | osid.repository.CompositionSearchSession | a CompositionSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCompositionSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionSearch()
is true. | |
Method | getCompositionSearchSessionForRepository | ||
Description |
Gets a composition search session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.CompositionSearchSession | a CompositionSearchSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionSearch()
and supportsVisibleFederation() are true.
| |
Method | getCompositionAdminSession | ||
Description |
Gets a composition administration session for creating, updating and deleting compositions. | ||
Return | osid.repository.CompositionAdminSession | a CompositionAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCompositionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionAdmin()
is true. | |
Method | getCompositionAdminSessionForRepository | ||
Description |
Gets a composiiton administrative session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.CompositionAdminSession | a CompositionAdminSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionAdmin()
and supportsVisibleFederation() are true.
| |
Method | getCompositionNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to composition changes. | ||
Parameters | osid.repository.CompositionReceiver | compositionReceiver | the notification callback |
Return | osid.repository.CompositionNotificationSession | a CompositionNotificationSession | |
Errors | NULL_ARGUMENT | compositionReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionNotification()
is true. | |
Method | getCompositionNotificationSessionForRepository | ||
Description |
Gets the composition notification session for the given repository. | ||
Parameters | osid.repository.CompositionReceiver | compositionReceiver | the notification callback |
osid.id.Id | repositoryId | the Id of the repository | |
Return | osid.repository.CompositionNotificationSession | a CompositionNotificationSession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | compositionReceiver or repositoryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionNotfication()
and supportsVisibleFederation() are true.
| |
Method | getCompositionRepositorySession | ||
Description |
Gets the session for retrieving composition to repository mappings. | ||
Return | osid.repository.CompositionRepositorySession | a CompositionRepositorySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCompositionRepository() is false | ||
Compliance | optional | This method must be implemented if supportsCompositionRepository()
is true. | |
Method | getCompositionRepositoryAssignmentSession | ||
Description |
Gets the session for assigning composition to repository mappings. | ||
Return | osid.repository.CompositionRepositoryAssignmentSession | a CompositionRepositoryAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCompositionRepositoryAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCompositionRepositoryAssignment() is true. | |
Method | getCompositionSmartRepositorySession | ||
Description |
Gets a composition smart repository session for the given repository. | ||
Parameters | osid.id.Id | repositoryId | the Id of the repository |
Return | osid.repository.CompositionSmartRepositorySession | a CompositionSmartRepositorySession | |
Errors | NOT_FOUND | repositoryId not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCompositionSmartRepository() false | ||
Compliance | optional | This method must be implemented if
supportsCompositionSmartRepository() is true. | |
Method | getRepositoryLookupSession | ||
Description |
Gets the repository lookup session. | ||
Return | osid.repository.RepositoryLookupSession | a RepositoryLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryLookup()
is true. | |
Method | getRepositoryQuerySession | ||
Description |
Gets the repository query session. | ||
Return | osid.repository.RepositoryQuerySession | a RepositoryQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryQuery()
is true. | |
Method | getRepositorySearchSession | ||
Description |
Gets the repository search session. | ||
Return | osid.repository.RepositorySearchSession | a RepositorySearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositorySearch() is false | ||
Compliance | optional | This method must be implemented if supportsRepositorySearch()
is true. | |
Method | getRepositoryAdminSession | ||
Description |
Gets the repository administrative session for creating, updating and deleteing repositories. | ||
Return | osid.repository.RepositoryAdminSession | a RepositoryAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryAdmin()
is true. | |
Method | getRepositoryNotificationSession | ||
Description |
Gets the notification session for subscribing to changes to a repository. | ||
Parameters | osid.repository.RepositoryReceiver | repositoryReceiver | the notification callback |
Return | osid.repository.RepositoryNotificationSession | a RepositoryNotificationSession | |
Errors | NULL_ARGUMENT | repositoryReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRepositoryNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryNotification()
is true. | |
Method | getRepositoryHierarchySession | ||
Description |
Gets the repository hierarchy traversal session. | ||
Return | osid.repository.RepositoryHierarchySession | a RepositoryHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryHierarchy()
is true. | |
Method | getRepositoryHierarchyDesignSession | ||
Description |
Gets the repository hierarchy design session. | ||
Return | osid.repository.RepositoryHierarchyDesignSession | a RepostoryHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsRepositoryHierarchyDesign() is true. | |
Method | getRepositoryBatchManager | ||
Description |
Gets a | ||
Return | osid.repository.batch.RepositoryBatchManager | a RepostoryBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryBatch() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryBatch()
is true. | |
Method | getRepositoryRulesManager | ||
Description |
Gets a | ||
Return | osid.repository.rules.RepositoryRulesManager | a RepostoryRulesManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRepositoryRules() is false | ||
Compliance | optional | This method must be implemented if supportsRepositoryRules()
is true. |