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

Interface	osid.contact.rules.ContactEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.contact.rules.ContactEnablerSearchSession`
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 `ContactEnablerQuery`. 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 Contact enablers may have a query record indicated by their respective record types. The query record is accessed via the `ContactEnablerQuery`.
Method	getAddressBookId
Description	Gets the `AddressBook` `Id` associated with this session.
Return	`osid.id.Id`		the `AddressBook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBook
Description	Gets the `AddressBook` associated with this session.
Return	`osid.contact.AddressBook`		the address book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchContactEnablers
Description	Tests if this user can perform `ContactEnabler` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAddressBookView
Description	Federates the view for methods in this session. A federated view will include contact enablers in address books which are children of this broker in the address book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAddressBookView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this address book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getContactEnablerQuery
Description	Gets a contact enabler query.
Return	`osid.contact.rules.ContactEnablerQuery`		the contact enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersByQuery
Description	Gets a list of `ContactEnablers` matching the given contact enabler query.
Parameters	`osid.contact.rules.ContactEnablerQuery`	`contactEnablerQuery`	the contact enabler query
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnablerList`
Errors	NULL_ARGUMENT		`contactEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`contactEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.