org.apache.jetspeed.ajax

Interface AjaxAction

public interface AjaxAction

An Ajax request is made up of an action and builder phases. Implement this interface for the Ajax action phase. The action should put any parameters or results it wants passed on to the builders in the resultMap

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAccess(RequestContext context, String action) Checks to see if the current subject has access to to execute this action.
boolean	run(RequestContext requestContext, Map<String,Object> resultMap) The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.
boolean	runBatch(RequestContext requestContext, Map<String,Object> resultMap) Same as run method, but runs in batch mode, as a hint to the action that it is running a multiple action and can delay its update runBatch currently supports pageManager.updatePage

Method Detail

run

boolean run(RequestContext requestContext,
          Map<String,Object> resultMap)
            throws AJAXException

The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.

Parameters:

requestContext - The Jetspeed Request Context

resultMap - map of action parameters (any object) passed to the builder context

Returns:

success is true, failure is false

Throws:

AJAXException

runBatch

boolean runBatch(RequestContext requestContext,
               Map<String,Object> resultMap)
                 throws AJAXException

Same as run method, but runs in batch mode, as a hint to the action that it is running a multiple action and can delay its update runBatch currently supports pageManager.updatePage

Parameters:

requestContext - The Jetspeed Request Context

resultMap - map of action parameters passed to the builder context

Returns:

success is true, failure is false

Throws:

AJAXException

checkAccess

boolean checkAccess(RequestContext context,
                  String action)

Checks to see if the current subject has access to to execute this action.

Parameters:

context -

Returns:

true if access granted, false if denied.