Interface | osid.repository.RepositorySearchSession | ||
---|---|---|---|
Implements | osid.repository.RepositoryQuerySession | ||
Description |
This session provides methods for searching among Repositories may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getRepositorySearch | ||
Description |
Gets a repository search. | ||
Return | osid.repository.RepositorySearch | the repository search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRepositorySearchOrder | ||
Description |
Gets a repository search order. The | ||
Return | osid.repository.RepositorySearchOrder | the repository search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRepositoriesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.repository.RepositoryQuery | repositoryQuery | the repository query |
osid.repository.RepositorySearch | repositorySearch | the repository search | |
Return | osid.repository.RepositorySearchResults | the repository search results | |
Errors | NULL_ARGUMENT | repositoryQuery or repositorySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | repositoryQuery or repositorySearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRepositoryQueryFromInspector | ||
Description |
Gets a repository query from an inspector. The
inspector is available from a | ||
Parameters | osid.repository.RepositoryQueryInspector | repositoryQueryInspector | a repository query inspector |
Return | osid.repository.RepositoryQuery | the repository query | |
Errors | NULL_ARGUMENT | repositoryQueryInspector is null | |
UNSUPPORTED | repositoryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |