org.sakaiproject.api.kernel.tool
Interface ActiveToolManager

All Superinterfaces:
ToolManager
All Known Implementing Classes:
ActiveToolComponent

public interface ActiveToolManager
extends ToolManager

Extension API for ToolManager that introduces Servlet API specific activity.

Version:
$Revision: 632 $
Author:
University of Michigan, Sakai Software Development Team

Method Summary
 ActiveTool getActiveTool(String id)
          Find a tool with this well known id in the registry.
 void register(Document toolXml, ServletContext config)
          Add tools in this XML DOM to the registry, using the Tool XML schema.
 void register(File toolXmlFile, ServletContext config)
          Add tools in this file of Tool XML schema to the registry.
 void register(InputStream toolXmlStream, ServletContext config)
          Add tools in this stream of Tool XML schema to the registry.
 void register(Tool tool, ServletContext config)
          Add this tool to the registry.
 
Methods inherited from interface org.sakaiproject.api.kernel.tool.ToolManager
findTools, getCurrentPlacement, getCurrentTool, getTool, register, register, register, register
 

Method Detail

register

public void register(Tool tool,
                     ServletContext config)
Add this tool to the registry.

Parameters:
tool - The Tool to register.

register

public void register(Document toolXml,
                     ServletContext config)
Add tools in this XML DOM to the registry, using the Tool XML schema.

Parameters:
toolXml - The parsed XML DOM in which tools to be added to the registry are to be found.

register

public void register(File toolXmlFile,
                     ServletContext config)
Add tools in this file of Tool XML schema to the registry.

Parameters:
toolXmlFile - The file of Tool schema XML in which tools to be added to the registry are to be found.

register

public void register(InputStream toolXmlStream,
                     ServletContext config)
Add tools in this stream of Tool XML schema to the registry.


getActiveTool

public ActiveTool getActiveTool(String id)
Find a tool with this well known id in the registry.

Parameters:
id - The tool's well known id.
Returns:
The Tool object that has this id, or null if not found.