org.tigris.scarab.actions.base
Class ScarabTemplateAction

java.lang.Object
  org.apache.turbine.modules.Module
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.turbine.modules.actions.TemplateAction
                  org.apache.turbine.TemplateAction
                      org.tigris.scarab.actions.base.ScarabTemplateAction

Direct Known Subclasses:

ChangeNotificationStatus, ChangePassword, ForgotPassword, Login, Logout, Register

public abstract class ScarabTemplateAction

extends org.apache.turbine.TemplateAction

This is a helper class that extends TemplateAction to add a couple methods useful for Scarab.

Version:

$Id: ScarabTemplateAction.java 9255 2004-11-14 21:07:04Z dep4b $

Author:

Jon S. Stevens

Field Summary

protected static java.lang.String	DEFAULT_MSG
protected static java.lang.String	EMAIL_ERROR
protected static java.lang.String	ERROR_MESSAGE
protected static java.lang.String	NO_PERMISSION_MESSAGE

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

ScarabTemplateAction()

Method Summary

void	doCancel(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doDone(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doGonext(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doGotoothertemplate(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doRefresh(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doRefreshresultsperpage(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doReset(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doSave(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
java.lang.String	getBackTemplate(org.apache.turbine.RunData data) Returns the backTemplate to be executed.
java.lang.String	getBackTemplate(org.apache.turbine.RunData data, java.lang.String defaultValue) Returns the backTemplate to be executed.
java.lang.String	getCancelTemplate(org.apache.turbine.RunData data) Returns the cancelTemplate to be executed.
java.lang.String	getCancelTemplate(org.apache.turbine.RunData data, java.lang.String defaultValue) Returns the cancelTemplate to be executed.
java.lang.String	getCurrentTemplate(org.apache.turbine.RunData data) Returns the current template that is being executed, otherwisse it returns null
java.lang.String	getCurrentTemplate(org.apache.turbine.RunData data, java.lang.String defaultValue) Returns the current template that is being executed, otherwisse it returns defaultValue.
org.apache.turbine.tool.IntakeTool	getIntakeTool(org.apache.turbine.TemplateContext context) Helper method to retrieve the IntakeTool from the Context
java.lang.String	getLastTemplate(org.apache.turbine.RunData data) Returns the last template to be cancelled back to.
protected ScarabLocalizationTool	getLocalizationTool(org.apache.turbine.TemplateContext context) Helper method to retrieve the ScarabLocalizationTool from the Context
java.lang.String	getNextTemplate(org.apache.turbine.RunData data) Returns the nextTemplate to be executed.
java.lang.String	getNextTemplate(org.apache.turbine.RunData data, java.lang.String defaultValue) Returns the nextTemplate to be executed.
java.lang.String	getOtherTemplate(org.apache.turbine.RunData data) Returns the other template that is being executed, otherwise it returns null.
ScarabRequestTool	getScarabRequestTool(org.apache.turbine.TemplateContext context) Helper method to retrieve the ScarabRequestTool from the Context
protected org.apache.log4j.Logger	log()

Methods inherited from class org.apache.turbine.modules.actions.TemplateAction

doPerform, doPerform, executeEvents

Methods inherited from class org.apache.turbine.modules.ActionEvent

execute, formatString, perform

Methods inherited from class org.apache.turbine.modules.Module

build, doBuild, doBuildTemplate, doBuildTemplate, evaluate, getPullService, getTemplateContext, getTemplateService, getTool, handleRequest, handleRequest, requestFinished, setTarget, setTemplate, templateExists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_MESSAGE

protected static final java.lang.String ERROR_MESSAGE

See Also:

Constant Field Values

NO_PERMISSION_MESSAGE

protected static final java.lang.String NO_PERMISSION_MESSAGE

See Also:

Constant Field Values

DEFAULT_MSG

protected static final java.lang.String DEFAULT_MSG

See Also:

Constant Field Values

EMAIL_ERROR

protected static final java.lang.String EMAIL_ERROR

See Also:

Constant Field Values

Constructor Detail

ScarabTemplateAction

public ScarabTemplateAction()

Method Detail

getIntakeTool

public org.apache.turbine.tool.IntakeTool getIntakeTool(org.apache.turbine.TemplateContext context)

Helper method to retrieve the IntakeTool from the Context

getScarabRequestTool

public ScarabRequestTool getScarabRequestTool(org.apache.turbine.TemplateContext context)

Helper method to retrieve the ScarabRequestTool from the Context

getLocalizationTool

protected final ScarabLocalizationTool getLocalizationTool(org.apache.turbine.TemplateContext context)

Helper method to retrieve the ScarabLocalizationTool from the Context

getCurrentTemplate

public java.lang.String getCurrentTemplate(org.apache.turbine.RunData data)

Returns the current template that is being executed, otherwisse it returns null

getCurrentTemplate

public java.lang.String getCurrentTemplate(org.apache.turbine.RunData data,
                                           java.lang.String defaultValue)

Returns the current template that is being executed, otherwisse it returns defaultValue.

getNextTemplate

public java.lang.String getNextTemplate(org.apache.turbine.RunData data)

Returns the nextTemplate to be executed. Otherwise returns null.

getNextTemplate

public java.lang.String getNextTemplate(org.apache.turbine.RunData data,
                                        java.lang.String defaultValue)

Returns the nextTemplate to be executed. Otherwise returns defaultValue.

getLastTemplate

public java.lang.String getLastTemplate(org.apache.turbine.RunData data)

Returns the last template to be cancelled back to.

getCancelTemplate

public java.lang.String getCancelTemplate(org.apache.turbine.RunData data)

Returns the cancelTemplate to be executed. Otherwise returns null.

getCancelTemplate

public java.lang.String getCancelTemplate(org.apache.turbine.RunData data,
                                          java.lang.String defaultValue)

Returns the cancelTemplate to be executed. Otherwise returns defaultValue.

getBackTemplate

public java.lang.String getBackTemplate(org.apache.turbine.RunData data)

Returns the backTemplate to be executed. Otherwise returns null.

getBackTemplate

public java.lang.String getBackTemplate(org.apache.turbine.RunData data,
                                        java.lang.String defaultValue)

Returns the backTemplate to be executed. Otherwise returns defaultValue.

getOtherTemplate

public java.lang.String getOtherTemplate(org.apache.turbine.RunData data)

Returns the other template that is being executed, otherwise it returns null.

doSave

public void doSave(org.apache.turbine.RunData data,
                   org.apache.turbine.TemplateContext context)
            throws java.lang.Exception

Throws:

java.lang.Exception

doGonext

public void doGonext(org.apache.turbine.RunData data,
                     org.apache.turbine.TemplateContext context)
              throws java.lang.Exception

Throws:

java.lang.Exception

doGotoothertemplate

public void doGotoothertemplate(org.apache.turbine.RunData data,
                                org.apache.turbine.TemplateContext context)
                         throws java.lang.Exception

Throws:

java.lang.Exception

doRefresh

public void doRefresh(org.apache.turbine.RunData data,
                      org.apache.turbine.TemplateContext context)
               throws java.lang.Exception

Throws:

java.lang.Exception

doReset

public void doReset(org.apache.turbine.RunData data,
                    org.apache.turbine.TemplateContext context)
             throws java.lang.Exception

Throws:

java.lang.Exception

doCancel

public void doCancel(org.apache.turbine.RunData data,
                     org.apache.turbine.TemplateContext context)
              throws java.lang.Exception

Throws:

java.lang.Exception

doDone

public void doDone(org.apache.turbine.RunData data,
                   org.apache.turbine.TemplateContext context)
            throws java.lang.Exception

Throws:

java.lang.Exception

log

protected org.apache.log4j.Logger log()

doRefreshresultsperpage

public void doRefreshresultsperpage(org.apache.turbine.RunData data,
                                    org.apache.turbine.TemplateContext context)
                             throws java.lang.Exception

Throws:

java.lang.Exception