Interface CreditSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CreditSearch
extends OsidSearch

The search interface for governing credit searches.

Method Summary

Modifier and Type	Method	Description
CreditSearchRecord	getCreditSearchRecord(Type creditSearchRecordType)	Gets the record corresponding to the given credit search record Type .
void	orderCreditResults(CreditSearchOrder creditSearchOrder)	Specify an ordering to the search results.
void	searchAmongCredits(IdList creditIds)	Execute this search among the given list of credits.

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

searchAmongCredits

void searchAmongCredits(IdList creditIds)

Execute this search among the given list of credits.

Parameters:

creditIds - list of credits

Throws:

NullArgumentException - creditIds is null

Compliance:

mandatory - This method must be implemented.

orderCreditResults

void orderCreditResults(CreditSearchOrder creditSearchOrder)

Specify an ordering to the search results.

Parameters:

creditSearchOrder - credit search order

Throws:

NullArgumentException - creditSearchOrder is null

UnsupportedException - creditSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCreditSearchRecord

CreditSearchRecord getCreditSearchRecord(Type creditSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

creditSearchRecordType - a credit search record type

Returns:

the credit search record

Throws:

NullArgumentException - creditSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(creditSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.