public interface ReceiptLookupSession extends OsidSession
This session defines methods for retrieving receipts to messages.
This lookup session defines several views:
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupReceipts()
Tests if this user can perform
Receipt lookups. |
Mailbox |
getMailbox()
Gets the
Mailbox associated with this session. |
Id |
getMailboxId()
Gets the
Mailbox Id associated with this
session. |
Receipt |
getReceipt(Id receiptId)
Gets the
Receipt specified by its Id. |
ReceiptList |
getReceipts()
Gets all
Receipts. |
ReceiptList |
getReceiptsByGenusType(Type receiptGenusType)
Gets a
ReceiptList corresponding to the given receipt
genus Type which does not include receipts of types
derived from the specified Type. |
ReceiptList |
getReceiptsByIds(IdList receiptIds)
Gets a
ReceiptList corresponding to the given
IdList. |
ReceiptList |
getReceiptsByParentGenusType(Type receiptGenusType)
Gets a
ReceiptList corresponding to the given receipt
genus Type and include any additional receipts with
genus types derived from the specified Type. |
ReceiptList |
getReceiptsByRecordType(Type receiptRecordType)
Gets a
ReceiptList containing the given receipt record
Type. |
ReceiptList |
getReceiptsForMessage(Id messageId)
Gets a
ReceiptList for the given message. |
ReceiptList |
getReceiptsForMessageAndRecipient(Id messageId,
Id resourceId)
Gets a list of
Receipts for the given message and
recipient. |
ReceiptList |
getReceiptsForRecipient(Id resourceId)
Gets a
ReceiptList for the given recipient. |
void |
useComparativeReceiptView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedMailboxView()
Federates the view for methods in this session.
|
void |
useIsolatedMailboxView()
Isolates the view for methods in this session.
|
void |
usePlenaryReceiptView()
A complete view of the
Receipt returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMailboxId()
Mailbox
Id
associated with this
session. Mailbox Id
associated with this sessionmandatory
- This method must be implemented. Mailbox getMailbox() throws OperationFailedException, PermissionDeniedException
Mailbox
associated with this session. Mailbox
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupReceipts()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeReceiptView()
mandatory
- This method is must be implemented. void usePlenaryReceiptView()
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.mandatory
- This method is must be implemented. void useFederatedMailboxView()
mandatory
- This method is must be implemented. void useIsolatedMailboxView()
mandatory
- This method is must be implemented. Receipt getReceipt(Id receiptId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.receiptId
- the Id
of the Receipt
to retrieve Receipt
NotFoundException
- no Receipt
found
with the given Id
NullArgumentException
- receiptId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsByIds(IdList receiptIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.receiptIds
- the list of Ids
to retrieve Receipt list
NotFoundException
- an Id was
not foundNullArgumentException
- receiptIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsByGenusType(Type receiptGenusType) throws OperationFailedException, PermissionDeniedException
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.receiptGenusType
- a receipt genus type Receipts
listNullArgumentException
- receiptGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsByParentGenusType(Type receiptGenusType) throws OperationFailedException, PermissionDeniedException
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 sessionreceiptGenusType
- a receipt genus type Receipts
listNullArgumentException
- receiptGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsByRecordType(Type receiptRecordType) throws OperationFailedException, PermissionDeniedException
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.receiptRecordType
- a receipt record type Receipt
listNullArgumentException
- receiptRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsForMessage(Id messageId) throws OperationFailedException, PermissionDeniedException
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.messageId
- a message Id
Receipt
listNullArgumentException
- messageId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
Receipts
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceiptsForMessageAndRecipient(Id messageId, Id resourceId) throws OperationFailedException, PermissionDeniedException
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.messageId
- a message Id
resourceId
- a resource Id
Receipt
NullArgumentException
- messageId
or
recipientId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReceiptList getReceipts() throws OperationFailedException, PermissionDeniedException
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. Receipt
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.