| Interface | osid.repository.AssetContentQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Implemented By | osid.repository.AssetContentSearchSession | ||
| Used By | osid.repository.RepositoryManager | ||
osid.repository.RepositoryProxyManager | |||
| Description |
This session provides methods for searching among
This session defines views that offer differing behaviors for searching.
Asset Contents may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getRepositoryId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Repository Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepository | ||
| Description |
Gets the | ||
| Return | osid.repository.Repository | the repository | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSearchAssetContents | ||
| Description |
Tests if this user can perform
| ||
| Return | boolean | false if search methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useFederatedRepositoryView | ||
| Description |
Federates the view for methods in this session. A federated view will include asset contents in repositories which are children of this repository in the repository hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedRepositoryView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts searches to this repository only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getAssetContentQuery | ||
| Description |
Gets an asset content query. | ||
| Return | osid.repository.AssetContentQuery | the asset content query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetContentsByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.repository.AssetContentQuery | assetContentQuery | the asset content query |
| Return | osid.repository.AssetContentList | the returned AssetContentList | |
| Errors | NULL_ARGUMENT | assetContentQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | assetContentQuery did not originate from
getAssetContentQuery() | ||
| Compliance | mandatory | This method must be implemented. | |