OSID - osid.messaging.Receipt Service Interface Definition

Interface	osid.messaging.Receipt
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Description	A `Message` receipt is generated when a message is received by a receiving agent.
Method	getMessageId
Description	Gets the `Id` of the `Message.`
Return	`osid.id.Id`		the message `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getMessage
Description	Gets the `Message.`
Return	`osid.messaging.Message`		the message
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReceivedTime
Description	Gets the time the message was received.
Return	`osid.calendaring.DateTime`		the time
Compliance	`mandatory`		This method must be implemented.
Method	getReceivingAgentId
Description	Gets the `Id` of the `Agent` that received this message at this endpoint.
Return	`osid.id.Id`		the receiving agent `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getReceivingAgent
Description	Gets the `Agent` that received this message at this endpoint.
Return	`osid.authentication.Agent`		the receiving agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRecipientId
Description	Gets the `Id` of the `Resource` that received this message at this endpoint.
Return	`osid.id.Id`		the recipient `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getRecipient
Description	Gets the `Resource` that received this message at this endpoint.
Return	`osid.resource.Resource`		the recipient
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptRecord
Description	Gets the receipt record corresponding to the given `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` .
Parameters	`osid.type.Type`	`receiptRecordType`	the receipt record type
Return	`osid.messaging.records.ReceiptRecord`		the receipt record
Errors	NULL_ARGUMENT		`receiptRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(receiptRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.