com.technia.tvc.structurebrowser.actions

Class StructureBeanAction

java.lang.Object

com.technia.tvc.struts.action.Action

com.technia.tvc.core.actions.TVCAction

com.technia.tvc.core.actions.NewTxAction

com.technia.tvc.structurebrowser.actions.TableBeanAction

com.technia.tvc.structurebrowser.actions.InstantiateBeanAction

com.technia.tvc.structurebrowser.actions.StructureBeanAction

Direct Known Subclasses:

ExecInquiryToStructureAction, NewNavigateAction

public abstract class StructureBeanAction
extends InstantiateBeanAction

Action class that acts as a subclass for other actions classes that create and initialize a StructureBean.

Field Summary

Fields inherited from class com.technia.tvc.structurebrowser.actions.TableBeanAction

showClientTasksAboveTableDefault

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
StructureBeanAction(TxType type) Constructor that lets you specify the transaction type.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAlwaysInstantiate() Returns whether to always instantiate a TableBean when this action executes.
java.lang.String	getDefaultBeanClassName() Returns the default TableBean class name that should be used unless another class name was explicitly defined in the request.
java.lang.String	getRequiredBeanClassName() Returns the reqired TableBean class name.
abstract com.technia.tvc.struts.action.ActionForward	perform(StructureBean structure, com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Implement this method to perform an action on the StructureBean.
com.technia.tvc.struts.action.ActionForward	perform(TableBean<?> table, com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method should be overridden to perform business logic on the TableBean instance.
TableBean<?>	updateTable(javax.servlet.http.HttpServletRequest request, TableBean<?> table) Updates the table for the current request.

Methods inherited from class com.technia.tvc.structurebrowser.actions.InstantiateBeanAction

afterCreate, copyEnv, createEntryProcessor, createSelectionBehavior, createTable, createTableFactory, createTableInstance, createTableLinkFactory, createTableRenderer, createViewFactory, finishRequest, getBeanClass, getBeanClassName, getCopyEnv, getDefaultPageConfigName, getObjectNameFromRequest, getPageConfig, isBeanInstantiated, setBeanInstantiated, setSystemTableAndFilters, setView

Methods inherited from class com.technia.tvc.structurebrowser.actions.TableBeanAction

afterPerform, beforePerform, createEnvironment, discardEnv, discardTable, ensureContextMenu, ensureMenuBar, execute, generateKey, getChoosableViewNamesParameter, getEnv, getGeneratedKey, getMonitor, getOriginalTable, getParameter, getTable, getViewNameParameter, handleErrors, insertCategoryMenu, loadContextMenu, loadMenuBar, replaceRequest, saveEnv, saveTable, storePageConfig, storeRequestAttributes, update

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

executeImpl, 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

StructureBeanAction

public StructureBeanAction(TxType type)

Constructor that lets you specify the transaction type.

Parameters:

type - The transaction type.

Method Detail

perform

public final com.technia.tvc.struts.action.ActionForward perform(TableBean<?> table,
                                                  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: TableBeanAction

This method should be overridden to perform business logic on the TableBean instance.

Specified by:

perform in class TableBeanAction

Throws:

java.lang.Exception

perform

public abstract com.technia.tvc.struts.action.ActionForward perform(StructureBean structure,
                                                  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

Implement this method to perform an action on the StructureBean.

Parameters:

structure - The StructureBean that was created (or reused) for this request.

mapping - The action mappings.

form - The form.

request - The request.

response - The response.

Returns:

The forward.

Throws:

java.lang.Exception - If the action fails.

updateTable

public TableBean<?> updateTable(javax.servlet.http.HttpServletRequest request,
                       TableBean<?> table)
                         throws TVCException

Description copied from class: TableBeanAction

Updates the table for the current request. If the table should be discarded this method should return null, this method could also return a different table to replace the argument.

This implementation will make sure the current table's view, system table and filters are valid.

Overrides:

updateTable in class InstantiateBeanAction

Throws:

TVCException

getDefaultBeanClassName

public java.lang.String getDefaultBeanClassName()

Description copied from class: InstantiateBeanAction

Returns the default TableBean class name that should be used unless another class name was explicitly defined in the request.

Specified by:

getDefaultBeanClassName in class InstantiateBeanAction

Returns:

Returns the default TableBean class name.

getRequiredBeanClassName

public java.lang.String getRequiredBeanClassName()

Description copied from class: InstantiateBeanAction

Returns the reqired TableBean class name. If a custom class name was explicitly defined in the request that class has to be assignable to the class returned by this method.

Specified by:

getRequiredBeanClassName in class InstantiateBeanAction

Returns:

Returns the required TableBean class name.

getAlwaysInstantiate

public boolean getAlwaysInstantiate()

Description copied from class: InstantiateBeanAction

Returns whether to always instantiate a TableBean when this action executes. If not, any existing TableBean that was found will be reused.

Specified by:

getAlwaysInstantiate in class InstantiateBeanAction

Returns:

Returns whether to always instantiate.