icswsearchresult.java

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

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

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

import com.esri.solutions.jitk.common.metadata.IMetadataCatalog;
import com.esri.solutions.jitk.common.metadata.IMetadataDocument;
import com.esri.solutions.jitk.web.tasks.search.csw.actions.IActionHandler;

import java.util.List;
import java.util.Map;


public interface ICswSearchResult {
    /**
     * Sets the reference to the ADF's {@link WebContext} object.
     *
     * @param webContext Reference to the ADF's {@link WebContext}.
     * @throws NullPointerException Thrown if the <code>webContext</code> argument is
     *                         <code>null</code>.
     */
    public void setWebContext(WebContext webContext);

    /**
     * Sets the reference to the {@link IMetadataCatalog}.
     *
     * @param catalog Reference to the {@link IMetadataCatalog}.
     * @throws NullPointerException Thrown if the <code>catalog</code> argument is
     *                         <code>null</code>.
     */
    public void setMetadataCatalog(IMetadataCatalog catalog);

    /**
     * Sets the reference to the {@link IMetadataDocument}.
     *
     * @param document Reference to the {@link IMetadataDocument} associated with
     *                 the search result.
     * @throws NullPointerException Thrown if the <code>document</code> argument is
     *                         <code>null</code>.
     */
    public void setMetadataDocument(IMetadataDocument document);

    /**
     * Sets the {@link String} name of the search result.
     *
     * @param name {@link String} name.
     */
    public void setDisplayName(String displayName);

    /**
     * Sets the value indicating whether or not the search
     * result is live data or map.
     *
     * @param live Indicating value.
     */
    public void setLiveDataOrMap(boolean live);

    /**
     * Sets the {@link Map} of information for the search result.
     * Key/Value pair.
     *
     * @param details {@link Map} of details for the search result.
     */
    public void setDetails(Map<String, String> details);

    /**
     * Sets the ADF {@link WebGeometry} for the CS/W search result.
     * This geometry can be used for highlight/outline and zoom to
     * functionality.
     *
     * @param geom The {@link WebGeometry}.
     */
    public void setWebGeometry(WebGeometry geometry);

    /**
     * Value indicating whether or not the search result
     * is live data or map.
     *
     * @return Live data or map indicator.
     */
    public boolean isLiveDataOrMap();

    /**
     * Simply a placeholder for all actions associated with this
     * search result.
     */
    public void executeAction();

    /**
     * Executes the method associated with the given <code>actionName</code>.
     * This method will be called from the {@link CswResultDescriptor#processAction(Object, String)}.
     *
     * @param actionName Name of the action to be executed.
     */
    public void executeAction(String actionName);

    /**
     * Sets the {@link List} of {@link IActionHandler} objects used for
     * search result actions.
     *
     * @param actionHandlers {@link List} of {@link IActionHandler} objects.
     */
    public void setActionHandlers(List<IActionHandler> actionHandlers);
}