Interface AwardSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AwardSearch
extends OsidSearch

The search interface for governing award searches.

Method Summary

Modifier and Type	Method	Description
AwardSearchRecord	getAwardSearchRecord(Type awardSearchRecordType)	Gets the award search record corresponding to the given award search record Type.
void	orderAwardResults(AwardSearchOrder awardSearchOrder)	Specify an ordering to the search results.
void	searchAmongAwards(IdList awardIds)	Execute this search among the given list of awards.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAwards

void searchAmongAwards(IdList awardIds)

Execute this search among the given list of awards.

Parameters:

awardIds - list of awards

Throws:

NullArgumentException - awardIds is null

Compliance:

mandatory - This method must be implemented.

orderAwardResults

void orderAwardResults(AwardSearchOrder awardSearchOrder)

Specify an ordering to the search results.

Parameters:

awardSearchOrder - award search order

Throws:

NullArgumentException - awardSearchOrder is null

UnsupportedException - awardSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAwardSearchRecord

AwardSearchRecord getAwardSearchRecord(Type awardSearchRecordType)
                                throws OperationFailedException

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

Parameters:

awardSearchRecordType - an award search record type

Returns:

the award search record

Throws:

NullArgumentException - awardSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.