/*
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is the Kowari Metadata Store.
 *
 * The Initial Developer of the Original Code is Plugged In Software Pty
 * Ltd (http://www.pisoftware.com, mailto:info@pisoftware.com). Portions
 * created by Plugged In Software Pty Ltd are Copyright (C) 2001,2002
 * Plugged In Software Pty Ltd. All Rights Reserved.
 *
 * Contributor(s): N/A.
 *
 * [NOTE: The text of this Exhibit A may differ slightly from the text
 * of the notices in the Source Code files of the Original Code. You
 * should use the text of this Exhibit A rather than the text found in the
 * Original Code Source Code for Your Modifications.]
 *
 */

package org.mulgara.demo.mp3.swing.actions;

// Java 2 standard packages
import javax.swing.*;

// Logging
import org.apache.log4j.Logger;

// Local packages
import org.mulgara.demo.mp3.Mp3Controller;
import org.mulgara.demo.mp3.swing.*;
import org.mulgara.demo.mp3.swing.results.ResultPanel;
import org.mulgara.demo.mp3.swing.search.*;

/**
 * Generic constraint management Action.
 *
 * @created 2004-12-14
 *
 * @author <a href="mailto:robert.turner@tucanatech.com">Robert Turner</a>
 *
 * @version $Revision: 1.3 $
 *
 * @modified $Date: 2005/01/05 04:58:08 $
 *
 * @maintenanceAuthor $Author: newmana $
 *
 * @company <A href="mailto:info@PIsoftware.com">Plugged In Software</A>
 *
 * @copyright ©2001 <a href="http://www.pisoftware.com/">Plugged In
 *   Software Pty Ltd</a>
 *
 * @licence <a href="{@docRoot}/../../LICENCE">Mozilla Public License v1.1</a>
 */
public abstract class AbstractConstraintAction extends AbstractAction {

  /**
   * Logger. This is named after the class.
   */
  private final static Logger log = Logger.getLogger(AbstractConstraintAction.class.
      getName());

  /** Where the selected Directories are retrieved */
  private SearchPanel searchPanel = null;

  /** Used to indicate processing Status */
  private StatusPanel statusPanel = null;

  /**
   * Default constructor
   *
   * @param name String
   */
  public AbstractConstraintAction(String name) {
    super(name);
  }

  /**
   * Returns the SearchPanel set by setSearchPanel().
   * @throws IllegalStateException
   * @return SearchPanel
   */
  protected SearchPanel getSearchPanel() throws IllegalStateException {
    if (searchPanel == null) {
      throw new IllegalStateException("SearchPanel has not been set.");
    }
    return searchPanel;
  }

  /**
   * Sets the SearchPanel used to retireve selected directories.
   *
   * @param searchPanel SearchPanel
   * @throws IllegalArgumentException
   */
  public void setSearchPanel(SearchPanel searchPanel) throws
      IllegalArgumentException {
    if (searchPanel == null) {
      throw new IllegalArgumentException("SearchPanel is null.");
    }
    this.searchPanel = searchPanel;
  }

  /**
   * Returns the StatusPanel set by setStatusPanel().
   * @throws IllegalStateException
   * @return StatusPanel
   */
  protected StatusPanel getStatusPanel() throws IllegalStateException {
    if (statusPanel == null) {
      throw new IllegalStateException("StatusPanel has not been set.");
    }
    return statusPanel;
  }

  /**
   * Sets the Panel for displaying action status.
   * @param statusPanel StatusPanel
   * @throws IllegalArgumentException
   */
  public void setStatusPanel(StatusPanel statusPanel) throws
      IllegalArgumentException {
    if (statusPanel == null) {
      throw new IllegalArgumentException("StatusPanel is null.");
    }
    this.statusPanel = statusPanel;
  }

}