it.tidalwave.bluebill.mobile.taxonomy.ui.TaxonPickerViewController Maven / Gradle / Ivy

Go to download
/***********************************************************************************************************************
 *
 * blueBill Mobile - Android - open source birding
 * Copyright (C) 2009-2011 by Tidalwave s.a.s. (http://www.tidalwave.it)
 *
 ***********************************************************************************************************************
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 *
 ***********************************************************************************************************************
 *
 * WWW: http://bluebill.tidalwave.it/mobile
 * SCM: https://java.net/hg/bluebill-mobile~android-src
 *
 **********************************************************************************************************************/
package it.tidalwave.bluebill.mobile.taxonomy.ui;

import javax.annotation.Nonnull;
import javax.swing.Action;
import it.tidalwave.util.thread.annotation.ThreadConfined;
import it.tidalwave.bluebill.taxonomy.mobile.Taxon.Rank;
import static it.tidalwave.util.thread.ThreadType.*;

/***********************************************************************************************************************
 *
 * @stereotype Controller
 * 
 * @author  Fabrizio Giudici
 * @version $Id$
 *
 **********************************************************************************************************************/
public interface TaxonPickerViewController 
  {
    /*******************************************************************************************************************
     *
     * Initializes the controller.
     *
     ******************************************************************************************************************/
    @ThreadConfined(type=NOT_UI)
    public void initialize();

    /*******************************************************************************************************************
     *
     * Returns the {@link Action} that triggers browsing by the given {@link Rank}.
     * 
     * @param  rank  the {@code Rank}
     * @return       the {@code Action}
     *
     ******************************************************************************************************************/
    @Nonnull @ThreadConfined(type=ANY)
    public Action getBrowseByRankAction (@Nonnull Rank rank);

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @ThreadConfined(type=ANY)
    public void clearTaxonHistory();
  }