Interface PeriodSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PeriodSearch
extends OsidSearch

The search interface for governing period searches.

Method Summary

Modifier and Type	Method	Description
PeriodSearchRecord	getPeriodSearchRecord(Type periodSearchRecordType)	Gets the period search record corresponding to the given period search record Type.
void	orderPeriodResults(PeriodSearchOrder periodSearchOrder)	Specify an ordering to the search results.
void	searchAmongPeriods(IdList periodIds)	Execute this search among the given list of periods.

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

searchAmongPeriods

void searchAmongPeriods(IdList periodIds)

Execute this search among the given list of periods.

Parameters:

periodIds - list of periods

Throws:

NullArgumentException - periodIds is null

Compliance:

mandatory - This method must be implemented.

orderPeriodResults

void orderPeriodResults(PeriodSearchOrder periodSearchOrder)

Specify an ordering to the search results.

Parameters:

periodSearchOrder - period search order

Throws:

NullArgumentException - periodSearchOrder is null

UnsupportedException - periodSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPeriodSearchRecord

PeriodSearchRecord getPeriodSearchRecord(Type periodSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

periodSearchRecordType - a period search record type

Returns:

the period search record

Throws:

NullArgumentException - periodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(periodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.