Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.util
Class Guest

java.lang.Object
  extended by com.jivesoftware.forum.action.util.Guest

public class Guest
extends java.lang.Object

A simple bean that encapsulates the email and name of a guest user. Often, views will record the name and email of a guest - this class masks the details of getting the name and email as message properties as well as a few other utility methods.


Constructor Summary
Guest()
           
 
Method Summary
 java.lang.String getDisplay()
          A convenience method to return the display name or email of a guest.
 java.lang.String getEmail()
          Returns the guest's email address or null if none was specified.
 ForumMessage getMessage()
          Returns the message object used as the source of the guest's name and email.
 java.lang.String getName()
          Returns the guest's name or null if none was specified.
 void setMessage(ForumMessage message)
          Sets the internal message object - the guest's name and email might be stored as a message property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Guest

public Guest()
Method Detail

getName

public java.lang.String getName()
Returns the guest's name or null if none was specified.

Returns:
the guest's name.

getEmail

public java.lang.String getEmail()
Returns the guest's email address or null if none was specified.


getDisplay

public java.lang.String getDisplay()
A convenience method to return the display name or email of a guest. If the guest's name was not set then the email is returned. If their email was not entered then the word "Guest" is returned.

Returns:
the display name or email of the guest.

getMessage

public ForumMessage getMessage()
Returns the message object used as the source of the guest's name and email.

Returns:
the internal source message object.

setMessage

public void setMessage(ForumMessage message)
Sets the internal message object - the guest's name and email might be stored as a message property.

Parameters:
message - the message object to use.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.