public interface ScheduleSlotSearch extends OsidSearch
ScheduleSlotSearch
defines the interface for specifying
schedule slot search options.
Modifier and Type | Method and Description |
---|---|
ScheduleSlotSearchRecord |
getScheduleSlotSearchRecord(Type scheduleSlotSearchRecordType)
Gets the schedule slot search record corresponding to the given
schedule slot search record
Type. |
void |
orderScheduleSlotResults(ScheduleSlotSearchOrder scheduleSlotSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongScheduleSlots(IdList scheduleSlotIds)
Execute this search among the given list of schedule slots.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongScheduleSlots(IdList scheduleSlotIds)
scheduleSlotIds
- list of schedule slotsNullArgumentException
- scheduleSlotIds
is null
mandatory
- This method must be implemented. void orderScheduleSlotResults(ScheduleSlotSearchOrder scheduleSlotSearchOrder)
scheduleSlotSearchOrder
- schedule slot search orderNullArgumentException
- scheduleSlotSearchOrder
is null
UnsupportedException
- scheduleSlotSearchOrder
is not of this servicemandatory
- This method must be implemented. ScheduleSlotSearchRecord getScheduleSlotSearchRecord(Type scheduleSlotSearchRecordType) throws OperationFailedException
Type.
scheduleSlotSearchRecordType
- a schedule slot search record
typeNullArgumentException
-
scheduleSlotSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleSlotSearchRecordType)
is
false
mandatory
- This method must be implemented.