org.directwebremoting.io.JavascriptFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dwr Show documentation

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boilerplate code between the web browser and your Java code. This version 4.0.2 works with Jakarta Servlet 4.0.2.

There is a newer version: 5.0.0

Show newest version

package org.directwebremoting.io;

/**
 * Represents a callback function, passed in from a client for later execution.
 * A JavascriptFunction is tied to a specific function in a specific browser
 * page. In this way the eval of a JavascriptFunction is outside of the normal
 * execution scoping provided by {@link org.directwebremoting.Browser}.
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public interface JavascriptFunction
{
    /**
     * Execute the function.
     * TODO: At some stage it would be good to allow the final parameter to be
     * a Callback....
     * @param params The data to pass to the server
     */
    public void execute(Object... params);

    /**
     * A small amount of data is stored on the client to track the remotely.
     * accessible objects. To clear this data, the function needs to be cleared
     * on the server.
     */
    public void close();

    /**
     * Execute the function, and clear it's data from the client.
     * @param params The data to pass to the server
     * @see #execute
     * @see #close
     */
    public void executeAndClose(Object... params);
}