app.spa
Class SPAEventAck

java.lang.Object
  extended by app.spa.SPAEventAck

public final class SPAEventAck
extends java.lang.Object

SPA event acknowledgement descriptor.


Field Summary
 java.lang.String MESSAGE
          Descriptive message text for a failure acknowledgement.
 boolean OK
          Success/failure (==true/false) flag for this acknowledgement.
 
Constructor Summary
SPAEventAck()
          Constructs a new success acknowledgment.
SPAEventAck(boolean ok)
          Constructs a new acknowledgment with the given success/failure flag and a null descriptive text.
SPAEventAck(boolean ok, java.lang.String msg)
          Constructs a new failure acknowledgment with the given success/failure flag and message text.
SPAEventAck(java.lang.String msg)
          Constructs a new failure acknowledgment with the given message text.
 
Method Summary
static SPAEventAck okAck()
          Returns the OK event acknowledgement.
 java.lang.String toString()
          Returns a legible text representation of this acknowledgement.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OK

public final boolean OK
Success/failure (==true/false) flag for this acknowledgement.


MESSAGE

public final java.lang.String MESSAGE
Descriptive message text for a failure acknowledgement.

Constructor Detail

SPAEventAck

public SPAEventAck()
Constructs a new success acknowledgment.


SPAEventAck

public SPAEventAck(boolean ok)
Constructs a new acknowledgment with the given success/failure flag and a null descriptive text.


SPAEventAck

public SPAEventAck(java.lang.String msg)
Constructs a new failure acknowledgment with the given message text.


SPAEventAck

public SPAEventAck(boolean ok,
                   java.lang.String msg)
Constructs a new failure acknowledgment with the given success/failure flag and message text.

Method Detail

toString

public java.lang.String toString()
Returns a legible text representation of this acknowledgement.

Overrides:
toString in class java.lang.Object

okAck

public static final SPAEventAck okAck()
Returns the OK event acknowledgement.