public interface CyclicTimePeriodSearch extends OsidSearch
CyclicTimePeriodSearch
defines the interface for
specifying cyclic time period search options.
Modifier and Type | Method and Description |
---|---|
CyclicTimePeriodSearchRecord |
getCyclicTimePeriodSearchRecord(Type cyclicTimePeriodSearchRecordType)
Gets the cyclic time period search record corresponding to the given
cyclic time period search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCyclicTimePeriods(IdList cyclicTimePeriodIds)
cyclicTimePeriodIds
- list of cyclic time periodsNullArgumentException
- cyclicTimePeriodIds
is null
mandatory
- This method must be implemented. void orderCyclicTimePeriodResults(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder)
cyclicTimePeriodSearchOrder
- cyclic time period search orderNullArgumentException
-
cyclicTimePeriodSearchOrder
is null
UnsupportedException
-
cyclicTimePeriodSearchOrder
is not of this servicemandatory
- This method must be implemented. CyclicTimePeriodSearchRecord getCyclicTimePeriodSearchRecord(Type cyclicTimePeriodSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.cyclicTimePeriodSearchRecordType
- a cyclic time period search
record typeNullArgumentException
-
cyclicTimePeriodSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicTimePeriodSearchRecordType)
is
false
mandatory
- This method must be implemented.