iactionhandler.java

esri的ArcGIS Server超级学习模板程序（for java）

package com.esri.solutions.jitk.web.tasks.search.csw.actions;

import com.esri.adf.web.data.WebContext;
import com.esri.adf.web.data.geometry.WebGeometry;
import com.esri.adf.web.data.results.WebResults;

import com.esri.solutions.jitk.common.metadata.BasicMetadataExporter;
import com.esri.solutions.jitk.datasources.ogc.csw.CswRecord;


public interface IActionHandler {
    /**
     * Sets the name of the result action.
     *
     * @param name {@link String} name.
     */
    public void setName(String name);

    /**
     * Gets the name of the result action.
     *
     * @return {@link String} name.
     */
    public String getName();

    /**
     * Executes the result action.
     */
    public void execute();

    /**
     * Determines of this result action should be displayed for the
     * given {@link CswRecord}.
     *
     * @param exporter Reference to the {@link BasicMetadataExporter} which should be used to
     *                 determine if the action should be displayed.  Cannot be <code>null</code>.
     * @return true if the action should be displayed, false otherwise.
     */
    public boolean shouldDisplay(BasicMetadataExporter exporter);

    /**
     * Gets the key that will be passed to the {@link WebResults} object for
     * creating result actions.
     *
     * @return {@link String} key of the action.
     */
    public String getActionKey();

    /**
     * Sets the reference to the ADF's {@link WebContext} object.
     *
     * @param context {@link WebContext} reference.
     */
    public void setWebContext(WebContext context);

    /**
     * Sets the reference to the {@link WebGeometry} associated with the
     * search result.
     *
     * @param geometry {@link WebGeometry} reference.
     */
    public void setWebGeometry(WebGeometry geometry);
}