OSID - osid.contact.ContactSmartAddressBookSession Service Interface Definition

Interface	osid.contact.ContactSmartAddressBookSession
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. A `ContactQuery` can be retrieved from this session and mapped to this `AddressBook` to create a virtual collection of `Contacts`. The addresses may be sequenced using the `ContactSearchOrder` from this session. This `AddressBook` has a default query that matches any contact and a default search order that specifies no sequencing. The queries may be examined using a `ContactQueryInspector`. The query may be modified by converting the inspector back to a `ContactQuery`.
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	getContactQuery
Description	Gets a contact query.
Return	`osid.contact.ContactQuery`		the contact query
Compliance	`mandatory`		This method must be implemented.
Method	getContactSearchOrder
Description	Gets a contact search order.
Return	`osid.contact.ContactSearchOrder`		the contact search order
Compliance	`mandatory`		This method must be implemented.
Method	applyContactQuery
Description	Applies a contact query to this address book.
Parameters	`osid.contact.ContactQuery`	`contactQuery`	the contact query
Errors	NULL_ARGUMENT		`contactQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`contactQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectContactQuery
Description	Gets a contact query inspector for this address book.
Return	`osid.contact.ContactQueryInspector`		the contact query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyContactSequencing
Description	Applies a contact search order to this address book.
Parameters	`osid.contact.ContactSearchOrder`	`contactSearchOrder`	the contact search order
Errors	NULL_ARGUMENT		`contactSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`contactSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getContactQueryFromInspector
Description	Gets a contact query from an inspector.
Parameters	`osid.contact.ContactQueryInspector`	`contactQueryInspector`	a 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.