dip.net.message
Interface PressMessage


public interface PressMessage

A Press Message


Method Summary
 MID getFrom()
          Message sender.
 java.lang.String getMessage()
          Message body.
 Phase getPhase()
          Phase during which message was sent.
 java.lang.String getSubject()
          Message subject.
 long getTimeReceived()
          Time when message arrived. 0 if unknown.
 long getTimeSent()
          Time when message was sent. 0 if unknown.
 MID[] getTo()
          Message recipients.
 boolean isRead()
          True if this message has been read
 boolean isRepliedTo()
          True if this message has been replied to
 void setRead(boolean value)
          Set whether this message has been read
 void setRepliedTo(boolean value)
          Set whether this message has been replied to
 

Method Detail

getFrom

public MID getFrom()
Message sender. May never be null.


getTo

public MID[] getTo()
Message recipients. Never null. May be zero-length if broadcast.


getSubject

public java.lang.String getSubject()
Message subject. May be null if there is no subject.


getMessage

public java.lang.String getMessage()
Message body. Never null; may be empty ("").


getPhase

public Phase getPhase()
Phase during which message was sent. May be null if sent before a game has started, or after a game has ended.


getTimeReceived

public long getTimeReceived()
Time when message arrived. 0 if unknown.


getTimeSent

public long getTimeSent()
Time when message was sent. 0 if unknown.


isRead

public boolean isRead()
True if this message has been read


isRepliedTo

public boolean isRepliedTo()
True if this message has been replied to


setRead

public void setRead(boolean value)
Set whether this message has been read


setRepliedTo

public void setRepliedTo(boolean value)
Set whether this message has been replied to



Copyright 2002-2004 Zachary DelProposto / jDip Development Team. All Rights Reserved.