OSID - osid.messaging.MessageSmartMailboxSession Service Interface Definition

Interface	osid.messaging.MessageSmartMailboxSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `MessageQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Messages.` The messages may be sequenced using the `MessageSearchOrder` from this session. This `Mailbox` has a default query that matches any message and a default search order that specifies no sequencing. The queries may be examined using a `MessageQueryInspector.` The query may be modified by converting the inspector back to a `MessageQuery.`
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	getMessageQuery
Description	Gets a message query.
Return	`osid.messaging.MessageQuery`		the message query
Compliance	`mandatory`		This method must be implemented.
Method	getMessageSearchOrder
Description	Gets a message search order.
Return	`osid.messaging.MessageSearchOrder`		the message search order
Compliance	`mandatory`		This method must be implemented.
Method	applyMessageQuery
Description	Applies a message query to this mailbox.
Parameters	`osid.messaging.MessageQuery`	`messageQuery`	the message 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	inspecMessageQuery
Description	Gets a message query inspector for this mailbox.
Return	`osid.messaging.MessageQueryInspector`		the message query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyMessageSequencing
Description	Applies a message search order to this mailbox.
Parameters	`osid.messaging.MessageSearchOrder`	`messageSearchOrder`	the message 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	getMessageQueryFromInspector
Description	Gets a message query from an inspector.
Parameters	`osid.messaging.MessageQueryInspector`	`messageQueryInspector`	a message query inspector
Return	`osid.messaging.MessageQuery`		the message query
Errors	NULL_ARGUMENT		`messageQueryInspector` is `null`
Errors	UNSUPPORTED		`messageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.