public interface RepositorySearch extends OsidSearch
The interface for governing repository searches.
Modifier and Type | Method and Description |
---|---|
RepositorySearchRecord |
getRepositorySearchRecord(Type repositorySearchRecordType)
Gets the repository search record corresponding to the given
repository search record
Type. |
void |
orderRepositoryResults(RepositorySearchOrder repositorySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRepositories(IdList repositoryIds)
Execute this search among the given list of repositories.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRepositories(IdList repositoryIds)
repositoryIds
- list of repositoriesNullArgumentException
- repositoryIds
is
null
mandatory
- This method must be implemented. void orderRepositoryResults(RepositorySearchOrder repositorySearchOrder)
repositorySearchOrder
- repository search orderNullArgumentException
- repositorySearchOrder
is null
UnsupportedException
- repositorySearchOrder
is not of this servicemandatory
- This method must be implemented. RepositorySearchRecord getRepositorySearchRecord(Type repositorySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.repositorySearchRecordType
- a repository search record typeNullArgumentException
-
repositorySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(repositorySearchRecordType)
is
false
mandatory
- This method must be implemented.