icontextmenuitemtask.java

来自「esri的ArcGIS Server超级学习模板程序（for java）」· Java 代码 · 共 37 行

package com.esri.solutions.jitk.common.contextmenus;

/**
 * Defines an interface that a Task can implement in order to be
 * launched from a Context Menu Item within the Table Of Contents.
 * The Task must expose its Task ID that must match the ID given to the
 * task in the JSP page.  Also, the Task must have a reference to the
 * Context Menu Item Task Manager which is responsible for opening the
 * Task UI in the viewer.
 */
public interface IContextMenuItemTask extends IContextMenuItem {
	
	/**
	 * Returns the ID of the Task.  The ID is needed by the
	 * Context Menu Item Task Manager in order to open the correct
	 * Task UI in the viewer. The returned ID must match the ID
	 * given to the Task in the JSP page.  <code>null</code> should
	 * never be returned from this method.
	 * 
	 * @return  ID of the Task.
	 */
	public String getTaskId ();
	
	/**
	 * Sets the Context Menu Item Task Manager object within the Task
	 * object.  The Context Menu Item Task Manager is responsible
	 * for opening the Task UI in the viewer.  The reference to the
	 * Context Menu Item Task Manager may be set via a bean framework
	 * such as Java Server Faces or Spring.  The reference can also
	 * be set programmatically.
	 * 
	 * @param mgr	Reference to Context Menu Item Task Manager.
	 */
	public void setContextMenuItemTaskManager (ContextMenuItemTaskManager mgr);
	
}