blackboard.data
Class ReceiptOptions

java.lang.Object
  blackboard.data.ReceiptOptions

All Implemented Interfaces:

java.io.Serializable

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

Object that contains zero or more ReceiptMessage objects for display. See InlineReceiptTag for more information on how to use.

Since:

Blackboard 7.2

Version:

$Revision: #1 $

See Also:

Serialized Form

Constructor Summary

ReceiptOptions()

ReceiptOptions(java.lang.Exception e)

ReceiptOptions(java.lang.String msg)

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

Method Summary

void	addErrorMessage(java.lang.String msg, java.lang.Exception e)
void	addMessage(ReceiptMessage rm)
void	addMessage(java.lang.String msg, ReceiptMessage.messageTypeEnum type, java.lang.Exception e)
void	addMessages(java.util.Collection<ReceiptMessage> messages) Adds all messages to this RecieptOptions
void	addSuccessMessage(java.lang.String msg)
int	getErrorCount()
java.util.ArrayList<ReceiptMessage>	getMessages()
int	getSuccessCount()
boolean	hasError()
void	setErrorCount(int errorCount)
void	setSuccessCount(int successCount)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiptOptions

public ReceiptOptions()

ReceiptOptions

public ReceiptOptions(java.lang.String msg)

ReceiptOptions

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

ReceiptOptions

public ReceiptOptions(java.lang.Exception e)

Method Detail

addSuccessMessage

public void addSuccessMessage(java.lang.String msg)

addErrorMessage

public void addErrorMessage(java.lang.String msg,
                            java.lang.Exception e)

addMessage

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

addMessage

public void addMessage(ReceiptMessage rm)

addMessages

public void addMessages(java.util.Collection<ReceiptMessage> messages)

Adds all messages to this RecieptOptions

Parameters:

ro -

getMessages

public java.util.ArrayList<ReceiptMessage> getMessages()

Returns:

Returns the _messages. No setter, because all usage should be using addSuccess/ErrorMessage

hasError

public boolean hasError()

getErrorCount

public int getErrorCount()

setErrorCount

public void setErrorCount(int errorCount)

getSuccessCount

public int getSuccessCount()

setSuccessCount

public void setSuccessCount(int successCount)