public interface ScheduleSearch extends OsidSearch
ScheduleSearch
defines the interface for specifying
schedule search options.
Modifier and Type | Method and Description |
---|---|
ScheduleSearchRecord |
getScheduleSearchRecord(Type scheduleSearchRecordType)
Gets the schedule search record corresponding to the given schedule
search record
Type. |
void |
orderScheduleResults(ScheduleSearchOrder scheduleSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSchedules(IdList scheduleIds)
Execute this search among the given list of schedules.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSchedules(IdList scheduleIds)
scheduleIds
- list of schedulesNullArgumentException
- scheduleIds
is
null
mandatory
- This method must be implemented. void orderScheduleResults(ScheduleSearchOrder scheduleSearchOrder)
scheduleSearchOrder
- schedule search orderNullArgumentException
- scheduleSearchOrder
is null
UnsupportedException
- scheduleSearchOrder
is not of this servicemandatory
- This method must be implemented. ScheduleSearchRecord getScheduleSearchRecord(Type scheduleSearchRecordType) throws OperationFailedException
Type.
scheduleSearchRecordType
- a schedule search record typeNullArgumentException
- scheduleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleSearchRecordType)
is
false
mandatory
- This method must be implemented.