org.apache.jetspeed.ajax
Interface AjaxBuilder

public interface AjaxBuilder

An Ajax request is made up of an action and builder phases. Implement this interface for the Ajax builder phase. The builder can add additional information to the requiest context, and it also provides the template used for building the result stream sent back over the Ajax request.

Author:

David Sean Taylor

Method Summary

boolean	buildContext(RequestContext requestContext, java.util.Map contextVars) Build the normal context template
boolean	buildErrorContext(RequestContext requestContext, java.util.Map contextVars) Build the error context template
java.lang.String	getErrorTemplate()
java.lang.String	getTemplate()

Method Detail

getTemplate

java.lang.String getTemplate()

Returns:

the name of the template used for this builder

getErrorTemplate

java.lang.String getErrorTemplate()

Returns:

the name of the error template used for this builder

buildContext

boolean buildContext(RequestContext requestContext,
                     java.util.Map contextVars)

Build the normal context template

Parameters:

requestContext - The Jetspeed Request Context

contextVars - Context variables to be substituted into template

Returns:

true on success false onerror

buildErrorContext

boolean buildErrorContext(RequestContext requestContext,
                          java.util.Map contextVars)

Build the error context template

Parameters:

requestContext - The Jetspeed Request Context

contextVars - Context variables to be substituted into template

Returns:

true on success false onerror