OSID - osid.contact.AddressSmartAddressBookSession Service Interface Definition

Interface	osid.contact.AddressSmartAddressBookSession
Implements	`osid.OsidSession`
Used By	`osid.contact.ContactManager`
Used By	`osid.contact.ContactProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AddressQuery` can be retrieved from this session and mapped to this `AddressBook` to create a virtual collection of `Addresses`. The addresses may be sequenced using the `AddressSearchOrder` from this session. This `AddressBook` has a default query that matches any address and a default search order that specifies no sequencing. The queries may be examined using an `AddressQueryInspector`. The query may be modified by converting the inspector back to an `AddressQuery`.
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 `AddressBook` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartAddressBooks
Description	Tests if this user can manage smart address books. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart address book management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getAddressSearchOrder
Description	Gets an address search order.
Return	`osid.contact.AddressSearchOrder`		the address search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAddressQuery
Description	Applies an address query to this address book.
Parameters	`osid.contact.AddressQuery`	`addressQuery`	the address query
Errors	NULL_ARGUMENT		`addressQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`addressQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAddressQuery
Description	Gets an address query inspector for this address book.
Return	`osid.contact.AddressQueryInspector`		the address query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAddressSequencing
Description	Applies an address search order to this address book.
Parameters	`osid.contact.AddressSearchOrder`	`addressSearchOrder`	the address search order
Errors	NULL_ARGUMENT		`addressSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`addressSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAddressQueryFromInspector
Description	Gets an address query from an inspector.
Parameters	`osid.contact.AddressQueryInspector`	`addressQueryInspector`	a query inspector
Return	`osid.contact.AddressQuery`		the address query
Errors	NULL_ARGUMENT		`addressQueryInspector` is `null`
Errors	UNSUPPORTED		`addressQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.