Package org.certificateservices.messages.receipts

Class ReceiptMessage

java.lang.Object

org.certificateservices.messages.receipts.ReceiptMessage

public class ReceiptMessage
extends java.lang.Object

Value object containing all the information about a receipt message.

Constructor Summary

Constructors

Constructor	Description
ReceiptMessage(java.lang.String messageId, ReceiptStatus status, java.lang.String errorDescription)	Default constructor for a receipt message.
ReceiptMessage(java.lang.String messageId, ReceiptStatus status, java.lang.String errorDescription, java.util.Date timeStamp)	Default constructor for a receipt message.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getErrorDescription()
java.lang.String	getMessageId()
ReceiptStatus	getStatus()
java.util.Date	getTimeStamp()
void	setErrorDescription(java.lang.String errorDescription)
void	setMessageId(java.lang.String messageId)
void	setStatus(ReceiptStatus status)
void	setTimeStamp(java.util.Date timeStamp)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReceiptMessage

public ReceiptMessage(java.lang.String messageId,
                      ReceiptStatus status,
                      java.lang.String errorDescription)

Default constructor for a receipt message.

Parameters:

messageId - the id of the message, never null

status -

errorDescription - optional error description, or null if not applicable.

ReceiptMessage

public ReceiptMessage(java.lang.String messageId,
                      ReceiptStatus status,
                      java.lang.String errorDescription,
                      java.util.Date timeStamp)

Default constructor for a receipt message.

Parameters:

messageId - the id of the message, never null

status -

errorDescription - optional error description, or null if not applicable.

timeStamp - the timestamp when the reciept was sent, optional can be null

Method Detail

getMessageId

public java.lang.String getMessageId()

Returns:

the id of the message, never null

setMessageId

public void setMessageId(java.lang.String messageId)

Parameters:

messageId - the id of the message, never null

getStatus

public ReceiptStatus getStatus()

Returns:

the current status of the message.

setStatus

public void setStatus(ReceiptStatus status)

Parameters:

status - the current status of the message.

getErrorDescription

public java.lang.String getErrorDescription()

Returns:

optional error description, or null if not applicable.

setErrorDescription

public void setErrorDescription(java.lang.String errorDescription)

Parameters:

errorDescription - optional error description, or null if not applicable.

getTimeStamp

public java.util.Date getTimeStamp()

Returns:

the timestamp when the reciept was sent, optional can be null

setTimeStamp

public void setTimeStamp(java.util.Date timeStamp)

Parameters:

timeStamp - the timestamp when the reciept was sent, optional can be null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object