OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.ReceiptLookupSession
Implementsosid.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.

MethodgetMailboxId
Description

Gets the Mailbox Id associated with this session.

Returnosid.id.Idthe Mailbox Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMailbox
Description

Gets the Mailbox associated with this session.

Returnosid.messaging.Mailboxthe Mailbox associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupReceipts
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeReceiptView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryReceiptView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedMailboxView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMailboxView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this mailbox only.

CompliancemandatoryThis method is must be implemented.
MethodgetReceipt
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.

Parametersosid.id.IdreceiptIdthe Id of the Receipt to retrieve
Returnosid.messaging.Receiptthe returned Receipt
ErrorsNOT_FOUNDno Receipt found with the given Id
NULL_ARGUMENT receiptId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsByIds
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.

Parametersosid.id.IdListreceiptIdsthe list of Ids to retrieve
Returnosid.messaging.ReceiptListthe returned Receipt list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT receiptIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsByGenusType
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.

Parametersosid.type.TypereceiptGenusTypea receipt genus type
Returnosid.messaging.ReceiptListthe returned Receipts list
ErrorsNULL_ARGUMENT receiptGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsByParentGenusType
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

Parametersosid.type.TypereceiptGenusTypea receipt genus type
Returnosid.messaging.ReceiptListthe returned Receipts list
ErrorsNULL_ARGUMENT receiptGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsByRecordType
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.

Parametersosid.type.TypereceiptRecordTypea receipt record type
Returnosid.messaging.ReceiptListthe returned Receipt list
ErrorsNULL_ARGUMENT receiptRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsForMessage
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.

Parametersosid.id.IdmessageIda message Id
Returnosid.messaging.ReceiptListthe returned Receipt list
ErrorsNULL_ARGUMENT messageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsForRecipient
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.messaging.ReceiptListthe returned Receipts
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceiptsForMessageAndRecipient
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.

Parametersosid.id.IdmessageIda message Id
osid.id.IdresourceIda resource Id
Returnosid.messaging.ReceiptListthe returned Receipt
ErrorsNULL_ARGUMENT messageId or recipientId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReceipts
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.

Returnosid.messaging.ReceiptListthe returned Receipt
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.