OSID - osid.contact.AddressBookSearchSession Service Interface Definition

Interface	osid.contact.AddressBookSearchSession
Implements	`osid.contact.AddressBookQuerySession`
Used By	`osid.contact.ContactManager`
Used By	`osid.contact.ContactProxyManager`
Description	This session provides methods for searching `AddressBooks` . The search query is constructed using the `AddressBookQuery` . The address book record `Type` also specifies the record for the address book query. `getAddressBooksByQuery()` is the basic search method and returns a list of `AddressBook` elements. A more advanced search may be performed with `getAddressBooksBySearch()` . It accepts an `AddressBookSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAddressBooksBySearch()` returns an `AddressBookSearchResults` that can be used to access the resulting `AddressBookList` or be used to perform a search within the result set through `AddressBookSearch` . AddressBooks may have a query record indicated by their respective record types. The query record is accessed via the `AddressBookQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getAddressBookSearch
Description	Gets an address book search.
Return	`osid.contact.AddressBookSearch`		the address book search
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBookSearchOrder
Description	Gets an address book search order. The `AddressBookSearchOrder` is supplied to an `AddressBookSearch` to specify the ordering of results.
Return	`osid.contact.AddressBookSearchOrder`		the address book search order
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBooksBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.contact.AddressBookQuery`	`addressBookQuery`	the address book query
Parameters	`osid.contact.AddressBookSearch`	`addressBookSearch`	the address book search
Return	`osid.contact.AddressBookSearchResults`		the address book search results
Errors	NULL_ARGUMENT		`addressBookQuery` or `address books earch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`addressBookQuery` or `address books earch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBookQueryFromInspector
Description	Gets an address book query from an inspector. The inspector is available from an `AddressBookSearchResults` .
Parameters	`osid.contact.AddressBookQueryInspector`	`addressBookQueryInspector`	an address book query inspector
Return	`osid.contact.AddressBookQuery`		the address book query
Errors	NULL_ARGUMENT		`addressBookQueryInspector` is `null`
Errors	UNSUPPORTED		`addressBookQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.