| org.sakaiproject.tool.api.ToolURL
| ToolURL | | public interface ToolURL (Code) | | A ToolURL is used to create a URL and encode it appropriate to the context and placement of the tool.
author:
Vishal Goenka |
| HTTP_SERVLET_REQUEST | | String HTTP_SERVLET_REQUEST(Code) | | Property name to set the HttpServletRequest in a given thread context, to default to when it is not available to the caller. This allows calling ToolURLManager's create<Type>URL with a null HttpRequestServlet, if one has been set in the
current thread context. We use the same attribute name as set in org.sakaiproject.util.RequestFilter to prevent having to depend on RequestFilter class only to get this attribute. Is this a bad idea??
|
| MANAGER | | String MANAGER(Code) | | Property name to retrieve an instance of ToolURLManager from an HttpServletRequest
|
| setParameter | | void setParameter(String name, String value)(Code) | | Sets the given String parameter to this URL. This method replaces all parameters with the given key. An implementation of this interface may prefix the attribute names internally in order to preserve a unique namespace for the tool
Parameters:
name - the parameter name
Parameters:
value - the parameter value |
| setParameter | | void setParameter(String name, String[] values)(Code) | | Sets the given String array parameter to this URL. This method replaces all parameters with the given key. An implementation of this interface may prefix the attribute names internally in order to preserve a unique namespace for the tool
Parameters:
name - the parameter name
Parameters:
values - the parameter values |
| setParameters | | void setParameters(Map parameters)(Code) | | Sets a parameter map for this URL. All previously set parameters are cleared. An implementation of this interface may prefix the attribute names internally in order to preserve a unique namespace for the tool
Parameters:
parameters - Map containing parameter names as keys and parameter values as map values. The keys in the parameter map must be of type String. The values in the parameter map must be of type String array (String[]). |
| setPath | | void setPath(String path)(Code) | | Set path for this URL. Path can either be absolute with respect to the server or relative to the servlet context in which this tool is placed.
Parameters:
path - path relative to the tool |
| toString | | String toString()(Code) | | Returns the URL string representation to be embedded in the markup. Note that the returned String may not be a valid URL, as it may be rewritten by the portal/portlet-container before returning the markup to the client.
the encoded URL as a String |
|
|