/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic License, Version 2.0 (the
    * "License"); you may not use this file except in compliance with
    * the License. You may obtain a copy of the License at
    *
    *      http://www.opensource.org/licenses/gpl-license.php
    *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the Gnu General Public License for more details.
   */
  package org.figure8.join.control.form;
  
  import org.figure8.join.control.JoinForm;
  import org.figure8.join.control.action.MailingListActions;
  
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  
  import java.util.Map;
  import java.util.HashMap;
  /**
   * Form object used for managing and manipulating mailing lists.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @struts.form name="mailingListForm"
   */
  public class MailingListForm extends JoinForm{
  
     // Attributes ---------------------------------------------------------------
  
     /** The name of this mailing list */
     private String name;
     /** A string representing template for generating messages title */
     private String msgTitleTemplate;
     /** A string representing template for generating messages content */
     private String msgContentTemplate;
     /** The key of event corresponding to mailing list */
     private String eventKey;
     /** The identifier of resource to whom event applies when using mailing list */
     private String resourceId;
  
     /** The identifier of user to manage subscriptions for */
     private String userId;
     /**
      * The map of subscribed lists for the associated user. Keys
      * are the name of list, values are boolean telling if list is subcribes.
      */
     private Map subscribedLists = new HashMap();
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of MailingListForm */
     public MailingListForm(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @return The name identifying this mailing list */
     public String getName(){
        return name;
     }
     /** @param name The name identifying this mailing list */
     public void setName(String name){
        this.name = name;
     }
     /** @return A string representing template for generating messages title */
     public String getMsgTitleTemplate(){
        return msgTitleTemplate;
     }
     /** @param msgTitleTemplate String representing template for title generation */
     public void setMsgTitleTemplate(String msgTitleTemplate){
        this.msgTitleTemplate = msgTitleTemplate;
     }
     /** @return A string representing template for generating messages content */
     public String getMsgContentTemplate(){
        return msgContentTemplate;
     }
     /** @param msgContentTemplate String representing template for generating messages content */
     public void setMsgContentTemplate(String msgContentTemplate){
        this.msgContentTemplate = msgContentTemplate;
     }
  
     /** @return The key of event corresponding to mailing list */
     public String getEventKey(){
        return eventKey;
     }
     /** @param eventKey The key of event corresponding to mailing list */
     public void setEventKey(String eventKey){
        this.eventKey = eventKey;
     }
     /** @return The identifier of resource to whom event applies when using mailing list */
    public String getResourceId(){
       return resourceId;
    }
    /** @param resourceId The identifier of resource to whom event applies when using mailing list */
    public void setResourceId(String resourceId){
       this.resourceId = resourceId;
    }
 
    /** @return The identifier of user to manage subscriptions for */
    public String getUserId(){
       return userId;
    }
    /** @param userId The identifier of user to manage subscriptions for */
    public void setUserId(String userId){
       this.userId = userId;
    }
 
    /** @return Map of list subscribed by user. */
    public Map getSubscribedLists(){
       return subscribedLists;
    }
    /**
     * @param key Name of list to get subscription for
     * @return "on" string if list is subscribed by user, null otherwise
     */
    public Object getSubscribedList(String key){
       return subscribedLists.get(key);
    }
    /**
     * @param key Name of list to set subscription for
     * @param value Value of subscription ("on" || "off" || boolean value)
     */
    public void setSubscribedList(String key, Object value){
       subscribedLists.put(key, value);
    }
 
 
    // Implementation of JoinForm -----------------------------------------------
 
    /**
     * Validate form attributes.
     * @param operation String representing the operation to invoke on Action
     * @param mapping Mapping between forwards name and path for this action
     * @param request The servlet container request wrapper
     */
    public void doValidate(String operation, ActionMapping mapping, HttpServletRequest request){
 
       if (MailingListActions.LOAD_OP.equals(operation)){
          // Check and see if name is missing.
          if (name == null || name.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.mailinglist.name"));
       }
       else if (MailingListActions.SAVE_OP.equals(operation)){
          // Check and see if name is missing.
          if (name == null || name.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.mailinglist.name"));
          // Check and see if title template is missing.
          if (msgTitleTemplate == null || msgTitleTemplate.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.mailinglist.msgTitleTemplate"));
          // Check and see if content template is missing.
          if (msgContentTemplate == null || msgContentTemplate.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.mailinglist.msgContentTemplate"));
          // Check and see if event key is missing.
          if (eventKey == null | eventKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.mailinglist.event"));
       }
       else if (MailingListActions.SUBSCRIBE_OP.equals(operation)){
          // Check and see if userId is missing.
          if (userId == null || userId.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.mailingList.subscriberId"));
       }
    }
 
 
    // Override of ActionForm ---------------------------------------------------
 
    /**
     * Reset form attributes.
     * @param mapping Mapping between forwards name and path for this action
     * @param request The servlet container request wrapper
     */
    public void reset(ActionMapping mapping, HttpServletRequest request){
       super.reset(mapping, request);
       name = null;
       msgTitleTemplate = null;
       msgContentTemplate = null;
       eventKey = null;
       resourceId = null;
       userId = null;
       subscribedLists = new HashMap();
    }
 }