Interface AwardEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AwardEntrySearch
extends OsidSearch

The search interface for governing award entry searches.

Method Summary

Modifier and Type	Method	Description
AwardEntrySearchRecord	getAwardEntrySearchRecord(Type awardEntrySearchRecordType)	Gets the award entry search record corresponding to the given award entry search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAwardEntryResults(AwardEntrySearchOrder awardEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongAwardEntries(IdList awardEntryIds)	Execute this search among the given list of award entries.

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

searchAmongAwardEntries

void searchAmongAwardEntries(IdList awardEntryIds)

Execute this search among the given list of award entries.

Parameters:

awardEntryIds - list of award entry Ids

Throws:

NullArgumentException - awardEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderAwardEntryResults

void orderAwardEntryResults(AwardEntrySearchOrder awardEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

awardEntrySearchOrder - award entry search order

Throws:

NullArgumentException - awardEntrySearchOrder is null

UnsupportedException - awardEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAwardEntrySearchRecord

AwardEntrySearchRecord getAwardEntrySearchRecord(Type awardEntrySearchRecordType)
                                          throws OperationFailedException

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

Parameters:

awardEntrySearchRecordType - an award entry search record type

Returns:

the award entry search record

Throws:

NullArgumentException - awardEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.