Interface CyclicTimePeriodSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CyclicTimePeriodSearch
extends OsidSearch

CyclicTimePeriodSearch defines the interface for specifying cyclic time period search options.

Method Summary

Modifier and Type	Method	Description
CyclicTimePeriodSearchRecord	getCyclicTimePeriodSearchRecord(Type cyclicTimePeriodSearchRecordType)	Gets the cyclic time period search record corresponding to the given cyclic time period search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCyclicTimePeriodResults(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder)	Specify an ordering to the search results.
void	searchAmongCyclicTimePeriods(IdList cyclicTimePeriodIds)	Execute this search among the given list of cyclic 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

searchAmongCyclicTimePeriods

void searchAmongCyclicTimePeriods(IdList cyclicTimePeriodIds)

Execute this search among the given list of cyclic time periods.

Parameters:

cyclicTimePeriodIds - list of cyclic time periods

Throws:

NullArgumentException - cyclicTimePeriodIds is null

Compliance:

mandatory - This method must be implemented.

orderCyclicTimePeriodResults

void orderCyclicTimePeriodResults(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder)

Specify an ordering to the search results.

Parameters:

cyclicTimePeriodSearchOrder - cyclic time period search order

Throws:

NullArgumentException - cyclicTimePeriodSearchOrder is null

UnsupportedException - cyclicTimePeriodSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodSearchRecord

CyclicTimePeriodSearchRecord getCyclicTimePeriodSearchRecord(Type cyclicTimePeriodSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

cyclicTimePeriodSearchRecordType - a cyclic time period search record type

Returns:

the cyclic time period search record

Throws:

NullArgumentException - cyclicTimePeriodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicTimePeriodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.