blackboard.data
Class ReceiptMessage

java.lang.Object
  blackboard.data.ReceiptMessage

All Implemented Interfaces:

java.io.Serializable

public class ReceiptMessage
extends java.lang.Object
implements java.io.Serializable

A single receipt message that can be attached to a ReceiptOptions object and then sent on the request to be displayed on the next page. See InlineReceiptTag for more information on how to use.

Since:

Blackboard 7.2

Version:

$Revision: #1 $

See Also:

Serialized Form

Nested Class Summary

static class

ReceiptMessage.messageTypeEnum

Constructor Summary

ReceiptMessage()

ReceiptMessage(java.lang.String msg)

ReceiptMessage(java.lang.String msg, java.lang.Exception e)

ReceiptMessage(java.lang.String msg, ReceiptMessage.messageTypeEnum type)

ReceiptMessage(java.lang.String msg, ReceiptMessage.messageTypeEnum type, java.lang.Exception e)

Method Summary

java.lang.Exception	getException()
java.lang.String	getMessage()
ReceiptMessage.messageTypeEnum	getType()
boolean	isError()
boolean	isSuccess()
void	setException(java.lang.Exception exception)
void	setMessage(java.lang.String message)
void	setType(ReceiptMessage.messageTypeEnum type)
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()

ReceiptMessage

public ReceiptMessage(java.lang.String msg)

ReceiptMessage

public ReceiptMessage(java.lang.String msg,
                      java.lang.Exception e)

ReceiptMessage

public ReceiptMessage(java.lang.String msg,
                      ReceiptMessage.messageTypeEnum type)

ReceiptMessage

public ReceiptMessage(java.lang.String msg,
                      ReceiptMessage.messageTypeEnum type,
                      java.lang.Exception e)

Method Detail

getException

public java.lang.Exception getException()

Returns:

Returns the _exception.

setException

public void setException(java.lang.Exception exception)

Parameters:

_exception - The _exception to set.

getMessage

public java.lang.String getMessage()

Returns:

Returns the _message.

setMessage

public void setMessage(java.lang.String message)

Parameters:

_message - The _message to set.

getType

public ReceiptMessage.messageTypeEnum getType()

Returns:

Returns the _type.

isSuccess

public boolean isSuccess()

isError

public boolean isError()

setType

public void setType(ReceiptMessage.messageTypeEnum type)

Parameters:

_type - The _type to set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object