public interface AddressSearch extends OsidSearch
The search interface for governing address searches.
Modifier and Type | Method and Description |
---|---|
AddressSearchRecord |
getAddressSearchRecord(Type addressSearchRecordType)
Gets the address search record corresponding to the given address
search record
Type. |
void |
orderAddressResults(AddressSearchOrder addressSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAddresses(IdList addressIds)
Execute this search among the given list of addresses.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAddresses(IdList addressIds)
addressIds
- list of addressesNullArgumentException
- addressIds
is
null
mandatory
- This method must be implemented. void orderAddressResults(AddressSearchOrder addressSearchOrder)
addressSearchOrder
- address search orderNullArgumentException
- addressSearchOrder
is null
UnsupportedException
- addressSearchOrder
is not of this servicemandatory
- This method must be implemented. AddressSearchRecord getAddressSearchRecord(Type addressSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.addressSearchRecordType
- an address search record typeNullArgumentException
- addressSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(addressSearchRecordType)
is false
mandatory
- This method must be implemented.