com.technia.tvc.graphicreporting.dashboard.actions

Class DashboardReloadAction

java.lang.Object

com.technia.tvc.struts.action.Action

com.technia.tvc.core.actions.TVCAction

com.technia.tvc.core.actions.NewTxAction

com.technia.tvc.graphicreporting.dashboard.actions.DashboardReloadAction

public abstract class DashboardReloadAction
extends NewTxAction

Action to support reloading gadgets with related data. Supply the config id of the gadgets that needs to be reloaded.

Since:

2014.1.0

Field Summary

Fields inherited from class com.technia.tvc.core.actions.TVCAction

CLIENT_TASK_ERROR, CLIENT_TASK_ERROR_KEY, CLIENT_TASK_NOTICE_KEY, CLIENT_TASK_WARNING_KEY, GLOBAL_ERROR_KEY, INFORMATION_ERROR

Fields inherited from class com.technia.tvc.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
DashboardReloadAction(TxType update)

Method Summary

Modifier and Type	Method and Description
com.technia.tvc.struts.action.ActionForward	execute(TxContext txc, com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Override this method in subclasses to make use of the transaction context.
protected abstract void	perform(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.technia.tvc.core.gui.dashboard.Dashboard dashboard)
protected abstract java.util.Collection<java.lang.String>	reloadConfigIds() Specifies the gadget which needs to be reloaded.

Methods inherited from class com.technia.tvc.core.actions.NewTxAction

executeImpl, getMonitor, getOriginContext, handleClientTasks, handleException, handleLogin, handleTransactionEndFailure, ignoreClientTasks

Methods inherited from class com.technia.tvc.core.actions.TVCAction

addError, addError, addErrors, addGlobalError, addGlobalError, addInformationError, asActionError, asActionErrors, copy, debugRequest, execute, findErrorForward, findForwardOrTargetPage, perform, perform, saveError, saveError, saveGlobalError, saveGlobalError, saveInformationError, setLocale

Methods inherited from class com.technia.tvc.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardReloadAction

public DashboardReloadAction(TxType update)

Method Detail

execute

public com.technia.tvc.struts.action.ActionForward execute(TxContext txc,
                                                           com.technia.tvc.struts.action.ActionMapping mapping,
                                                           com.technia.tvc.struts.action.ActionForm form,
                                                           javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)
                                                    throws java.lang.Exception

Description copied from class: NewTxAction

Override this method in subclasses to make use of the transaction context. Note that you can also get the transaction context by calling TxManager.getLocalTxContext().

Specified by:

execute in class NewTxAction

Parameters:

txc - The transaction context.

mapping - The action mappings.

form - The action form.

request - The HTTP request.

response - The HTTP response.

Returns:

The action forward to which the request will be forwarded.

Throws:

java.lang.Exception - If an error occurs.

perform

protected abstract void perform(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                com.technia.tvc.core.gui.dashboard.Dashboard dashboard)
                         throws TVCException

Throws:

TVCException

reloadConfigIds

protected abstract java.util.Collection<java.lang.String> reloadConfigIds()

Specifies the gadget which needs to be reloaded. Use the same id as specified in the configuration file for the gadget.

Returns:

The collection of config ids of gadgets which needs to be reloaded.

Since:

2014.1.0