OSID - osid.messaging.MessageQuerySession Service Interface Definition

Interface	osid.messaging.MessageQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.messaging.MessageSearchSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods for searching among `Message` objects. The search query is constructed using the `MessageQuery`. This session defines views that offer differing behaviors for searching. federated mailbox view: searches include messages in mailboxes of which this mailbox is a ancestor in the mailbox hierarchy isolated mailbox view: searches are restricted to messages in this mailbox Messages may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchMessages
Description	Tests if this user can perform `Message` 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	useFederatedMailboxView
Description	Federates the view for methods in this session. A federated view will include messages in mailboxes which are children of this mailbox in the mailbox hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMailboxView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this mailbox only.
Compliance	`mandatory`		This method is must be implemented.
Method	getMessageQuery
Description	Gets a message query. The returned query will not have an extension query.
Return	`osid.messaging.MessageQuery`		the message query
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByQuery
Description	Gets a list of `Messages` matching the given message query.
Parameters	`osid.messaging.MessageQuery`	`messageQuery`	the message query
Return	`osid.messaging.MessageList`		the returned `MessageList`
Errors	NULL_ARGUMENT		`messageQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`messageQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.