OSID - osid.contact.ContactSearchSession Service Interface Definition

Interface	osid.contact.ContactSearchSession
Implements	`osid.contact.ContactQuerySession`
Description	This session provides methods for searching `Contact` objects. The search query is constructed using the `ContactQuery.` The contact record `Type` also specifies the record for the contact query. `getContactsByQuery()` is the basic search method and returns a list of `AddressBook` elements. A more advanced search may be performed with `getContactsBySearch().` It accepts a `ContactSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getContactsBySearch()` returns a `ContactSearchResults` that can be used to access the resulting `ContactList` or be used to perform a search within the result set through `ContactSearch.` Contacts may have a query record indicated by their respective record types. The query record is accessed via the `ContactQuery.` The returns in this session may not be cast directly to these interfaces.
Method	getContactSearch
Description	Gets a contact search.
Return	`osid.contact.ContactSearch`		the contact search
Compliance	`mandatory`		This method must be implemented.
Method	getContactSearchOrder
Description	Gets a contact search order. The `ContactSearchOrder` is supplied to a `ContactSearch` to specify the ordering of results.
Return	`osid.contact.ContactSearchOrder`		the contact search order interface
Compliance	`mandatory`		This method must be implemented.
Method	getContactsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.contact.ContactQuery`	`contactQuery`	the contact query
Parameters	`osid.contact.ContactSearch`	`contactSearch`	the contact search
Return	`osid.contact.ContactSearchResults`		the contact search results
Errors	NULL_ARGUMENT		`contactQuery` or `contactSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`contactQuery` or `contactSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getContactQueryFromInspector
Description	Gets a contact query from an inspector. The inspector is available from a `ContactSearchResults.`
Parameters	`osid.contact.ContactQueryInspector`	`contactQueryInspector`	a contact query inspector
Return	`osid.contact.ContactQuery`		the contact query
Errors	NULL_ARGUMENT		`contactQueryInspector` is `null`
Errors	UNSUPPORTED		`contactQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.