OSID - osid.messaging.Message Service Interface Definition

Interface	osid.messaging.Message
Implements	`osid.OsidObject`
Used By	`osid.messaging.MessageAdminSession`
	`osid.messaging.MessageList`
	`osid.messaging.MessageLookupSession`
	`osid.messaging.Receipt`
Description	A `Message`.
Method	getSubjectLine
Description	Gets the subject line of this message.
Return	`osid.locale.DisplayText`		the subject
Compliance	`mandatory`		This method must be implemented.
Method	getText
Description	Gets the text of the message.
Return	`osid.locale.DisplayText`		the text
Compliance	`mandatory`		This method must be implemented.
Method	isSent
Description	Tests if this message has been sent.
Return	`boolean`		`true` if this message has been sent, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSentTime
Description	Gets the time this message was sent.
Return	`osid.calendaring.DateTime`		the time
Errors	ILLEGAL_STATE		`isSent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSenderId
Description	Gets the sender `Id` of this message.
Return	`osid.id.Id`		the sender agent `Id`
Errors	ILLEGAL_STATE		`isSent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSender
Description	Gets the sender of this message.
Return	`osid.resource.Resource`		the sender
Errors	ILLEGAL_STATE		`isSent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSendingAgentId
Description	Gets the sending agent `Id` of this message.
Return	`osid.id.Id`		the sending agent `Id`
Errors	ILLEGAL_STATE		`isSent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSendingAgent
Description	Gets the sending agent of this message.
Return	`osid.authentication.Agent`		the sending agent
Errors	ILLEGAL_STATE		`isSent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReceivedTime
Description	Gets the time this message was received.
Return	`osid.calendaring.DateTime`		the time
Errors	ILLEGAL_STATE		`isSent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRecipientIds
Description	Gets the list of all addressed recipient `Ids` of this message.
Return	`osid.id.IdList`		the recipient resource `Ids`
Errors	ILLEGAL_STATE		`isSent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRecipients
Description	Gets the list of all addressed recipients of this message.
Return	`osid.resource.ResourceList`		the recpient resources
Errors	ILLEGAL_STATE		`isSent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isRecipient
Description	Tests if the resource related to the authenticated agent is one of the recipients of this message.
Return	`boolean`		`true` if this agent is a recipient, `false` otherwise
Errors	ILLEGAL_STATE		`isSent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptId
Description	Gets the receipt `Id` for this message. A receipt is available for the receiver of this message.
Return	`osid.id.Id`		the receipt `Id`
Errors	ILLEGAL_STATE		`isRecipient()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getReceipt
Description	Gets the receipt for this message. A receipt is available for the receiver of this message.
Return	`osid.messaging.Receipt`		the receipt
Errors	ILLEGAL_STATE		`isRecipient()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getMessageRecord
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`.
Parameters	`osid.type.Type`	`messageRecordType`	the message record type
Return	`osid.messaging.records.MessageRecord`		the message record
Errors	NULL_ARGUMENT		`messageRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(messageRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.