OSID - osid.contact.rules.ContactEnablerSearchSession Service Interface Definition

Interface	osid.contact.rules.ContactEnablerSearchSession
Implements	`osid.contact.rules.ContactEnablerQuerySession`
Used By	`osid.contact.rules.ContactRulesManager`
Used By	`osid.contact.rules.ContactRulesProxyManager`
Description	This session provides methods for searching among `ContactEnabler` objects. The search query is constructed using the `ContactEnableryQuery` . `getContactEnablersByQuery()` is the basic search method and returns a list of `ContactEnablers` . A more advanced search may be performed with `getContactEnablersBySearch()` . It accepts a `ContactEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getContactEnablersBySearch()` returns a `ContactEnablerSearchResults` that can be used to access the resulting `ContactEnablerList` or be used to perform a search within the result set through `ContactEnablerSearch` . This session defines views that offer differing behaviors for searching. federated address book view: searches include contact enablers in address books of which this address book is an ancestor in the address book hierarchy isolated address book view: searches are restricted to contact enablers in this address book `ContactEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ContactEnablerQuery` .
Method	getContactEnablerSearch
Description	Gets a contact enabler search.
Return	`osid.contact.rules.ContactEnablerSearch`		the contact enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablerSearchOrder
Description	Gets a contact enabler search order. The `ContactEnablerSearchOrder` is supplied to a `ContactEnablerSearch` to specify the ordering of results.
Return	`osid.contact.rules.ContactEnablerSearchOrder`		the contact enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.contact.rules.ContactEnablerQuery`	`contactEnablerQuery`	the contact enabler query
Parameters	`osid.contact.rules.ContactEnablerSearch`	`contactEnablerSearch`	the contact enabler search
Return	`osid.contact.rules.ContactEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`contactEnablerQuery` or `contactEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`contactEnablerQuery` or `contactEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablerQueryFromInspector
Description	Gets a contact enabler query from an inspector. The inspector is available from a `ContactEnablerSearchResults` .
Parameters	`osid.contact.rules.ContactEnablerQueryInspector`	`contactEnablerQueryInspector`	a contact enabler query inspector
Return	`osid.contact.rules.ContactEnablerQuery`		the contact enabler query
Errors	NULL_ARGUMENT		`contactEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`contactEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.