OSID - osid.contact.AddressQuerySession Service Interface Definition

Interface	osid.contact.AddressQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Address` objects. The search query is constructed using the `AddressQuery.` The address record `Type` also specifies the record for the address query. 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	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	canSearchAddresses
Description	Tests if this user can perform `Address` searches. 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 opt not to offer search 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 addresses in address books which are children of this address book 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 retrievals to this address book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAddressQuery
Description	Gets an address query.
Return	`osid.contact.AddressQuery`		the address query
Compliance	`mandatory`		This method must be implemented.
Method	getAddressesByQuery
Description	Gets a list of `Addresses` matching the given search.
Parameters	`osid.contact.AddressQuery`	`addressQuery`	the address query
Return	`osid.contact.AddressList`		the returned `AddressList`
Errors	NULL_ARGUMENT		`addressQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`addressQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.