Interface EffortSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EffortSearch
extends OsidSearch

The search interface for governing effort searches.

Method Summary

Modifier and Type	Method	Description
EffortSearchRecord	getEffortSearchRecord(Type effortSearchRecordType)	Gets the effort search record corresponding to the given effort search record Type.
void	orderEffortResults(EffortSearchOrder effortSearchOrder)	Specify an ordering to the search results.
void	searchAmongEfforts(IdList effortIds)	Execute this search among the given list of efforts.

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

searchAmongEfforts

void searchAmongEfforts(IdList effortIds)

Execute this search among the given list of efforts.

Parameters:

effortIds - list of efforts

Throws:

NullArgumentException - effortIds is null

Compliance:

mandatory - This method must be implemented.

orderEffortResults

void orderEffortResults(EffortSearchOrder effortSearchOrder)

Specify an ordering to the search results.

Parameters:

effortSearchOrder - effort search order

Throws:

NullArgumentException - effortSearchOrder is null

UnsupportedException - effortSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEffortSearchRecord

EffortSearchRecord getEffortSearchRecord(Type effortSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

effortSearchRecordType - an effort search record type

Returns:

the effort search record

Throws:

NullArgumentException - effortSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(effortSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.