OSID - osid.messaging.ReceiptSmartMailboxSession Service Interface Definition

Interface	osid.messaging.ReceiptSmartMailboxSession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ReceiptQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Receipts`. The receipts may be sequenced using the `ReceiptSearchOrder` from this session. This `Mailbox` has a default query that matches any receipt and a default search order that specifies no sequencing. The queries may be examined using a `ReceiptQueryInspector`. The query may be modified by converting the inspector back to a `ReceiptQuery`. Like all `OsidSessions`, `ReceiptSmartMailboxSessions` are dedicated to single processing threads and a single authenticated user.
Method	getMailboxId
Description	Gets the `Mailbox` `Id` associated with this session.
Return	`osid.id.Id`		the `Mailbox Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMailbox
Description	Gets the `Mailbox` associated with this session.
Return	`osid.messaging.Mailbox`		the `Mailbox` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartMailboxes
Description	Tests if this user can manage smart mailboxes. 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 mailbox management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptQuery
Description	Gets a receipt query.
Return	`osid.messaging.ReceiptQuery`		the receipt query
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptSearchOrder
Description	Gets a receipt search order.
Return	`osid.messaging.ReceiptSearchOrder`		the receipt search order
Compliance	`mandatory`		This method must be implemented.
Method	applyReceiptQuery
Description	Applies a receipt query to this mailbox.
Parameters	`osid.messaging.ReceiptQuery`	`messageQuery`	the receipt query
Errors	NULL_ARGUMENT		`messageQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`messageQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectReceiptQuery
Description	Gets a receipt query inspector for this mailbox.
Return	`osid.messaging.ReceiptQueryInspector`		the receipt query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyReceiptSequencing
Description	Applies a receipt search order to this mailbox.
Parameters	`osid.messaging.ReceiptSearchOrder`	`messageSearchOrder`	the receipt search order
Errors	NULL_ARGUMENT		`messageSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`messageSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptQueryFromInspector
Description	Gets a receipt query from an inspector.
Parameters	`osid.messaging.ReceiptQueryInspector`	`messageQueryInspector`	a receipt query inspector
Return	`osid.messaging.ReceiptQuery`		the receipt query
Errors	NULL_ARGUMENT		`messageQueryInspector` is `null`
Errors	UNSUPPORTED		`messageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.