RemoteModule_Proxy (MMBase 1.9-SNAPSHOT

java.lang.Object
- org.mmbase.bridge.remote.proxy.MappedObject_Proxy<RemoteModule>
- - org.mmbase.bridge.remote.proxy.RemoteModule_Proxy

All Implemented Interfaces:

Comparable<Module>, Descriptor, Module, MappedObject
```
public class RemoteModule_Proxy
extends MappedObject_Proxy<RemoteModule>
implements Module
```
RemoteModule_Proxy in a generated smart proxy of Module
This smart proxy is used by a local class when the MMCI is called remotely

Author:

generated by org.mmbase.mojo.remote.ProxyGenerator

Constructor Summary

Constructors
Constructor and Description

RemoteModule_Proxy(RemoteModule remoteObject)

Constructors
Constructor and Description
`RemoteModule_Proxy(RemoteModule remoteObject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Module arg0)`
`Parameters`	`createParameters(String arg0)` Creates a parameter list for a function.
`CloudContext`	`getCloudContext()` Retrieves the CloudContext to which this module belongs
`String`	`getDescription()` Returns the description of this object for the default locale.
`String`	`getDescription(Locale arg0)` Returns the description of this object.
`Function`	`getFunction(String arg0)` Returns a Function object.
`Collection<Function<?>>`	`getFunctions()` Returns all the Function objects of this Module.
`FieldValue`	`getFunctionValue(String arg0, List<?> arg1)` Executes a function on this module with the given parameters, and returns the result.
`String`	`getGUIName()` Returns the GUI name for this object.
`String`	`getGUIName(Locale arg0)` Returns the GUI name for this object in a specified preferred language.
`String`	`getInfo(String arg0)` Retrieve info from a module based on a command string.
`String`	`getInfo(String arg0, javax.servlet.ServletRequest arg1, javax.servlet.ServletResponse arg2)` Retrieve info from a module based on a command string Similar to the $MOD command in SCAN.
`NodeList`	`getList(String arg0, Map<String,?> arg1)` Retrieve info (as a list of virtual nodes) from a module based on a command string.
`NodeList`	`getList(String arg0, Map<String,?> arg1, javax.servlet.ServletRequest arg2, javax.servlet.ServletResponse arg3)` Retrieve info from a module based on a command string Similar to the LIST command in SCAN.
`LocalizedString`	`getLocalizedDescription()` Returns the set of (localized) descriptions of this object.
`LocalizedString`	`getLocalizedGUIName()` Returns the set of (localized) gui names of this object.
`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 arg0)` Retrieve a property of the module.
`RemoteModule`	`getWrappedObject()`
`void`	`process(String arg0, Object arg1)` Runs the command with the given parameter(s).
`void`	`process(String arg0, Object arg1, Map<String,Object> arg2)` Runs the command with the given parameter(s).
`void`	`process(String arg0, Object arg1, Map<String,Object> arg2, javax.servlet.ServletRequest arg3, javax.servlet.ServletResponse arg4)` Runs the command with the given parameter(s).
`void`	`setDescription(String arg0)` Sets the description of this object for the default locale.
`void`	`setDescription(String arg0, Locale arg1)` Sets the description of this object.
`void`	`setGUIName(String arg0)` Sets the GUI name of this object for the default locale.
`void`	`setGUIName(String arg0, Locale arg1)` Sets the GUI name of this object.

Methods inherited from class org.mmbase.bridge.remote.proxy.MappedObject_Proxy
equals, getMapperCode, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RemoteModule_Proxy
```
public RemoteModule_Proxy(RemoteModule remoteObject)
```
- Method Detail
  - createParameters
```
public Parameters createParameters(String arg0)
```
    Description copied from interface: Module
    
    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 position, 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.
    
    Specified by:
    
    createParameters in interface Module
    
    Parameters:
    
    arg0 - name of the function
    
    Returns:
    
    a Parameters object.
  - getFunctionValue
```
public FieldValue getFunctionValue(String arg0,
                                   List<?> arg1)
```
    Description copied from interface: Module
    
    Executes a function on this module with the given parameters, and returns the result.
    
    Specified by:
    
    getFunctionValue in interface Module
    
    Parameters:
    
    arg0 - name of the function
    
    arg1 - list with parameters for the function
    
    Returns:
    
    the result value of executing the function
  - getCloudContext
```
public CloudContext getCloudContext()
```
    Description copied from interface: Module
    
    Retrieves the CloudContext to which this module belongs
    
    Specified by:
    
    getCloudContext in interface Module
    
    Returns:
    
    CloudContext
  - getFunctions
```
public Collection<Function<?>> getFunctions()
```
    Description copied from interface: Module
    
    Returns all the Function objects of this Module.
    
    Specified by:
    
    getFunctions in interface Module
    
    Returns:
    
    a Collection of Function objects.
  - getFunction
```
public Function getFunction(String arg0)
```
    Description copied from interface: Module
    
    Returns a Function object. The object returned is a Function object. You need to explicitly cast the result to this object, since not all bridge implementations (i.e. the RMMCI) support this class.
    
    Specified by:
    
    getFunction in interface Module
    
    Parameters:
    
    arg0 - name of the function
    
    Returns:
    
    a Function object.
  - getList
```
public NodeList getList(String arg0,
                        Map<String,?> arg1,
                        javax.servlet.ServletRequest arg2,
                        javax.servlet.ServletResponse arg3)
```
    Description copied from interface: Module
    
    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..
    
    Specified by:
    
    getList in interface Module
    
    Parameters:
    
    arg0 - the info to obtain, i.e. "USER-OS".
    
    arg1 - a hashtable containing the named parameters of the list.
    
    arg2 - the Request item to use for obtaining user information. For backward compatibility.
    
    arg3 - the Response item to use for redirecting users. For backward compatibility.
    
    Returns:
    
    info from a module (as a list of virtual nodes)
  - getList
```
public NodeList getList(String arg0,
                        Map<String,?> arg1)
```
    Description copied from interface: Module
    
    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..
    
    Specified by:
    
    getList in interface Module
    
    Parameters:
    
    arg0 - the info to obtain, i.e. "USER-OS".
    
    arg1 - a hashtable containing the named parameters of the list.
    
    Returns:
    
    info from a module (as a list of virtual nodes)
  - process
```
public void process(String arg0,
                    Object arg1,
                    Map<String,Object> arg2,
                    javax.servlet.ServletRequest arg3,
                    javax.servlet.ServletResponse arg4)
```
    Description copied from interface: Module
    
    Runs the command with the given parameter(s).
    
    Specified by:
    
    process in interface Module
    
    Parameters:
    
    arg0 - the command to run, i.e. "MESSAGE-UPDATE".
    
    arg1 - the main parameter for the command. Depends on the command issued. Not all commands make use of this parameter.
    
    arg2 - additional parameters for this command.
    
    arg3 - the Request item to use for obtaining user information. For backward compatibility.
    
    arg4 - the Response item to use for redirecting users. For backward compatibility.
  - process
```
public void process(String arg0,
                    Object arg1,
                    Map<String,Object> arg2)
```
    Description copied from interface: Module
    
    Runs the command with the given parameter(s).
    
    Specified by:
    
    process in interface Module
    
    Parameters:
    
    arg0 - the command to run, i.e. "MESSAGE-UPDATE".
    
    arg1 - the main parameter for the command. Depends on the command issued. Not all commands make use of this parameter.
    
    arg2 - additional parameters for this command.
  - process
```
public void process(String arg0,
                    Object arg1)
```
    Description copied from interface: Module
    
    Runs the command with the given parameter(s).
    
    Specified by:
    
    process in interface Module
    
    Parameters:
    
    arg0 - the command to run, i.e. "MESSAGE-UPDATE".
    
    arg1 - the main parameter for the command. Depends on the command issued. Not all commands make use of this parameter.
  - getInfo
```
public String getInfo(String arg0)
```
    Description copied from interface: Module
    
    Retrieve info from a module based on a command string. Similar to the $MOD command in SCAN.
    
    Specified by:
    
    getInfo in interface Module
    
    Parameters:
    
    arg0 - the info to obtain, i.e. "USER-OS".
    
    Returns:
    
    info from a module
  - getInfo
```
public String getInfo(String arg0,
                      javax.servlet.ServletRequest arg1,
                      javax.servlet.ServletResponse arg2)
```
    Description copied from interface: Module
    
    Retrieve info from a module based on a command string Similar to the $MOD command in SCAN.
    
    Specified by:
    
    getInfo in interface Module
    
    Parameters:
    
    arg0 - the info to obtain, i.e. "USER-OS".
    
    arg1 - the Request item to use for obtaining user information. For backward compatibility.
    
    arg2 - the Response item to use for redirecting users. For backward compatibility.
    
    Returns:
    
    info from a module
  - getProperty
```
public String getProperty(String arg0)
```
    Description copied from interface: Module
    
    Retrieve a property of the module.
    
    Specified by:
    
    getProperty in interface Module
    
    Parameters:
    
    arg0 - the name of the property
    
    Returns:
    
    the property value (null if not given)
  - getName
```
public String getName()
```
    Description copied from interface: Module
    
    Retrieve the name of the module (in the default language defined in mmbaseroot.xml).
    
    Specified by:
    
    getName in interface Descriptor
    
    Specified by:
    
    getName in interface Module
    
    Returns:
    
    name of the module
  - getProperties
```
public Map getProperties()
```
    Description copied from interface: Module
    
    Retrieve a copy of the module's properties
    
    Specified by:
    
    getProperties in interface Module
    
    Returns:
    
    a map of module properties
  - getLocalizedDescription
```
public LocalizedString getLocalizedDescription()
```
    Description copied from interface: Descriptor
    
    Returns the set of (localized) descriptions of this object.
    
    Specified by:
    
    getLocalizedDescription in interface Descriptor
    
    Returns:
    
    the description as a LocalizedString
  - getLocalizedGUIName
```
public LocalizedString getLocalizedGUIName()
```
    Description copied from interface: Descriptor
    
    Returns the set of (localized) gui names of this object.
    
    Specified by:
    
    getLocalizedGUIName in interface Descriptor
    
    Returns:
    
    the description as a LocalizedString
  - setGUIName
```
public void setGUIName(String arg0,
                       Locale arg1)
```
    Description copied from interface: Descriptor
    
    Sets the GUI name of this object.
    
    Specified by:
    
    setGUIName in interface Descriptor
    
    Parameters:
    
    arg0 - the description as a String
    
    arg1 - The locale for which this is valid, or null for the default locale.
  - setGUIName
```
public void setGUIName(String arg0)
```
    Description copied from interface: Descriptor
    
    Sets the GUI name of this object for the default locale.
    
    Specified by:
    
    setGUIName in interface Descriptor
    
    Parameters:
    
    arg0 - the description as a String
  - getGUIName
```
public String getGUIName(Locale arg0)
```
    Description copied from interface: Descriptor
    
    Returns the GUI name for this object in a specified preferred language.
    
    Specified by:
    
    getGUIName in interface Descriptor
    
    Parameters:
    
    arg0 - the locale that determines the language for the GUI name
    
    Returns:
    
    the GUI name for this object
  - getGUIName
```
public String getGUIName()
```
    Description copied from interface: Descriptor
    
    Returns the GUI name for this object.
    
    Specified by:
    
    getGUIName in interface Descriptor
    
    Returns:
    
    the GUI name for this object
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Descriptor
    
    Returns the description of this object for the default locale.
    
    Specified by:
    
    getDescription in interface Descriptor
    
    Returns:
    
    the description as a String
  - getDescription
```
public String getDescription(Locale arg0)
```
    Description copied from interface: Descriptor
    
    Returns the description of this object.
    
    Specified by:
    
    getDescription in interface Descriptor
    
    Parameters:
    
    arg0 - The locale for which this must be returned, or null for a default locale. If no fitting description for the given locale is available, getName() can be returned.
    
    Returns:
    
    the description as a String
  - setDescription
```
public void setDescription(String arg0,
                           Locale arg1)
```
    Description copied from interface: Descriptor
    
    Sets the description of this object.
    
    Specified by:
    
    setDescription in interface Descriptor
    
    Parameters:
    
    arg0 - the description as a String
    
    arg1 - The locale for which this is valid, or null for a default locale.
  - setDescription
```
public void setDescription(String arg0)
```
    Description copied from interface: Descriptor
    
    Sets the description of this object for the default locale.
    
    Specified by:
    
    setDescription in interface Descriptor
    
    Parameters:
    
    arg0 - the description as a String
  - compareTo
```
public int compareTo(Module arg0)
```
    Specified by:
    
    compareTo in interface Comparable<Module>
  - getWrappedObject
```
public RemoteModule getWrappedObject()
```
    Specified by:
    
    getWrappedObject in interface MappedObject
    
    Overrides:
    
    getWrappedObject in class MappedObject_Proxy<RemoteModule>

Class RemoteModule_Proxy

Constructor Summary

Method Summary

Methods inherited from class org.mmbase.bridge.remote.proxy.MappedObject_Proxy

Methods inherited from class java.lang.Object

Constructor Detail

RemoteModule_Proxy

Method Detail

createParameters

getFunctionValue

getCloudContext

getFunctions

getFunction

getList

getList

process

process

process

getInfo

getInfo

getProperty

getName

getProperties

getLocalizedDescription

getLocalizedGUIName

setGUIName

setGUIName

getGUIName

getGUIName

getDescription

getDescription

setDescription

setDescription

compareTo

getWrappedObject