|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Module
Modules are pieces of functionality that are not MMBase objects. e.g. Session, Mail, Upload and other functionality
| Method Summary | |
|---|---|
Parameters |
createParameters(String functionName)
Creates a parameter list for a function. |
CloudContext |
getCloudContext()
Retrieves the CloudContext to which this module belongs |
Function |
getFunction(String functionName)
Returns a Function object. |
Collection<Function<?>> |
getFunctions()
Returns all the Function objects of this Module. |
FieldValue |
getFunctionValue(String functionName,
List<?> parameters)
Executes a function on this module with the given parameters, and returns the result. |
String |
getInfo(String command)
Retrieve info from a module based on a command string. |
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. |
NodeList |
getList(String command,
Map<String,?> parameters)
Retrieve info (as a list of virtual nodes) from a module based on a command string. |
NodeList |
getList(String command,
Map<String,?> parameters,
ServletRequest req,
ServletResponse resp)
Retrieve info from a module based on a command string Similar to the LIST command in SCAN. |
String |
getName()
Retrieve the name of the module (in the default language defined in mmbaseroot.xml). |
Map |
getProperties()
Retrieve a copy of the module's properties |
String |
getProperty(String name)
Retrieve a property of the module. |
void |
process(String command,
Object parameter)
Runs the command with the given parameter(s). |
void |
process(String command,
Object parameter,
Map<String,Object> auxparameters)
Runs the command with the given parameter(s). |
void |
process(String command,
Object parameter,
Map<String,Object> auxparameters,
ServletRequest req,
ServletResponse resp)
Runs the command with the given parameter(s). |
| Methods inherited from interface org.mmbase.bridge.Descriptor |
|---|
getDescription, getDescription, getGUIName, getGUIName, getLocalizedDescription, getLocalizedGUIName, setDescription, setDescription, setGUIName, setGUIName |
| Methods inherited from interface java.lang.Comparable |
|---|
compareTo |
| Method Detail |
|---|
CloudContext getCloudContext()
String getName()
getName in interface DescriptorString getProperty(String name)
name - the name of the property
Map getProperties()
void process(String command,
Object parameter)
command - the command to run, i.e. "MESSAGE-UPDATE".parameter - the main parameter for the command. Depends on the command issued. Not all
commands make use of this parameter.
void process(String command,
Object parameter,
Map<String,Object> auxparameters)
command - the command to run, i.e. "MESSAGE-UPDATE".parameter - the main parameter for the command. Depends on the command issued. Not all
commands make use of this parameter.auxparameters - additional parameters for this command.
void process(String command,
Object parameter,
Map<String,Object> auxparameters,
ServletRequest req,
ServletResponse resp)
command - the command to run, i.e. "MESSAGE-UPDATE".parameter - the main parameter for the command. Depends on the command issued. Not all
commands make use of this parameter.auxparameters - additional parameters for this command.req - the Request item to use for obtaining user information. For backward compatibility.resp - the Response item to use for redirecting users. For backward compatibility.String getInfo(String command)
command - the info to obtain, i.e. "USER-OS".
String getInfo(String command,
ServletRequest req,
ServletResponse resp)
command - the info to obtain, i.e. "USER-OS".req - the Request item to use for obtaining user information. For backward compatibility.resp - the Response item to use for redirecting users. For backward compatibility.
NodeList getList(String command,
Map<String,?> parameters)
command - the info to obtain, i.e. "USER-OS".parameters - a hashtable containing the named parameters of the list.
NodeList getList(String command,
Map<String,?> parameters,
ServletRequest req,
ServletResponse resp)
command - the info to obtain, i.e. "USER-OS".parameters - a hashtable containing the named parameters of the list.req - the Request item to use for obtaining user information. For backward compatibility.resp - the Response item to use for redirecting users. For backward compatibility.
Collection<Function<?>> getFunctions()
Function objects.Function getFunction(String functionName)
Function object.
You need to explicitly cast the result to this object, since not all bridge
implementations (i.e. the RMMCI) support this class.
functionName - name of the function
Function object.
NotFoundException - if the function does not existParameters createParameters(String functionName)
functionName - name of the function
Parameters object.
NotFoundException - if the function does not exist
FieldValue getFunctionValue(String functionName,
List<?> parameters)
functionName - name of the functionparameters - list with parameters for the function
NotFoundException - if the function does not exist
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||