public interface DocetSearch extends OsidSearch
The search interface for governing docet searches.
Modifier and Type | Method and Description |
---|---|
DocetSearchRecord |
getDocetSearchRecord(Type docetSearchRecordType)
Gets the docet search record corresponding to the given docet search
record
Type. |
void |
orderDocetResults(DocetSearchOrder docetSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDocets(IdList docetIds)
Execute this search among the given list of docets.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDocets(IdList docetIds)
docetIds
- list of docetsNullArgumentException
- docetIds
is
null
mandatory
- This method must be implemented. void orderDocetResults(DocetSearchOrder docetSearchOrder)
docetSearchOrder
- docet search orderNullArgumentException
- docetSearchOrder
is null
UnsupportedException
- docetSearchOrder
is not of this servicemandatory
- This method must be implemented. DocetSearchRecord getDocetSearchRecord(Type docetSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.docetSearchRecordType
- a docet search record typeNullArgumentException
- docetSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(docetSearchRecordType)
is false
mandatory
- This method must be implemented.