| Interface | osid.repository.RepositoryProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.repository.RepositoryProfile | |||
| Used By | osid.orchestration.OrchestrationManager | ||
| Description |
The repository manager provides access to asset lookup and
creation session and provides interoperability tests for
various aspects of this service. Methods in this manager
support the passing of a
| ||
| Method | getAssetLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetLookupSession | an AssetLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetLookupSession | an AssetLookupSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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 the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetQuerySession | an AssetQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 the | ||
| Parameters | osid.id.Id | repositoryId | the Id of the repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetQuerySession | an AssetQuerySession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetSearchSession | an AssetSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetSearchSession | an AssetSearchSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetAdminSession | an AssetAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetAdminSession | an AssetAdminSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetNotificationSession | an AssetNotificationSession | |
| Errors | NULL_ARGUMENT | assetReceiver or proxy 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 | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetNotificationSession | an AssetNotificationSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | assetReceiver, repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetRepositorySession | an AssetRepositorySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetRepositoryAssignmentSession | an AssetRepositoryAsignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetSmartRepositorySession | an AssetSmartRepositorySession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetTemporalSession | an AssetTemporalSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetTemporalSession | an AssetTemporalSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetTemporalAssignmentSession | an AssetTemporalAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetTemporalAssignmentSession | an AssetTemporalAssignmentSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetSpatialSession | an AssetSpatialSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetSpatialSession | an AssetSpatialSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetSpatialAssignmentSession | an AssetSpatialAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetSpatialAssignmentSession | an AssetSpatialAssignmentSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetCompositionSession | an AssetCompositionSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetCompositionDesignSession | an AssetCompositionDesignSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetCompositionDesign() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetCompositionDesign() is true. | |
| Method | getAssetCompositionSessionForRepository | ||
| Description |
Gets the session for composing assets for the given repository. | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetCompositionSession | an AssetCompositionSession | |
| Errors | NOT_FOUND | no Repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetComposition() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAssetComposition()
and supportsVisibleFederation() are true | |
| Method | getAssetCompositionDesignSessionForRepository | ||
| Description |
Gets the session for creating asset compositions for the given repository. | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetCompositionDesignSession | an AssetCompositionDesignSession | |
| Errors | NOT_FOUND | no Repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetCompositionDesign() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetCompositionDesign() and
supportsVisibleFederation() are true | |
| Method | getAssetContentLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetContentLookupSession | an AssetContentLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentLookup() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentLookup() is true. | |
| Method | getAssetContentLookupSessionForRepository | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentLookupSession | an AssetContentLookupSession | |
| Errors | NOT_FOUND | no Repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentLookup() and
supportsVisibleFederation() are true | |
| Method | getAssetContentQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetContentQuerySession | an AssetContentQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentQuery() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentQuery() is true. | |
| Method | getAssetContentQuerySessionForRepository | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentQuerySession | an AssetContentQuerySession | |
| Errors | NOT_FOUND | no repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentQuery() and
supportsVisibleFederation() are true | |
| Method | getAssetContentSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetContentSearchSession | an AssetContentSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentSearch() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentSearch() is true. | |
| Method | getAssetContentSearchSessionForRepository | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentSearchSession | an AssetContentSearchSession | |
| Errors | NOT_FOUND | no repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentSearch() and
supportsVisibleFederation() are true | |
| Method | getAssetContentAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetContentAdminSession | an AssetContentAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentAdmin() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentAdmin() is true. | |
| Method | getAssetContentAdminSessionForRepository | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentAdminSession | an AssetContentAdminSession | |
| Errors | NOT_FOUND | no repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentAdmin() and
supportsVisibleFederation() are true | |
| Method | getAssetContentNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.repository.AssetContentReceiver | assetContentReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentNotificationSession | an AssetContentNotificationSession | |
| Errors | NULL_ARGUMENT | assetContentReceiver or proxy is
null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentNotification() is true. | |
| Method | getAssetContentNotificationSessionForRepository | ||
| Description |
Gets the | ||
| Parameters | osid.repository.AssetContentReceiver | assetContentReceiver | the notification callback |
osid.id.Id | repositoryId | the Id of the Repository | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentNotificationSession | an AssetContentNotificationSession | |
| Errors | NOT_FOUND | no repository found by the given Id | |
| NULL_ARGUMENT | assetContentReceiver, repositoryId, or
proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentNotification() and
supportsVisibleFederation() are true | |
| Method | getAssetContentRepositorySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetContentRepositorySession | an AssetContentRepositorySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentRepository() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentRepository() is true. | |
| Method | getAssetContentRepositoryAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.AssetContentRepositoryAssignmentSession | an AssetContentRepositoryAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentRepositoryAssignment() is
false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentRepositoryAssignment() is true. | |
| Method | getAssetContentSmartRepositorySession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.AssetContentSmartRepositorySession | an AssetContentSmartRepositorySession | |
| Errors | NOT_FOUND | no repository found by the given Id | |
| NULL_ARGUMENT | repositoryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAssetContentSmartRepository() is false | ||
| Compliance | optional | This method must be implemented if
supportsAssetContentSmartRepository() is true. | |
| Method | getCompositionLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.CompositionLookupSession | the new CompositionLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionLookupSession | the new CompositionLookupSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.CompositionSearchSession | a CompositionQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionQuerySession | a CompositionQuerySession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.CompositionSearchSession | a CompositionSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionSearchSession | a CompositionSearchSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.CompositionAdminSession | a CompositionAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 composition administrative session for the given repository. | ||
| Parameters | osid.id.Id | repositoryId | the Id of the repository |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionAdminSession | a CompositionAdminSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionNotificationSession | a CompositionNotificationSession | |
| Errors | NULL_ARGUMENT | compositionReceiver or proxy 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 | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionNotificationSession | a CompositionNotificationSession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | compositionReceiver, repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.CompositionRepositorySession | a CompositionRepositorySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.CompositionRepositoryAssignmentSession | a CompositionRepositoryAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.repository.CompositionSmartRepositorySession | a CompositionSmartRepositorySession | |
| Errors | NOT_FOUND | repositoryId not found | |
| NULL_ARGUMENT | repositoryId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.RepositoryLookupSession | a RepositoryLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.RepositoryQuerySession | a RepositoryQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.RepositorySearchSession | a RepositorySearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.RepositoryAdminSession | a RepositoryAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.RepositoryHierarchySession | a RepositoryHierarchySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.repository.RepositoryHierarchyDesignSession | a RepostoryHierarchyDesignSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsRepositoryHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if
supportsRepositoryHierarchyDesign() is true. | |
| Method | getRepositoryBatchProxyManager | ||
| Description |
Gets a | ||
| Return | osid.repository.batch.RepositoryBatchProxyManager | a RepostoryBatchProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRepositoryBatch() is false | ||
| Compliance | optional | This method must be implemented if supportsRepositoryBatch()
is true. | |
| Method | getRepositoryRulesProxyManager | ||
| Description |
Gets a | ||
| Return | osid.repository.rules.RepositoryRulesProxyManager | a RepostoryRulesProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRepositoryRules() is false | ||
| Compliance | optional | This method must be implemented if supportsRepositoryRules()
is true. | |