Interface CandidateSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CandidateSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
CandidateQueryInspector	getCandidateQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CandidateList	getCandidates()	Gets the candidate list resulting from a search.
CandidateSearchResultsRecord	getCandidateSearchResultsRecord(Type candidateSearchRecordType)	Gets the candidate search results record corresponding to the given candidate search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getCandidates

CandidateList getCandidates()

Gets the candidate list resulting from a search.

Returns:

the candidate list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCandidateQueryInspector

CandidateQueryInspector getCandidateQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the candidate query inspector

Compliance:

mandatory - This method must be implemented.

getCandidateSearchResultsRecord

CandidateSearchResultsRecord getCandidateSearchResultsRecord(Type candidateSearchRecordType)
                                                      throws OperationFailedException

Gets the candidate search results record corresponding to the given candidate search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

candidateSearchRecordType - a candidate search record type

Returns:

the candidate search results record

Throws:

NullArgumentException - candidateSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(candidateSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.