Interface TimePeriodSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TimePeriodSearch
extends OsidSearch

TimePeriodSearch defines the interface for specifying time period search options.

Method Summary

Modifier and Type	Method	Description
TimePeriodSearchRecord	getTimePeriodSearchRecord(Type timePeriodSearchRecordType)	Gets the time period search record corresponding to the given time period search record Type .This method is used to retrieve an object implementing the requested record.
void	orderTimePeriodResults(TimePeriodSearchOrder timePeriodSearchOrder)	Specify an ordering to the search results.
void	searchAmongTimePeriods(IdList timePeriodIds)	Execute this search among the given list of time 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

searchAmongTimePeriods

void searchAmongTimePeriods(IdList timePeriodIds)

Execute this search among the given list of time periods.

Parameters:

timePeriodIds - list of time periods

Throws:

NullArgumentException - timePeriodIds is null

Compliance:

mandatory - This method must be implemented.

orderTimePeriodResults

void orderTimePeriodResults(TimePeriodSearchOrder timePeriodSearchOrder)

Specify an ordering to the search results.

Parameters:

timePeriodSearchOrder - time period search order

Throws:

NullArgumentException - timePeriodSearchOrder is null

UnsupportedException - timePeriodSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchRecord

TimePeriodSearchRecord getTimePeriodSearchRecord(Type timePeriodSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

timePeriodSearchRecordType - a time period search record type

Returns:

the time period search record

Throws:

NullArgumentException - timePeriodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.