org.sakaiproject.api.kernel.tool
Interface Tool

All Known Subinterfaces:
ActiveTool
All Known Implementing Classes:
ActiveToolComponent.MyActiveTool, Tool

public interface Tool

Tool models a Sakai user interface producing tool. Tool and its attributes are immutable.

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

Nested Class Summary
static class Tool.AccessSecurity
          typesafe enumeration for access security.
 
Field Summary
static String FRAGMENT
          The request attribute name whose value if "true" requests producing a document fragment rather than a full document.
static String HELPER_DONE_URL
          Standard session attribute shared between client and helper: URL to redirect to when helper is done.
static String HELPER_MESSAGE
          Standard session attribute shared between client and helper: end user message.
static String NATIVE_URL
          The request attribute name if present causes our wrapped requests to report the native URL rather than the Sakai set up URL information.
static String PLACEMENT
          The request attribute name containing the Tool placement for the current request.
static String PLACEMENT_ID
          The request attribute / URL parameter name containing the Tool placement id for the current request.
static String PORTLET
          The request attribute name whose value if "true" requests producing a document suitable for aggregation in a portal.
static String TOOL
          The request attribute name containing the Tool definition for the current request.
static String TOOL_SESSION
          The request attribute name containing the ToolSession for the current request.
 
Method Summary
 Tool.AccessSecurity getAccessSecurity()
          Access the setting for this tool for the access security.
 Set getCategories()
          Access the catagories registered for this tool.
 String getDescription()
          Access the tool description.
 Properties getFinalConfig()
          Access the configuration properties that are final ones, may not be configured, from registration for the tool.
 String getId()
          Access the well known id of the tool.
 Set getKeywords()
          Access the keywords registered for this tool.
 Properties getMutableConfig()
          Access the configuration properties that may be configured (not the final ones) from registration for the tool.
 Properties getRegisteredConfig()
          Access the configuration properties from registration for the tool.
 String getTitle()
          Access the tool title.
 

Field Detail

FRAGMENT

public static final String FRAGMENT
The request attribute name whose value if "true" requests producing a document fragment rather than a full document.

See Also:
Constant Field Values

PORTLET

public static final String PORTLET
The request attribute name whose value if "true" requests producing a document suitable for aggregation in a portal.

See Also:
Constant Field Values

TOOL

public static final String TOOL
The request attribute name containing the Tool definition for the current request.

See Also:
Constant Field Values

TOOL_SESSION

public static final String TOOL_SESSION
The request attribute name containing the ToolSession for the current request.

See Also:
Constant Field Values

NATIVE_URL

public static final String NATIVE_URL
The request attribute name if present causes our wrapped requests to report the native URL rather than the Sakai set up URL information.

See Also:
Constant Field Values

PLACEMENT

public static final String PLACEMENT
The request attribute name containing the Tool placement for the current request.

See Also:
Constant Field Values

PLACEMENT_ID

public static final String PLACEMENT_ID
The request attribute / URL parameter name containing the Tool placement id for the current request.

See Also:
Constant Field Values

HELPER_DONE_URL

public static final String HELPER_DONE_URL
Standard session attribute shared between client and helper: URL to redirect to when helper is done.

See Also:
Constant Field Values

HELPER_MESSAGE

public static final String HELPER_MESSAGE
Standard session attribute shared between client and helper: end user message.

See Also:
Constant Field Values
Method Detail

getId

public String getId()
Access the well known id of the tool.

Returns:
The well known id of the tool.

getTitle

public String getTitle()
Access the tool title.

Returns:
The tool title.

getDescription

public String getDescription()
Access the tool description.

Returns:
The tool description.

getRegisteredConfig

public Properties getRegisteredConfig()
Access the configuration properties from registration for the tool. Access is read only.

Returns:
The read-only configuration properties from registration for the tool.

getMutableConfig

public Properties getMutableConfig()
Access the configuration properties that may be configured (not the final ones) from registration for the tool. Access is read only.

Returns:
The read-only configuration properties from registration for the tool.

getFinalConfig

public Properties getFinalConfig()
Access the configuration properties that are final ones, may not be configured, from registration for the tool. Access is read only.

Returns:
The read-only configuration properties from registration for the tool.

getKeywords

public Set getKeywords()
Access the keywords registered for this tool. Access is read only.

Returns:
The Set (String) of keywords registered for this tool.

getCategories

public Set getCategories()
Access the catagories registered for this tool. Access is read only.

Returns:
The Set (String) of categories registered for this tool.

getAccessSecurity

public Tool.AccessSecurity getAccessSecurity()
Access the setting for this tool for the access security. Access is read only.

Returns:
ACCESS_SECURITY_PORTAL if the tool is configured to let the portal handle access security, or ACCESS_SECURITY_TOOL if it handles it internally.