| org.mmbase.bridge.Module
All known Subclasses: org.mmbase.bridge.implementation.ModuleHandler,
| Module | | public interface Module extends Descriptor,Comparable<Module>(Code) | | Modules are pieces of functionality that are not MMBase objects.
e.g. Session, Mail, Upload and other functionality
author:
Rob Vermeulen
author:
Pierre van Rooden
version:
$Id: Module.java,v 1.18 2007/02/10 15:47:42 nklasens Exp $ |
| Method Summary | |
| public Parameters | createParameters(String functionName)
Creates a parameter list for a function. | | public CloudContext | getCloudContext()
| | public Function | getFunction(String functionName)
Returns a Fuction object.
The object returned is a
org.mmbase.util.functions.Function object.
You need to explixitly cast the result to this object, since not all bridge
implementations (i.e. | | public FieldValue | getFunctionValue(String functionName, List parameters)
Executes a function on this module with the given parameters, and returns the result. | | public Collection | getFunctions()
Returns all the Function objects of this Module. | | public String | getInfo(String command)
Retrieve info from a module based on a command string.
Similar to the $MOD command in SCAN.
Parameters:
command - the info to obtain, i.e. | | public String | getInfo(String command, ServletRequest req, ServletResponse resp)
Retrieve info from a module based on a command string
Similar to the $MOD command in SCAN.
Parameters:
command - the info to obtain, i.e. | | public NodeList | getList(String command, Map parameters)
Retrieve info (as a list of virtual nodes) from a module based on a command string.
Similar to the LIST command in SCAN.
The values retrieved are represented as fields of a virtual node, named following the fieldnames listed in the fields paramaters..
Parameters:
command - the info to obtain, i.e. | | public NodeList | getList(String command, Map parameters, ServletRequest req, ServletResponse resp)
Retrieve info from a module based on a command string
Similar to the LIST command in SCAN.
The values retrieved are represented as fields of a virtual node, named following the fieldnames listed in the fields paramaters..
Parameters:
command - the info to obtain, i.e. | | public String | getName()
Retrieve the name of the module (in the default language defined in mmbaseroot.xml). | | public Map | getProperties()
| | public String | getProperty(String name)
Retrieve a property of the module. | | public void | process(String command, Object parameter)
Runs the command with the given parameter(s).
Parameters:
command - the command to run, i.e. | | public void | process(String command, Object parameter, Map auxparameters)
Runs the command with the given parameter(s).
Parameters:
command - the command to run, i.e. | | public void | process(String command, Object parameter, Map auxparameters, ServletRequest req, ServletResponse resp)
Runs the command with the given parameter(s).
Parameters:
command - the command to run, i.e. |
| createParameters | | public Parameters createParameters(String functionName)(Code) | | Creates a parameter list for a function.
The list can be filled with parameter values by either using the List set(int, Object) method, to
set values for parameters by psoition, or by using the set(String, Object) method to
set parameters by name.
This object can then be passed to the getFunctionValue method.
Note that adding extra parameters (with the add(Object) method) won't work and may cause exceptions.
since:
MMBase-1.8
Parameters:
functionName - name of the function a org.mmbase.util.functions.Parameters object.
throws:
NotFoundException - if the function does not exist |
| getCloudContext | | public CloudContext getCloudContext()(Code) | | Retrieves the CloudContext to which this module belongs
CloudContext |
| getFunctionValue | | public FieldValue getFunctionValue(String functionName, List parameters)(Code) | | Executes a function on this module with the given parameters, and returns the result.
since:
MMBase-1.8
Parameters:
functionName - name of the function
Parameters:
parameters - list with parameters for the fucntion the result value of executing the function
throws:
NotFoundException - if the function does not exist |
| getInfo | | public String getInfo(String command)(Code) | | Retrieve info from a module based on a command string.
Similar to the $MOD command in SCAN.
Parameters:
command - the info to obtain, i.e. "USER-OS". info from a module |
| getInfo | | public String getInfo(String command, ServletRequest req, ServletResponse resp)(Code) | | Retrieve info from a module based on a command string
Similar to the $MOD command in SCAN.
Parameters:
command - the info to obtain, i.e. "USER-OS".
Parameters:
req - the Request item to use for obtaining user information. For backward compatibility.
Parameters:
resp - the Response item to use for redirecting users. For backward compatibility. info from a module |
| getList | | public NodeList getList(String command, Map parameters)(Code) | | Retrieve info (as a list of virtual nodes) from a module based on a command string.
Similar to the LIST command in SCAN.
The values retrieved are represented as fields of a virtual node, named following the fieldnames listed in the fields paramaters..
Parameters:
command - the info to obtain, i.e. "USER-OS".
Parameters:
parameters - a hashtable containing the named parameters of the list. info from a module (as a list of virtual nodes) |
| getList | | public NodeList getList(String command, Map parameters, ServletRequest req, ServletResponse resp)(Code) | | Retrieve info from a module based on a command string
Similar to the LIST command in SCAN.
The values retrieved are represented as fields of a virtual node, named following the fieldnames listed in the fields paramaters..
Parameters:
command - the info to obtain, i.e. "USER-OS".
Parameters:
parameters - a hashtable containing the named parameters of the list.
Parameters:
req - the Request item to use for obtaining user information. For backward compatibility.
Parameters:
resp - the Response item to use for redirecting users. For backward compatibility. info from a module (as a list of virtual nodes) |
| getName | | public String getName()(Code) | | Retrieve the name of the module (in the default language defined in mmbaseroot.xml).
name of the module |
| getProperties | | public Map getProperties()(Code) | | Retrieve a copy of the module's properties
a map of module properties
since:
MMBase-1.7 |
| getProperty | | public String getProperty(String name)(Code) | | Retrieve a property of the module.
Parameters:
name - the name of the property the property value (null if not given)
since:
MMBase-1.7 |
| process | | public void process(String command, Object parameter)(Code) | | Runs the command with the given parameter(s).
Parameters:
command - the command to run, i.e. "MESSAGE-UPDATE".
Parameters:
parameter - the main parameter for the command. Depends on the command issued. Not allcommands make use of this parameter. |
| process | | public void process(String command, Object parameter, Map auxparameters)(Code) | | Runs the command with the given parameter(s).
Parameters:
command - the command to run, i.e. "MESSAGE-UPDATE".
Parameters:
parameter - the main parameter for the command. Depends on the command issued. Not allcommands make use of this parameter.
Parameters:
auxparameters - additional parameters for this command. |
| process | | public void process(String command, Object parameter, Map auxparameters, ServletRequest req, ServletResponse resp)(Code) | | Runs the command with the given parameter(s).
Parameters:
command - the command to run, i.e. "MESSAGE-UPDATE".
Parameters:
parameter - the main parameter for the command. Depends on the command issued. Not allcommands make use of this parameter.
Parameters:
auxparameters - additional parameters for this command.
Parameters:
req - the Request item to use for obtaining user information. For backward compatibility.
Parameters:
resp - the Response item to use for redirecting users. For backward compatibility. |
|
|