class: PubItemListSessionBean

public class: PubItemListSessionBean
Author: Markus Haarlaender (initial creation)
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 2786 $ $LastChangedDate: 2009-07-16 09:; Complexity: 1
Dates: Created: 16.07.2009 15:32:34; Modified: 16.07.2009 15:32:34;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {4BC725B8-2A88-40fb-829C-934B2A246D09}
This session bean implements the BasePaginatorListSessionBean for sortable lists of PubItems.
 

Goto: Custom Properties, Fields, Methods

Extends: BasePaginatorListSessionBean

See also: LoginHelper, BasePaginatorListSessionBean

Appears in: itemList

Connections
 
Custom Properties
 
PubItemListSessionBean Attributes
Attribute Details
public static String
  BEAN_NAME
Initial: "PubItemListSessionBean"
private String
  listType
Initial: "BIB"
Notes: A string indicating the currently selected list type of a Pub Item list.
private static Logger
  logger
Initial: Logger.getLogger(PubItemListSessionBean.class)
private LoginHelper
  loginHelper
private static String
  parameterSelectedSortBy
Initial: "sortBy"
Notes: The HTTP GET parameter name for the sorting criteria.
private static String
  parameterSelectedSortOrder
Initial: "sortOrder"
Notes: The HTTP GET parameter name for the sorting order
private Map
  selectedItemRefs
Notes: A map containing the references of the currently selected pub items of one page. Used to reset selections after a redirect.
private String
  selectedSortBy
Notes: The currently selected sorting criteria.
private String
  selectedSortOrder
Notes: The currently selected sort order
private List
  sortBySelectItems
Notes: A list containing the menu entries of the sorting criteria menu.
private String
  subMenu
Initial: "VIEW"
Notes: A string indicating the currently selected submenu of a PubItem list.
 
PubItemListSessionBean Methods
Operation Details
public
addSelectedToCart():String
Sequential
Notes: Adds the currently selected pub items to the basket and displays corresponding messages.
@return
protected
beforeRedirect():void
Sequential
Tags: annotations=@Override
Notes: Before any redirect, the references of the currently selected publication items are stored in this session in order to reselct them after the redirect Thus, the selection is not lost.
public
changeListTypeToBib():String
Sequential
Notes: Called by JSF when the list type should be changed to bibliographic lists
@return
public
changeListTypeToGrid():String
Sequential
Notes: Called by JSF when the list type should be changed to grid lists
@return
public
changeSortBy():String
Sequential
Notes: Called by JSF when the sorting criteria should be changed.
@return
public
changeSortOrder():String
Sequential
Notes: Called by JSF when the sort order should be changed from "ascending" to "descending" or vice versa.
@return
public
changeSubmenuToExport():String
Sequential
Notes: Called by JSF when the submenu should be changed to the EXPORT part
@return
public
changeSubmenuToFilter():String
Sequential
Notes: Called by JSF when submenu should be changed to the FILTER part
@return
public
changeSubmenuToSorting():String
Sequential
Notes: Called by JSF when submenu should be changed to the SORTING part
@return
public
changeSubmenuToView():String
Sequential
Notes: Called by JSF when submenu should be changed to the VIEW part
@return
public
changeToSortByCreator():String
Sequential
Notes: Called by JSF when the items should be sorted by their creators. Redirects to the same page with updated GET parameter for sorting.
@return
public
changeToSortByDate():String
Sequential
Notes: Called by JSF when the items should be sorted by their date. Redirects to the same page with updated GET parameter for sorting.
@return
public
changeToSortByFile():String
Sequential
Notes: Called by JSF when the items should be sorted by their files. Redirects to the same page with updated GET parameter for sorting.
@return
public
changeToSortByGenre():String
Sequential
Notes: Called by JSF when the items should be sorted by their genre. Redirects to the same page with updated GET parameter for sorting.
@return
public
changeToSortByState():String
Sequential
Notes: Called by JSF when the items should be sorted by their state. Redirects to the same page with updated GET parameter for sorting.
@return
public
changeToSortByTitle():String
Sequential
Notes: Called by JSF when the items should be sorted by their title. Redirects to the same page with updated GET parameter for sorting.
@return
public
downloadExportFile(
   List pubItemList):String
