public interface CandidateSearch extends OsidSearch
The search interface for governing candidate searches.
Modifier and Type | Method and Description |
---|---|
CandidateSearchRecord |
getCandidateSearchRecord(Type candidateSearchRecordType)
Gets the candidate search record corresponding to the given candidate
search record
Type. |
void |
orderCandidateResults(CandidateSearchOrder candidateSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCandidates(IdList candidateIds)
Execute this search among the given list of candidates.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCandidates(IdList candidateIds)
candidateIds
- list of candidate Ids
NullArgumentException
- candidateIds
is
null
mandatory
- This method must be implemented. void orderCandidateResults(CandidateSearchOrder candidateSearchOrder)
candidateSearchOrder
- candidate search orderNullArgumentException
- order
is
null
UnsupportedException
- order
is not of
this servicemandatory
- This method must be implemented. CandidateSearchRecord getCandidateSearchRecord(Type candidateSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.candidateSearchRecordType
- a candidate search record typeNullArgumentException
-
candidateSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordTypeType(candidateSearchRecordType)
is
false
mandatory
- This method must be implemented.