public interface LocationSearch extends OsidSearch
The search interface for governing location searches.
Modifier and Type | Method and Description |
---|---|
LocationSearchRecord |
getLocationSearchRecord(Type locationSearchRecordType)
Gets the record corresponding to the given location search record
Type. |
void |
orderLocationResults(LocationSearchOrder locationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongLocations(IdList locationIds)
Execute this search among the given list of locations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongLocations(IdList locationIds)
locationIds
- list of locationsNullArgumentException
- locationIds
is
null
mandatory
- This method must be implemented. void orderLocationResults(LocationSearchOrder locationSearchOrder)
locationSearchOrder
- location search orderNullArgumentException
- locationSearchOrder
is null
UnsupportedException
- locationSearchOrder
is not of this servicemandatory
- This method must be implemented. LocationSearchRecord getLocationSearchRecord(Type locationSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.locationSearchRecordType
- a location search record typeNullArgumentException
- locationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(locationSearchRecordType)
is
false
mandatory
- This method must be implemented.