public interface AvailabilitySearch extends OsidSearch
The search interface for governing availability searches.
Modifier and Type | Method and Description |
---|---|
AvailabilitySearchRecord |
getAvailabilitySearchRecord(Type availabilitySearchRecordType)
Gets the availability search record corresponding to the given
availability search record
Type. |
void |
orderAvailabilityResults(AvailabilitySearchOrder availabilitySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAvailabilities(IdList availabilityIds)
Execute this search among the given list of availabilities.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAvailabilities(IdList availabilityIds)
availabilityIds
- list of availabilitiesNullArgumentException
- availabilityIds
is null
mandatory
- This method must be implemented. void orderAvailabilityResults(AvailabilitySearchOrder availabilitySearchOrder)
availabilitySearchOrder
- availability search orderNullArgumentException
- availabilitySearchOrder
is null
UnsupportedException
- availabilitySearchOrder
is not of this servicemandatory
- This method must be implemented. AvailabilitySearchRecord getAvailabilitySearchRecord(Type availabilitySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.availabilitySearchRecordType
- an availability search record
typeNullArgumentException
-
availabilitySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(availabilitySearchRecordType)
is
false
mandatory
- This method must be implemented.