OSID - osid.messaging.ReceiptQuerySession Service Interface Definition

Interface	osid.messaging.ReceiptQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.messaging.ReceiptSearchSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods for searching among `Receipt` objects. The search query is constructed using the `ReceiptQuery`. This session defines views that offer differing behaviors for searching. federated mailbox view: searches include receipts in mailboxes of which this mailbox is a ancestor in the mailbox hierarchy isolated mailbox view: searches are restricted to receipts in this mailbox Receipts may have a query record indicated by their respective record types. The query record is accessed via the `ReceiptQuery`. Like all `OsidSessions`, `ReceiptQuerySessions` 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	canSearchReceipts
Description	Tests if this user can perform `Receipt` 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 receipts in mailboxes which are children of this mailbox in the mailbox hierarchy.
Compliance	`mandatory`		This method 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 must be implemented.
Method	getReceiptQuery
Description	Gets a receipt query. The returned query will not have an extension query.
Return	`osid.messaging.ReceiptQuery`		the receipt query
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsByQuery
Description	Gets a list of `Receipts` matching the given receipt query.
Parameters	`osid.messaging.ReceiptQuery`	`messageQuery`	the receipt query
Return	`osid.messaging.ReceiptList`		the returned `ReceiptList`
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.