OSID - osid.messaging.ReceiptLookupSession Service Interface Definition

Interface	osid.messaging.ReceiptLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving receipts to messages. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated mailbox view: All receipt methods in this session operate, retrieve and pertain to receipts and messages defined explicitly in the current mailbox. federated mailbox view: All receipt methods in this session operate, retrieve and pertain to all receipts and messages defined in this mailbox and any other messages implicitly available in this mailbox through mailbox inheritence. The methods `useFederatedReceiptView()` and `useIsolatedReceiptView()` behave as a radio group and one should be selected before invoking any lookup methods. Messages may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Message.`
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	canLookupReceipts
Description	Tests if this user can perform `Receipt` lookups. 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 lookup operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeReceiptView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryReceiptView
Description	A complete view of the `Receipt` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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 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	getReceipt
Description	Gets the `Receipt` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Receipt` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Receipt` and retained for compatibility.
Parameters	`osid.id.Id`	`receiptId`	the `Id` of the `Receipt` to retrieve
Return	`osid.messaging.Receipt`		the returned `Receipt`
Errors	NOT_FOUND		no `Receipt` found with the given `Id`
	NULL_ARGUMENT		`receiptId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsByIds
Description	Gets a `ReceiptList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the receipts specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Receipts` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`receiptIds`	the list of `Ids` to retrieve
Return	`osid.messaging.ReceiptList`		the returned `Receipt list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`receiptIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsByGenusType
Description	Gets a `ReceiptList` corresponding to the given receipt genus `Type` which does not include receipts of types derived from the specified `Type.` In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session.
Parameters	`osid.type.Type`	`receiptGenusType`	a receipt genus type
Return	`osid.messaging.ReceiptList`		the returned `Receipts` list
Errors	NULL_ARGUMENT		`receiptGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsByParentGenusType
Description	Gets a `ReceiptList` corresponding to the given receipt genus `Type` and include any additional receipts with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session
Parameters	`osid.type.Type`	`receiptGenusType`	a receipt genus type
Return	`osid.messaging.ReceiptList`		the returned `Receipts` list
Errors	NULL_ARGUMENT		`receiptGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsByRecordType
Description	Gets a `ReceiptList` containing the given receipt record `Type.` In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session.
Parameters	`osid.type.Type`	`receiptRecordType`	a receipt record type
Return	`osid.messaging.ReceiptList`		the returned `Receipt` list
Errors	NULL_ARGUMENT		`receiptRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsForMessage
Description	Gets a `ReceiptList` for the given message. In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session.
Parameters	`osid.id.Id`	`messageId`	a message `Id`
Return	`osid.messaging.ReceiptList`		the returned `Receipt` list
Errors	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsForRecipient
Description	Gets a `ReceiptList` for the given recipient. In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.messaging.ReceiptList`		the returned `Receipts`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsForMessageAndRecipient
Description	Gets a list of `Receipts` for the given message and recipient. In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session.
Parameters	`osid.id.Id`	`messageId`	a message `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.messaging.ReceiptList`		the returned `Receipt`
Errors	NULL_ARGUMENT		`messageId` or `recipientId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReceipts
Description	Gets all `Receipts.` In plenary mode, the returned list contains all known receipts or an error results. Otherwise, the returned list may contain only those receipts that are accessible through this session.
Return	`osid.messaging.ReceiptList`		the returned `Receipt`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.