public interface Receipt extends OsidObject, Subjugateable
A Message
receipt is generated when a message is
received by a receiving agent.
Modifier and Type | Method and Description |
---|---|
Message |
getMessage()
Gets the
Message. |
Id |
getMessageId()
Gets the
Id of the Message. |
ReceiptRecord |
getReceiptRecord(Type receiptRecordType)
Gets the receipt record corresponding to the given
Receipt
record Type. |
DateTime |
getReceivedTime()
Gets the time the message was received.
|
Agent |
getReceivingAgent()
Gets the
Agent that received this message at this
endpoint. |
Id |
getReceivingAgentId()
Gets the
Id of the Agent that received
this message at this endpoint. |
Resource |
getRecipient()
Gets the
Resource that received this message at this
endpoint. |
Id |
getRecipientId()
Gets the
Id of the Resource that
received this message at this endpoint. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getMessageId()
Id
of the Message.
Id
mandatory
- This method must be implemented. Message getMessage() throws OperationFailedException
Message.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getReceivedTime()
mandatory
- This method must be implemented. Id getReceivingAgentId()
Id
of the Agent
that received
this message at this endpoint. Id
mandatory
- This method must be implemented. Agent getReceivingAgent() throws OperationFailedException
Agent
that received this message at this
endpoint.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getRecipientId()
Id
of the Resource
that
received this message at this endpoint. Id
mandatory
- This method must be implemented. Resource getRecipient() throws OperationFailedException
Resource
that received this message at this
endpoint.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ReceiptRecord getReceiptRecord(Type receiptRecordType) throws OperationFailedException
Receipt
record Type.
This method is used to retrieve an
object implementing the requested record. The receiptRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(receiptRecordType)
is true
.receiptRecordType
- the receipt record typeNullArgumentException
- receiptRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(receiptRecordType)
is false
mandatory
- This method must be implemented.