public interface Message extends OsidObject
A Message.
Modifier and Type | Method and Description |
---|---|
MessageRecord |
getMessageRecord(Type messageRecordType)
Gets the message record corresponding to the given
Message
record Type. |
Receipt |
getReceipt()
Gets the receipt for this message.
|
Id |
getReceiptId()
Gets the receipt
Id for this message. |
DateTime |
getReceivedTime()
Gets the time this message was received.
|
IdList |
getRecipientIds()
Gets the list of all addressed recipient
Ids of this
message. |
ResourceList |
getRecipients()
Gets the list of all addressed recipients of this message.
|
Resource |
getSender()
Gets the sender of this message.
|
Id |
getSenderId()
Gets the sender
Id of this message. |
Agent |
getSendingAgent()
Gets the sending agent of this message.
|
Id |
getSendingAgentId()
Gets the sending agent
Id of this message. |
DateTime |
getSentTime()
Gets the time this message was sent.
|
DisplayText |
getSubjectLine()
Gets the subject line of this message.
|
DisplayText |
getText()
Gets the text of the message.
|
boolean |
isRecipient()
Tests if the resource related to the authenticated agent is one of the
recipients of this message.
|
boolean |
isSent()
Tests if this message has been sent.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getSubjectLine()
mandatory
- This method must be implemented. DisplayText getText()
mandatory
- This method must be implemented. boolean isSent()
true
if this message has been sent,
false
otherwisemandatory
- This method must be implemented. DateTime getSentTime()
IllegalStateException
- isSent()
is
false
mandatory
- This method must be implemented. Id getSenderId()
Id
of this message. Id
IllegalStateException
- isSent()
is
false
mandatory
- This method must be implemented. Resource getSender() throws OperationFailedException
IllegalStateException
- isSent()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getSendingAgentId()
Id
of this message. Id
IllegalStateException
- isSent()
is
false
mandatory
- This method must be implemented. Agent getSendingAgent() throws OperationFailedException
IllegalStateException
- isSent()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getReceivedTime()
IllegalStateException
- isSent()
is
false
mandatory
- This method must be implemented. IdList getRecipientIds()
Ids
of this
message. Ids
IllegalStateException
- isSent()
is
false
mandatory
- This method must be implemented. ResourceList getRecipients() throws OperationFailedException
IllegalStateException
- isSent()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isRecipient()
true
if this agent is a recipient, false
otherwiseIllegalStateException
- isSent()
is
false
mandatory
- This method must be implemented. Id getReceiptId()
Id
for this message. A receipt is
available for the receiver of this message. Id
IllegalStateException
- isRecipient()
is
false
mandatory
- This method must be implemented. Receipt getReceipt() throws OperationFailedException
IllegalStateException
- isRecipient()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. MessageRecord getMessageRecord(Type messageRecordType) throws OperationFailedException
Message
record Type.
This method is used to retrieve an
object implementing the requested record. The messageRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(messageRecordType)
is true
.messageRecordType
- the message record typeNullArgumentException
- messageRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(messageRecordType)
is false
mandatory
- This method must be implemented.