org.sakaiproject.tool.chat
Class ChatDelivery

java.lang.Object
  extended byorg.sakaiproject.util.courier.BaseDelivery
      extended byorg.sakaiproject.tool.chat.ChatDelivery
All Implemented Interfaces:
Delivery

public class ChatDelivery
extends BaseDelivery

ChatDelivery is a Delivery that causes a chat message to be appended to a table of chat messages in the HTML element identified by the address and elementID.

Version:
$Revision: 4742 $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
protected  boolean m_beepOnDelivery
           
protected  String m_messageId
          The messageId.
 
Fields inherited from class org.sakaiproject.util.courier.BaseDelivery
m_address, m_elementId
 
Constructor Summary
ChatDelivery(String address, String elementId, String messageID, boolean beepOnDelivery)
          Construct.
 
Method Summary
 String compose()
          Compose a javascript message for delivery to the browser client window.
 boolean equals(Object obj)
          Are these the same?
 String getMessage()
          Access the Message Id that this delivery is in reference to.
 void setMessage(String id)
          Set the Message Id that this delivery is in reference to.
 String toString()
          Display.
 
Methods inherited from class org.sakaiproject.util.courier.BaseDelivery
act, getAddress, getElement, setAddress, setElement
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_messageId

protected String m_messageId
The messageId.


m_beepOnDelivery

protected boolean m_beepOnDelivery
Constructor Detail

ChatDelivery

public ChatDelivery(String address,
                    String elementId,
                    String messageID,
                    boolean beepOnDelivery)
Construct.

Parameters:
address - The address.
elementId - The elementId.
Method Detail

setMessage

public void setMessage(String id)
Set the Message Id that this delivery is in reference to.

Parameters:
id - The message Id that this delivery is in reference to.

getMessage

public String getMessage()
Access the Message Id that this delivery is in reference to.

Returns:
The Message Id that this delivery is in reference to.

compose

public String compose()
Compose a javascript message for delivery to the browser client window.

Specified by:
compose in interface Delivery
Overrides:
compose in class BaseDelivery
Returns:
The javascript message to send to the browser client window.

toString

public String toString()
Display.

Overrides:
toString in class BaseDelivery

equals

public boolean equals(Object obj)
Are these the same?

Overrides:
equals in class BaseDelivery
Returns:
true if obj is the same Delivery as this one.