class: ItemList

public abstract class: ItemList
Author: : Thomas Diebäcker, created 10.05.2007
Project: Phase: 1.0; Status: Proposed; Version: : $Revision: 1850 $ $LastChangedDate: 2008-12-17 1; Complexity: 1
Dates: Created: 16.07.2009 15:34:18; Modified: 16.07.2009 15:34:18;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {D56B6DE1-EEBB-4876-80B7-E9D90F0AA8C7}
Superclass for all classes dealing with item lists (e.g. DepositorWS, SearchResultList) This class provides all functionality for showing, sorting and choosing one or more items out of a list.
 

Goto: Custom Properties, Fields, Methods

Extends: FacesBean

See also: FacesBean

Appears in: pubman

Connections
 
Custom Properties
 
ItemList Attributes
Attribute Details
private HtmlSelectOneMenu
  cboSortBy
Initial: new HtmlSelectOneMenu()
Notes: bound components in JSP
private static Logger
  logger
Initial: Logger.getLogger(ItemList.class)
public static const String
  MESSAGE_MANY_ITEMS_SELECTED
Initial: "depositorWS_ManyItemsSelected"
public static const String
  MESSAGE_NO_ITEM_SELECTED
Initial: "depositorWS_NoItemSelected"
Notes: constants for error and status messages
public static const String
  MESSAGE_NOT_SUCCESSFULLY_SUBMITTED
Initial: "depositorWS_NotSuccessfullySubmitted"
public static const String
  MESSAGE_SUCCESSFULLY_ACCEPTED
Initial: "depositorWS_SuccessfullyAccepted"
public static const String
  MESSAGE_SUCCESSFULLY_DELETED
Initial: "depositorWS_SuccessfullyDeleted"
public static const String
  MESSAGE_SUCCESSFULLY_RELEASED
Initial: "depositorWS_SuccessfullyReleased"
public static const String
  MESSAGE_SUCCESSFULLY_REVISED
Initial: "depositorWS_SuccessfullyRevised"
public static const String
  MESSAGE_SUCCESSFULLY_SAVED
Initial: "depositorWS_SuccessfullySaved"
public static const String
  MESSAGE_SUCCESSFULLY_SUBMITTED
Initial: "depositorWS_SuccessfullySubmitted"
public static const String
  MESSAGE_SUCCESSFULLY_WITHDRAWN
Initial: "depositorWS_SuccessfullyWithdrawn"
public static const String
  MESSAGE_WRONG_ITEM_STATE
Initial: "depositorWS_wrongItemState"
public static const String
  NO_WITHDRAWAL_COMMENT_GIVEN
Initial: "depositorWS_NoWithdrawalCommentGiven"
private HtmlSelectOneRadio
  rbgSortOrder
Initial: new HtmlSelectOneRadio()
public SelectItem
  SORTORDER_ASCENDING
Initial: null
Notes: constants for comboBoxes public SelectItem[] SORTBY_OPTIONS = null;
public SelectItem
  SORTORDER_DESCENDING
Initial: null
public SelectItem
  SORTORDER_OPTIONS
Initial: null
 
ItemList Methods
Operation Details
protected abstract
createDynamicItemList2():void
Sequential
Notes: Creates the panel newly according to the values in the itemArray.
public
getCboSortBy():HtmlSelectOneMenu
Sequential
protected
getItemControllerSessionBean():ItemControllerSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the ItemControllerSessionBean).
@return a reference to the scoped data bean
protected abstract
getItemListSessionBean():ItemListSessionBean
Sequential
Notes: Has to be implemented by the inheriting classes to return the specialized subclass for the FacesBean.
@return a reference to the scoped data bean
public
getRbgSortOrder():HtmlSelectOneRadio
Sequential
public
getSelectItemArrayFromEnum(
   Class enumClass):SelectItem
Sequential
Notes: Generate the options for a dropdown by defining an enum.
@return An arry of SelectItems containing the content of the given enum.
public
getSORTORDER_OPTIONS():SelectItem
Sequential <<property get>>
Tags: attribute_name=SORTORDER_OPTIONS
protected
getSubmitItemSessionBean():SubmitItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the SubmitItemSessionBean).
@return a reference to the scoped data bean
protected
getViewItemSessionBean():ViewItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the ViewItemSessionBean).
@return a reference to the scoped data bean
protected
getWithdrawItemSessionBean():WithdrawItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the WithdrawItemSessionBean).
@return a reference to the scoped data bean
public
init():void
Sequential
Notes: Callback method that is called whenever a page containing this page fragment is navigated to, either directly via a URL, or indirectly via page navigation.
public
setCboSortBy(
   HtmlSelectOneMenu cboSortBy):void
Sequential
public
setRbgSortOrder(
   HtmlSelectOneRadio rbgSortOrder):void
Sequential
public
showItem(
   String navigationStringToGoBack):String
Sequential
Notes: Shows an item identified by the itemID in the parameters of the FacesContext. This method is called when a user directly clicks on a link of an item.
@return string, identifying the page that should be navigated to after this methodcall
public
sortItemList():String
Sequential
Notes: Sorts the result item list.
@return string, identifying the page that should be navigated to after this methodcall
public
submitItem(
   String navigationStringToGoBack):String
Sequential
Notes: Submits the selected items. This method is called when the user selects one or more items and then clicks on the submit-link in the DepositorWS.
@author Michael Franke
@return string, identifying the page that should be navigated to after this methodcall
public
viewItem(
   String navigationStringToGoBack):String
Sequential
Notes: View the selected items. This method is called when the user selects one or more items and then clicks on the view-link in the DepositorWS.
@return string, identifying the page that should be navigated to after this methodcall
public
withdrawItem(
   String navigationStringToGoBack):String
Sequential
Notes: Withdraws the selected items. This method is called when the user selects one or more items and then clicks on the withdraw-link in the DepositorWS.
@author Michael Franke
@return string, identifying the page that should be navigated to after this methodcall