Sequential
Notes: Exports the given pub items and allows the user to download them
@return
public
exportAllDisplay():String
Sequential
Notes: Exports all items (without offset and limit filters) and displays them.
@return
public
exportAllDownload():String
Sequential
Notes: Exports all items (without offset and limit filters) and allows the user to download them .
@return
public
exportAllEmail():String
Sequential
Notes: Exports all items (without offset and limit filters) and and shows the email page.
@return
public
exportSelectedDisplay():String
Sequential
Notes: Exports the selected items and displays the results.
@return
public
exportSelectedDownload():String
Sequential
Notes: Exports the selected items and allows the user to download them .
@return
public
exportSelectedEmail():String
Sequential
Notes: Exports the selected items and shows the email page.
@return
public
getAdditionalFilters():SORT_CRITERIA
Sequential
Tags: annotations=@Override
Notes: Returns the currently selected sorting criteria which is used as an additional filter
public
getIsAscending():boolean
Sequential
Notes: Returns true if the current sort order is ascending, false if "descending
@return
public
getListType():String
Sequential
Notes: Returns the list type ("BIB" or "GRID")
@param listType
public
getSelectedItemRefs():Map
Sequential
Notes: Returns a map that contains references of the selected pub items of the last page
@return
public
getSelectedItems():List
Sequential
Notes: Returns the currently selected pub items of the displayed list page
@return
public
getSelectedSortBy():String
Sequential
Notes: Returns the currently selected sorting criteria
@return
public
getSelectedSortByLabel():String
Sequential
Notes: Retu´rns the label in the selected language for the currrently selected sorting criteria
@return
public
getSelectedSortOrder():String
Sequential
Notes: Returns the current sort order ("ascending" or "descending")
public
getSortBySelectItems():List
Sequential
Notes: Returns the menu entries for the sorting criteria menu
public
getSubMenu():String
Sequential
Notes: Returns a string describing the curently selected submenu
@return
protected
listUpdated():void
Sequential
Tags: annotations=@Override
Notes: Updates the checkboxes of the items on the page after a new list is displayed.
protected
pageTypeChanged():void
Sequential
Tags: annotations=@Override
Notes: Resets the submenus, clears parameters from the map
public
PubItemListSessionBean():
Sequential
protected
readOutParameters():void
Sequential
Tags: annotations=@Override
Notes: Reads out additional parmaeters from GET request for sorting criteria and sort order and sets their default values if they are null
private
retrieveAll():List
Sequential
Notes: Retrieves all pub items (without offset and limit filters) and returns them in a list
@return
private
saveSelections():void
Sequential
Notes: Saves the references of currently selected pub items into a map.
public
setListType(
   String listType):void
Sequential
Notes: Sets the list type ("BIB" or "GRID")
public
setSelectedSortBy(
   String selectedSortBy):void
Sequential
Notes: Sets the current sorting criteria
public
setSelectedSortOrder(
   String selectedSortOrder):void
Sequential
Notes: Sets the current sort order ("ascending" or "descending")
public
setSortBySelectItems(
   List sortBySelectItems):void
Sequential
Notes: Sets the menu entries for the sorting criteria menu
public
setSubMenu(
   String subMenu):void
Sequential
Notes: Sets the submenu
public
showDisplayExportData(
   List pubItemList):String
Sequential
Notes: Exports the given items and displays them
@return
public
showExportEmailPage(
   List pubItemList):String
Sequential
Notes: Exports the given pub items and shows the email page.
@return
private
updateSelections():void
Sequential
Notes: Checks if items on the current page have to be selected (checked) after an redirect.