Interface | osid.contact.AddressSearchSession | ||
---|---|---|---|
Implements | osid.contact.AddressQuerySession | ||
Description |
This session provides methods for searching Addresses may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAddressSearch | ||
Description |
Gets an address search. | ||
Return | osid.contact.AddressSearch | the address search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressSearchOrder | ||
Description |
Gets an address search order. The | ||
Return | osid.contact.AddressSearchOrder | the address search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.contact.AddressQuery | addressQuery | the address query |
osid.contact.AddressSearch | addressSearch | the address search | |
Return | osid.contact.AddressSearchResults | the address search results | |
Errors | NULL_ARGUMENT | addressQuery or addressSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | addressQuery or addressSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressQueryFromInspector | ||
Description |
Gets an address query from an inspector. The inspector
is available from an | ||
Parameters | osid.contact.AddressQueryInspector | addressQueryInspector | an address query inspector |
Return | osid.contact.AddressQuery | the address book query | |
Errors | NULL_ARGUMENT | addressQueryInspector is null | |
UNSUPPORTED | addressQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |