| Interface | osid.repository.AssetContentSearchSession | ||
|---|---|---|---|
| Implements | osid.repository.AssetContentQuerySession | ||
| Used By | osid.repository.RepositoryManager | ||
osid.repository.RepositoryProxyManager | |||
| Description |
This session provides methods for searching among
getAssetContentsByQuery() is the basic search
method and returns a list of AssetContents. A
more advanced search may be performed with
getAssetContentsBySearch().It accepts an
AssetContentSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as ordering.
getAssetContentsBySearch() returns an
AssetContentSearchResults that can be used to
access the resulting AssetContentList or be used
to perform a search within the result set through
AssetContentSearch.
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 | getAssetContentSearch | ||
| Description |
Gets an asset content search. | ||
| Return | osid.repository.AssetContentSearch | the asset content search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetContentSearchOrder | ||
| Description |
Gets an asset content search order. The
| ||
| Return | osid.repository.AssetContentSearchOrder | the asset content search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetContentsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.repository.AssetContentQuery | assetContentQuery | the asset content query |
osid.repository.AssetContentSearch | assetContentSearch | the asset content search | |
| Return | osid.repository.AssetContentSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | assetContentQuery or assetContentSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | assetContentQuery or assetContentSearch is not
of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetContentQueryFromInspector | ||
| Description |
Gets an asset content query from an inspector. The
inspector is available from an
| ||
| Parameters | osid.repository.AssetContentQueryInspector | assetContentQueryInspector | an asset content query inspector |
| Return | osid.repository.AssetContentQuery | the asset content query | |
| Errors | NULL_ARGUMENT | assetContentQueryInspector is null | |
| UNSUPPORTED | assetContentQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |