org.figure8.join.control.form
Class MailingListForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by org.figure8.join.control.JoinForm
          extended by org.figure8.join.control.form.MailingListForm
All Implemented Interfaces:
java.io.Serializable

public class MailingListForm
extends JoinForm

Form object used for managing and manipulating mailing lists.

Version:
$Revision: 1.2 $
Author:
Laurent Broudoux
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.figure8.join.control.JoinForm
errors
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
MailingListForm()
          Creates a new instance of MailingListForm
 
Method Summary
 void doValidate(java.lang.String operation, org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          Validate form attributes.
 java.lang.String getEventKey()
           
 java.lang.String getMsgContentTemplate()
           
 java.lang.String getMsgTitleTemplate()
           
 java.lang.String getName()
           
 java.lang.String getResourceId()
           
 java.lang.Object getSubscribedList(java.lang.String key)
           
 java.util.Map getSubscribedLists()
           
 java.lang.String getUserId()
           
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          Reset form attributes.
 void setEventKey(java.lang.String eventKey)
           
 void setMsgContentTemplate(java.lang.String msgContentTemplate)
           
 void setMsgTitleTemplate(java.lang.String msgTitleTemplate)
           
 void setName(java.lang.String name)
           
 void setResourceId(java.lang.String resourceId)
           
 void setSubscribedList(java.lang.String key, java.lang.Object value)
           
 void setUserId(java.lang.String userId)
           
 
Methods inherited from class org.figure8.join.control.JoinForm
addActionError, addActionError, addActionError, getGuiMessageResources, getId, getIdStr, getMessageResources, setId, setIdStr, validate, validateEntityObjectId
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MailingListForm

public MailingListForm()
Creates a new instance of MailingListForm

Method Detail

getName

public java.lang.String getName()
Returns:
The name identifying this mailing list

setName

public void setName(java.lang.String name)
Parameters:
name - The name identifying this mailing list

getMsgTitleTemplate

public java.lang.String getMsgTitleTemplate()
Returns:
A string representing template for generating messages title

setMsgTitleTemplate

public void setMsgTitleTemplate(java.lang.String msgTitleTemplate)
Parameters:
msgTitleTemplate - String representing template for title generation

getMsgContentTemplate

public java.lang.String getMsgContentTemplate()
Returns:
A string representing template for generating messages content

setMsgContentTemplate

public void setMsgContentTemplate(java.lang.String msgContentTemplate)
Parameters:
msgContentTemplate - String representing template for generating messages content

getEventKey

public java.lang.String getEventKey()
Returns:
The key of event corresponding to mailing list

setEventKey

public void setEventKey(java.lang.String eventKey)
Parameters:
eventKey - The key of event corresponding to mailing list

getResourceId

public java.lang.String getResourceId()
Returns:
The identifier of resource to whom event applies when using mailing list

setResourceId

public void setResourceId(java.lang.String resourceId)
Parameters:
resourceId - The identifier of resource to whom event applies when using mailing list

getUserId

public java.lang.String getUserId()
Returns:
The identifier of user to manage subscriptions for

setUserId

public void setUserId(java.lang.String userId)
Parameters:
userId - The identifier of user to manage subscriptions for

getSubscribedLists

public java.util.Map getSubscribedLists()
Returns:
Map of list subscribed by user.

getSubscribedList

public java.lang.Object getSubscribedList(java.lang.String key)
Parameters:
key - Name of list to get subscription for
Returns:
"on" string if list is subscribed by user, null otherwise

setSubscribedList

public void setSubscribedList(java.lang.String key,
                              java.lang.Object value)
Parameters:
key - Name of list to set subscription for
value - Value of subscription ("on" || "off" || boolean value)

doValidate

public void doValidate(java.lang.String operation,
                       org.apache.struts.action.ActionMapping mapping,
                       javax.servlet.http.HttpServletRequest request)
Validate form attributes.

Specified by:
doValidate in class JoinForm
Parameters:
operation - String representing the operation to invoke on Action
mapping - Mapping between forwards name and path for this action
request - The servlet container request wrapper

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
Reset form attributes.

Overrides:
reset in class JoinForm
Parameters:
mapping - Mapping between forwards name and path for this action
request - The servlet container request wrapper


Copyright © 2005-2008 Join. All Rights Reserved.