OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.Message
Implementsosid.OsidObject
Description

A Message.

MethodgetSubjectLine
Description

Gets the subject line of this message.

Returnosid.locale.DisplayTextthe subject
CompliancemandatoryThis method must be implemented.
MethodgetText
Description

Gets the text of the message.

Returnosid.locale.DisplayTextthe text
CompliancemandatoryThis method must be implemented.
MethodisSent
Description

Tests if this message has been sent.

Returnboolean true if this message has been sent, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSentTime
Description

Gets the time this message was sent.

Returnosid.calendaring.DateTimethe time
ErrorsILLEGAL_STATE isSent() is false
CompliancemandatoryThis method must be implemented.
MethodgetSenderId
Description

Gets the sender Id of this message.

Returnosid.id.Idthe sender agent Id
ErrorsILLEGAL_STATE isSent() is false
CompliancemandatoryThis method must be implemented.
MethodgetSender
Description

Gets the sender of this message.

Returnosid.resource.Resourcethe sender
ErrorsILLEGAL_STATE isSent() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSendingAgentId
Description

Gets the sending agent Id of this message.

Returnosid.id.Idthe sending agent Id
ErrorsILLEGAL_STATE isSent() is false
CompliancemandatoryThis method must be implemented.
MethodgetSendingAgent
Description

Gets the sending agent of this message.

Returnosid.authentication.Agentthe sending agent
ErrorsILLEGAL_STATE isSent() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetReceivedTime
Description

Gets the time this message was received.

Returnosid.calendaring.DateTimethe time
ErrorsILLEGAL_STATE isSent() is false
CompliancemandatoryThis method must be implemented.
MethodgetRecipientIds
Description

Gets the list of all addressed recipient Ids of this message.

Returnosid.id.IdListthe recipient resource Ids
ErrorsILLEGAL_STATE isSent() is false
CompliancemandatoryThis method must be implemented.
MethodgetRecipients
Description

Gets the list of all addressed recipients of this message.

Returnosid.resource.ResourceListthe recpient resources
ErrorsILLEGAL_STATE isSent() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisRecipient
Description

Tests if the resource related to the authenticated agent is one of the recipients of this message.

Returnboolean true if this agent is a recipient, false otherwise
ErrorsILLEGAL_STATE isSent() is false
CompliancemandatoryThis method must be implemented.
MethodgetReceiptId
Description

Gets the receipt Id for this message. A receipt is available for the receiver of this message.

Returnosid.id.Idthe receipt Id
ErrorsILLEGAL_STATE isRecipient() is false
CompliancemandatoryThis method must be implemented.
MethodgetReceipt
Description

Gets the receipt for this message. A receipt is available for the receiver of this message.

Returnosid.messaging.Receiptthe receipt
ErrorsILLEGAL_STATE isRecipient() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetMessageRecord
Description

Gets the message record corresponding to the given 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 .

Parametersosid.type.TypemessageRecordTypethe message record type
Returnosid.messaging.records.MessageRecordthe message record
ErrorsNULL_ARGUMENT messageRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(messageRecordType) is false
CompliancemandatoryThis method must be implemented.