Interface | osid.contact.AddressSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing address searches. | ||
Method | searchAmongAddresses | ||
Description |
Execute this search among the given list of addresses. | ||
Parameters | osid.id.IdList | addressIds | list of addresses |
Errors | NULL_ARGUMENT | addressIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAddressResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.contact.AddressSearchOrder | addressSearchOrder | address search order |
Errors | NULL_ARGUMENT | addressSearchOrder is null | |
UNSUPPORTED | addressSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressSearchRecord | ||
Description |
Gets the address search record corresponding to the
given address search record | ||
Parameters | osid.type.Type | addressSearchRecordType | an address search record type |
Return | osid.contact.records.AddressSearchRecord | the address search record | |
Errors | NULL_ARGUMENT | addressSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(addressSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |