org.directwebremoting.extend
Interface Module

All Known Implementing Classes:
CreatorModule

public interface Module

Author:
Mike Wilson [mikewse at g mail dot com]

Method Summary
 java.lang.Object executeMethod(MethodDeclaration method, java.lang.Object[] parameters)
          Invokes the code behind a logical method declaration, using the supplied parameters.
 MethodDeclaration getMethod(java.lang.String methodName, java.lang.Class<?>... parameterTypes)
          Returns a particular method as matched by the name and parameter types.
 MethodDeclaration[] getMethods()
          Returns all logical method declarations for the module.
 java.lang.String getName()
          Returns the name uniquely identifying the module.
 boolean isCacheable()
          Tells whether the module information as described by this interface may change over time, or may be cached.
 java.lang.String toString()
          Returns a pretty-print friendly string describing the module.
 

Method Detail

getName

java.lang.String getName()
Returns the name uniquely identifying the module. This name is also used in JavaScript land.

Returns:
name string

isCacheable

boolean isCacheable()
Tells whether the module information as described by this interface may change over time, or may be cached.

Returns:
true if cacheable

getMethods

MethodDeclaration[] getMethods()
Returns all logical method declarations for the module.

Returns:
array of method declarations

getMethod

MethodDeclaration getMethod(java.lang.String methodName,
                            java.lang.Class<?>... parameterTypes)
                            throws java.lang.NoSuchMethodException,
                                   java.lang.SecurityException
Returns a particular method as matched by the name and parameter types.

Parameters:
methodName -
parameterTypes -
Returns:
method declaration
Throws:
java.lang.NoSuchMethodException
java.lang.SecurityException

executeMethod

java.lang.Object executeMethod(MethodDeclaration method,
                               java.lang.Object[] parameters)
                               throws java.lang.Exception
Invokes the code behind a logical method declaration, using the supplied parameters.

Parameters:
method -
parameters -
Returns:
the return value of the method
Throws:
java.lang.Exception

toString

java.lang.String toString()
Returns a pretty-print friendly string describing the module.

Overrides:
toString in class java.lang.Object
Returns:
human-readable descriptive string

Copyright 2008