| org.sakaiproject.tool.api.ToolManager
All known Subclasses: org.sakaiproject.tool.impl.ToolComponent,
| ToolManager | | public interface ToolManager (Code) | |
ToolManager holds registration of Tools available in this Sakai installation.
|
| Method Summary | |
| Set | findTools(Set categories, Set keywords)
Find a set of tools that meet the critieria.
A tool must have a category in the categories criteria (unless it is empty or null) to be returned.
A tool must have a keyword in the keywords criteria (unless it is empty or null) to be returned.
If both categories and keywords criteria are specified, the tool must meet both criteria to be returned.
If neither criteria are specified, all registered tools are returned.
Parameters:
categories - A Set (String) of category values; if null or empty no category criteria is specified.
Parameters:
keywords - A Set (String) of keyword values; if null or empty no keyword criteria is specified. | | Placement | getCurrentPlacement()
| | Tool | getCurrentTool()
| | Tool | getTool(String id)
Find a tool with this well known id in the registry.
Parameters:
id - The tool's well known id. | | void | register(Tool tool)
Add this tool to the registry. | | void | register(Document toolXml)
Add tools in this XML DOM to the registry, using the Tool XML schema. | | void | register(File toolXmlFile)
Add tools in this file of Tool XML schema to the registry. | | void | register(InputStream toolXmlStream)
Add tools in this stream of Tool XML schema to the registry. |
| findTools | | Set findTools(Set categories, Set keywords)(Code) | | Find a set of tools that meet the critieria.
A tool must have a category in the categories criteria (unless it is empty or null) to be returned.
A tool must have a keyword in the keywords criteria (unless it is empty or null) to be returned.
If both categories and keywords criteria are specified, the tool must meet both criteria to be returned.
If neither criteria are specified, all registered tools are returned.
Parameters:
categories - A Set (String) of category values; if null or empty no category criteria is specified.
Parameters:
keywords - A Set (String) of keyword values; if null or empty no keyword criteria is specified. A Set (Tool) of Tool objects that meet the criteria, or an empty set if none found. |
| getCurrentPlacement | | Placement getCurrentPlacement()(Code) | | Access the Tool Placement associated with the current request / thread
The current Tool Placement, or null if there is none. |
| getCurrentTool | | Tool getCurrentTool()(Code) | | Access the Tool associated with the current request / thread
The current Tool, or null if there is none. |
| getTool | | Tool getTool(String id)(Code) | | Find a tool with this well known id in the registry.
Parameters:
id - The tool's well known id. The Tool object that has this id, or null if not found. |
| register | | void register(Tool tool)(Code) | | Add this tool to the registry.
Parameters:
tool - The Tool to register. |
| register | | void register(Document toolXml)(Code) | | 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 | | void register(File toolXmlFile)(Code) | | 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 | | void register(InputStream toolXmlStream)(Code) | | Add tools in this stream 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. |
|
|