| org.sakaiproject.tool.api.ActiveToolManager
All known Subclasses: org.sakaiproject.tool.impl.ActiveToolComponent,
ActiveToolManager | public interface ActiveToolManager extends ToolManager(Code) | |
Extension API for ToolManager that introduces Servlet API specific activity.
|
getActiveTool | ActiveTool getActiveTool(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. |
getLocalizedToolProperty | String getLocalizedToolProperty(String toolId, String key)(Code) | | Get the localized property of a tool
Parameters: toolId - The fully qualified id of a sakai tool. Parameters: key - The name of the property, for example title or description. The tool property, null if tool id is invalid. |
parseTools | List<Tool> parseTools(File toolXmlFile)(Code) | | Parse a registration file and return a list of Tool Registrations
Parameters: toolXmlFile - The file of Tool schema XML in which tools to be added to the registry are to be found. |
parseTools | List<Tool> parseTools(Document toolXml)(Code) | | Parse a registration file and return a list of Tool Registrations
Parameters: toolXmlFile - The file of Tool schema XML in which tools to be added to the registry are to be found. |
register | void register(Tool tool, ServletContext config)(Code) | | Add this tool to the registry.
Parameters: tool - The Tool to register. |
register | void register(Document toolXml, ServletContext config)(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, ServletContext config)(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, ServletContext config)(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. |
|
|