OSID - osid.contact.AddressSearchSession Service Interface Definition

Interface	osid.contact.AddressSearchSession
Implements	`osid.contact.AddressQuerySession`
Used By	`osid.contact.ContactManager`
Used By	`osid.contact.ContactProxyManager`
Description	This session provides methods for searching `Addresses` . The search query is constructed using the `AddressQuery` . The address record `Type` also specifies the record for the address query. `getAddressesByQuery()` is the basic search method and returns a list of `Address` elements. A more advanced search may be performed with `getAddressesBySearch()` .It accepts an `AddressSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAddressesBySearch()` returns an `AddressSearchResults` that can be used to access the resulting `AddressList` or be used to perform a search within the result set through `AddressSearch` . Addresses may have a query record indicated by their respective record types. The query record is accessed via the `AddressQuery` . The returns in this session may not be cast directly to these interfaces.
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 `AddressSearchOrder` is supplied to an `AddressSearch` to specify the ordering of results.
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
Parameters	`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 `AddressSearchResults` .
Parameters	`osid.contact.AddressQueryInspector`	`addressQueryInspector`	an address query inspector
Return	`osid.contact.AddressQuery`		the address book query
Errors	NULL_ARGUMENT		`addressQueryInspector` is `null`
Errors	UNSUPPORTED		`addressQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.