Package name.matthewgreet.strutscommons.action

Class AbstractViewListActionSupport.ViewListConfig

java.lang.Object
name.matthewgreet.strutscommons.action.AbstractViewListActionSupport.ViewListConfig
Enclosing class:
AbstractViewListActionSupport<M extends Serializable,K extends Serializable,T extends Serializable,FT>
public static class AbstractViewListActionSupport.ViewListConfig extends Object
Configures list to be loaded by viewer action. Configuration is fixed and does not change during the action's lifetime.

  • Constructor Details

    • ViewListConfig

      public ViewListConfig()
      Constructor for displaying entire list (regardless of cache mode).

  • Method Details

    • makeNoListConfig

      public static AbstractViewListActionSupport.ViewListConfig makeNoListConfig()
      Returns new config for displaying nothing from the list. Parameters, such as 'select' are still read and processed.

    • makeNonPagedListConfig

      public static AbstractViewListActionSupport.ViewListConfig makeNonPagedListConfig()
      Returns new config for actions displaying a full list of base records without any detail. If detail applies, a different action displays them.

    • makePagedListConfig

      public static AbstractViewListActionSupport.ViewListConfig makePagedListConfig(int pageSize)
      Returns new config for displaying lists of base records in pages without any detail. If detail applies, a different action displays them.

    • makeSingleRecordConfig

      public static AbstractViewListActionSupport.ViewListConfig makeSingleRecordConfig()
      Returns new config for displaying a single record with any detail.

    • getIgnoreList

      public boolean getIgnoreList()
      Whether no list or page is displayed.

    • setIgnoreList

      public void setIgnoreList(boolean ignoreList)

    • getPageMode

      public boolean getPageMode()
      Whether the list should be displayed in pages, rather than the entire list. This is not the same as the cache page. The view controller can decide to display in pages independently of how the cache can retrieve them.

    • setPageMode

      public void setPageMode(boolean value)

    • getPageSize

      public int getPageSize()
      Returns size of each page, if in page mode.

    • setPageSize

      public void setPageSize(int value)

    • getReloadDefault

      public boolean getReloadDefault()
      Returns whether to reload from DB in the absence of the reload parameter.

    • setReloadDefault

      public void setReloadDefault(boolean value)

    • getRequireSelectedMasterDetail

      public boolean getRequireSelectedMasterDetail()
      Returns whether currently selected item of master list cache must include details.

    • setRequireSelectedMasterDetail

      public void setRequireSelectedMasterDetail(boolean requireSelectedMasterDetail)

    • getRequireSelectedItemDetail

      public boolean getRequireSelectedItemDetail()
      Returns whether currently selected item of list cache must include details.

    • setRequireSelectedItemDetail

      public void setRequireSelectedItemDetail(boolean requireSelectedItemDetail)

    • getErrorForwardName

      public String getErrorForwardName()
      Name of Struts forward (usually global forward) to be used for unhandlable errors. Defaults to 'error'.

    • setErrorForwardName

      public void setErrorForwardName(String value)

    • getParameterNameIndexSelect

      public String getParameterNameIndexSelect()
      Returns name of request parameter that specifies selected item by its index number (starting at 0). Defaults to 'select'.

    • setParameterNameIndexSelect

      public void setParameterNameIndexSelect(String value)

    • getParameterNameMasterIndexSelect

      public String getParameterNameMasterIndexSelect()
      Returns name of request parameter that specifies selected item of master list by its index number (starting at 0). Defaults to 'masterSelect'.

    • setParameterNameMasterIndexSelect

      public void setParameterNameMasterIndexSelect(String value)

    • getParameterNamePage

      public String getParameterNamePage()
      Returns name of request parameter that specifies page to display (if in page mode), starting at 1. Defaults to 'page'.

    • setParameterNamePage

      public void setParameterNamePage(String value)

    • getParameterNameReload

      public String getParameterNameReload()
      Returns name of request parameter that specifies reloading from DB. Defaults to 'reload'.

    • setParameterNameReload

      public void setParameterNameReload(String value)

    • getParameterNameSortAscending

      public String getParameterNameSortAscending()
      Returns name of request parameter that specifies ascending sort order. Defaults to 'ascending'.

    • setParameterNameSortAscending

      public void setParameterNameSortAscending(String parameterNameSortAscending)

    • getParameterNameSortOption

      public String getParameterNameSortOption()
      Returns name of request parameter that specifies sort option, usually a record field name. Defaults to 'sort'.

    • setParameterNameSortOption

      public void setParameterNameSortOption(String parameterNameSortOption)