/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they 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 in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: FindAction.java,v $
   * Revision 1.8.2.1  2005/10/08 10:54:23  colinmacleod
   * Added temporary workarounds for bugs in ivata groupware v0.11.x
   *
   * Revision 1.8  2005/04/27 17:23:28  colinmacleod
   * Fixed bugs resulting from ivata masks changes
   * for ivata groupware v0.11.
   *
   * Revision 1.7  2005/04/09 18:04:18  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.6  2005/03/10 10:36:52  colinmacleod
   * Added base class name, display only as attributes
   * (as well as the request parameters).
   *
   * Revision 1.5  2005/01/19 13:14:02  colinmacleod
   * Renamed CausedByException to SystemException.
   *
   * Revision 1.4  2005/01/07 08:08:24  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.3  2004/12/29 15:32:19  colinmacleod
   * List/input mask actions are no longer hard-coded.
   * Overrides added via request parameters - defaults via new methods on the
   * factory.
   *
   * Revision 1.2  2004/11/12 15:10:41  colinmacleod
   * Moved persistence classes from ivata op as a replacement for
   * ValueObjectLocator.
   *
   * Revision 1.1.1.1  2004/05/16 20:40:32  colinmacleod
   * Ready for 0.1 release
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.struts;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.http.HttpSession;
  
  import org.apache.log4j.Logger;
  import org.apache.struts.action.ActionErrors;
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionMapping;
  import com.ivata.mask.Mask;
  import com.ivata.mask.MaskFactory;
  import com.ivata.mask.persistence.FinderException;
  import com.ivata.mask.persistence.PersistenceManager;
  import com.ivata.mask.persistence.PersistenceSession;
  import com.ivata.mask.util.SystemException;
  import com.ivata.mask.util.StringHandling;
  import com.ivata.mask.valueobject.ValueObject;
  /***
   * <p>
   * View a value object in a mask for display or deletion.
   * </p>
   *
   * @since ivata masks 0.1 (2004-05-10)
   * @author Colin MacLeod
   * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
   * @version $Revision: 1.8.2.1 $
   */
  public class FindAction extends MaskAction {
      /***
      * Refer to {@link Logger}.
      */
     private static Logger log = Logger.getLogger(FindAction.class);
     /***
      * Class of value object we are to find.
      */
     private String baseClassName;
     /***
      * <code>true</code> if we should only display the value object (rather than
      * edit it).
      */
     private Boolean displayOnly;
     /***
      * Unique identifier of the value object.
      */
     private String idString;
     /***
      * <p>
      * This factory is needed to access the masks and groups of masks.
      * </p>
      */
     private MaskFactory maskFactory;
     /***
      * <p>
      * Used to locate the value objects by their unique identifier.
      * </p>
      */
     private PersistenceManager persistenceManager;
     /***
      * <p>
      * Create a new AddAction with the given value object locator.
      * </p>
      *
      * @param persistenceManagerParam
      *            used to locate the value objects by their unique identifier.
      * @param maskFactoryParam
      *            This factory is needed to access the masks and groups of
      *            masks.
      * @param authenticatorParam
      *            used to confirm whether or not the user should be allowed to
      *            continue, in the <code>execute</code> method.
      */
     public FindAction(final PersistenceManager persistenceManagerParam,
             final MaskFactory maskFactoryParam,
             final MaskAuthenticator authenticatorParam) {
         super(maskFactoryParam, authenticatorParam);
         this.maskFactory = maskFactoryParam;
         this.persistenceManager = persistenceManagerParam;
     }
     /***
      * <p>
      * Override this method to create a different class of input mask form.
      * </p>
      *
      * @param requestParam
      *            request we are processing.
      * @param valueObjectParam
      *            value object to be displayed/edited.
      * @param maskParam
      *            mask to be edited.
      * @param baseClassParam
      *            base class of all value objects to show in the list or
      *            associated with this mask.
      * @since ivata op (0.10) (2004-12-31)
      * @return new instance of <code>InputMaskForm</code>.
      */
     protected InputMaskForm createInputMaskForm(
             final HttpServletRequest requestParam,
             final ValueObject valueObjectParam, final Mask maskParam,
             final Class baseClassParam) {
         return new InputMaskForm(valueObjectParam, maskParam, baseClassParam);
     }
     /***
      * <p>
      * Generic method called by the <strong>Struts </strong> interface. Looks
      * for a request parameter called &quot;idString&quot; and removes the value
      * object with this id.
      * </p>
      *
      * <p>
      * Additionally, specifying a request parameter called &quot;readOnly&quot;
      * to <code>true</code> will cause the mask form to be created in read
      * only (display) mode.
      * </p>
      *
      * <p>
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * </p>
      *
      * @param mapping
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @param errors
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @param form
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @param request
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @param response
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @param session
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @return Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      * @throws SystemException
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#execute}.
      */
     public String execute(final ActionMapping mapping,
             final ActionErrors errors, final ActionForm form,
             final HttpServletRequest request,
             final HttpServletResponse response, final HttpSession session)
             throws SystemException {
         // first the mandatory parameters - you can set these in a subclass
         // if you choose
         String baseClassNameRequest = request.getParameter("baseClass");
         if (baseClassNameRequest != null) {
             baseClassName = baseClassNameRequest;
         }
         String idStringRequest = request.getParameter("idString");
         if (idStringRequest != null) {
             idString = idStringRequest;
         }
         String displayOnlyRequest = request.getParameter("displayOnly");
         if ((displayOnlyRequest != null)
                 || (displayOnly == null)) {
             displayOnly = new Boolean("true".equals(displayOnlyRequest));
         }
         if (idString == null) {
             throw new ValueObjectException(
                     "You must specify a request parameter called 'idString'");
         }
         if (baseClassName == null) {
             throw new ValueObjectException(
                     "You must specify a request parameter called 'baseClass'");
         }
         Class baseClass;
         try {
             baseClass = Class.forName(baseClassName);
         } catch (ClassNotFoundException e) {
             throw new ValueObjectException(e);
         }
         PersistenceSession persistenceSession = persistenceManager
                 .openSession();
         try {
             assert (!StringHandling.isNullOrEmpty(idString));
             ValueObject valueObject;
             try {
                 valueObject = persistenceManager.findByPrimaryKey(
                         persistenceSession, baseClass, idString);
             } catch(FinderException e) {
                 valueObject = null;
             }
             if ((valueObject == null)
                     && log.isDebugEnabled()) {
                 log.debug("No value object found with id string '"
                             + idString
                             + "'");
             }
             Mask mask = maskFactory.getMask(baseClass, getInputMask(request,
                     form));
             if (mask == null) {
                 throw new NullPointerException(
                         "ERROR in ViewAction: no mask for baseClass '"
                                 + baseClass + "', type 'mask'");
             }
             InputMaskForm maskForm;
             if (form instanceof InputMaskForm) {
                 maskForm = (InputMaskForm) form;
             } else {
                 maskForm = createInputMaskForm(request, valueObject, mask,
                         baseClass);
             }
             // only set the display only status if it was explicitly set to
             // something
             if (displayOnly.booleanValue()) {
                 maskForm.setDisplayOnly(true);
             }
             request.setAttribute(InputMaskForm.REQUEST_ATTRIBUTE, maskForm);
             // TODO: workaround for ivata groupware
             session.setAttribute(InputMaskForm.REQUEST_ATTRIBUTE, maskForm);
             return "success";
         } finally {
             persistenceSession.close();
         }
     }
     /***
      * Class of value object we are to find.
      *
      * @return Returns the baseClassName.
      */
     protected String getBaseClassName() {
         return baseClassName;
     }
     /***
      * <code>true</code> if we should only display the value object (rather than
      * edit it).
      *
      * @return Returns the displayOnly.
      */
     protected Boolean getDisplayOnly() {
         return displayOnly;
     }
     /***
      * Unique identifier of the value object.
      *
      * @return Returns the idString.
      */
     protected String getIdString() {
         return idString;
     }
     /***
      * Class of value object we are to find.
      *
      * @param baseClassNameParam The baseClassName to set.
      */
     protected void setBaseClassName(String baseClassNameParam) {
         if (log.isDebugEnabled()) {
             log.debug("setBaseClassName before: '" + baseClassName
                     + "', after: '" + baseClassNameParam + "'");
         }
 
         baseClassName = baseClassNameParam;
     }
     /***
      * <code>true</code> if we should only display the value object (rather than
      * edit it).
      *
      * @param displayOnlyParam The displayOnly to set.
      */
     protected void setDisplayOnly(Boolean displayOnlyParam) {
         if (log.isDebugEnabled()) {
             log.debug("setDisplayOnly before: '" + displayOnly + "', after: '"
                     + displayOnlyParam + "'");
         }
 
         displayOnly = displayOnlyParam;
     }
     /***
      * Unique identifier of the value object.
      *
      * @param idStringParam The idString to set.
      */
     protected void setIdString(String idStringParam) {
         if (log.isDebugEnabled()) {
             log.debug("setIdString before: '" + idString + "', after: '"
                     + idStringParam + "'");
         }
 
         idString = idStringParam;
     }
 }