class: SearchResultList

public class: SearchResultList
Author: : Tobias Schraut; Thomas Diebäcker, Hugo Niedermaier, created 10.01.2007
Project: Phase: 1.0; Status: Proposed; Version: : $Revision: 2026 $ $LastChangedDate: 2009-01-29 1; Complexity: 1
Dates: Created: 16.07.2009 15:33:21; Modified: 16.07.2009 15:33:21;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {0501FB72-172F-4595-AD3E-267CE60EA3B1}
Fragment class for the SearchResultList. This class provides all functionality for choosing and viewing one or more items out of a list of SearchResults.
 

Goto: Custom Properties, Fields, Methods

Extends: ItemList

See also: AdvancedSearchEdit, ItemList

Appears in: search

Connections
 
Custom Properties
 
SearchResultList Attributes
Attribute Details
public static const String
  BEAN_NAME
Initial: "SearchResultList"
private String
  displayExportData
Initial: null
Notes: StG: String used for displaying of export items
public static boolean
  isInSearch
Initial: false
Notes: NiH: static flag workaround ui:tree component (exception on doubleclick selection)
private HtmlCommandLink
  lnkAdvancedSearch
Initial: new HtmlCommandLink()
private HtmlCommandLink
  lnkBrowse
Initial: new HtmlCommandLink()
private HtmlCommandLink
  lnkDelete
Initial: new HtmlCommandLink()
private HtmlCommandLink
  lnkEdit
Initial: new HtmlCommandLink()
Notes: binded components in JSP
private HtmlCommandLink
  lnkNewSubmission
Initial: new HtmlCommandLink()
private HtmlCommandLink
  lnkSubmit
Initial: new HtmlCommandLink()
private HtmlCommandLink
  lnkView
Initial: new HtmlCommandLink()
private HtmlCommandLink
  lnkWithdraw
Initial: new HtmlCommandLink()
public static const String
  LOAD_AFFILIATIONSEARCHRESULTLIST
Initial: "showAffiliationSearchResults"
public static const String
  LOAD_NO_ITEMS_FOUND
Initial: "noItemsFound"
public static const String
  LOAD_SEARCHRESULTLIST
Initial: "showSearchResults"
Notes: Faces navigation string
protected static Logger
  logger
Initial: Logger.getLogger(SearchResultList.class)
private static const long
  serialVersionUID
Initial: 1L
private boolean
  showBackLink
Initial: true
Notes: show the back link
private String
  unapiURLview
Notes: unapi interface for zotero
private HtmlOutputText
  valNoItemsFoundMsg
Initial: new HtmlOutputText()
private HtmlOutputText
  valQuery
Initial: new HtmlOutputText()
 
SearchResultList Methods
Operation Details
private
addHandleToMethod(
   HttpMethod method,
   String eSciDocUserHandle):void
Sequential
Notes: Adds a cookie named "escidocCookie" that holds the eScidoc user handle to the provided http method object.
@author Tobias Schraut
protected
createDynamicItemList2():void
Sequential
Notes: Creates the panel newly according to the values in the itemArray.
public
downloadExportFile(
   ActionEvent event):void
Sequential
Notes: Downloads the page with the selected items as export. This method is called when the user selects one or more items and then clicks on the Download-Button in the Export-Items Panel.
@author: StG
public
downloadFile(
   int itemPosition,
   int filePosition):void
Sequential
Tags: throws=IOException,Exception
Notes: Prepares the file the user wants to download
@author Tobias Schraut
protected
enableLinks(
   int itemListSize):void
Sequential
Notes: Enables or disables the action links according to availability of items.
@param itemList the list displayed
private
extractItemsOfSearchResult(
   ItemContainerSearchResult result):ArrayList
Sequential
protected
getItemListSessionBean():ItemListSessionBean
Sequential
Notes: Returns the ItemListSessionBean.
@return a reference to the scoped data bean (ItemListSessionBean)
public
getLnkAdvancedSearch():HtmlCommandLink
Sequential
public
getLnkBrowse():HtmlCommandLink
Sequential
public
getLnkDelete():HtmlCommandLink
Sequential
public
getLnkEdit():HtmlCommandLink
Sequential
public
getLnkNewSubmission():HtmlCommandLink
Sequential
public
getLnkSubmit():HtmlCommandLink
Sequential
public
getLnkView():HtmlCommandLink
Sequential
public
getLnkWithdraw():HtmlCommandLink
Sequential
public
getQueryIsRendered():boolean
Sequential
protected
getSessionBean():SearchResultListSessionBean
Sequential
Notes: Returns the SearchResultListSessionBean.
@return a reference to the scoped data bean (SearchResultListSessionBean)
public
getUnapiURLview():String
Sequential
public
getValNoItemsFoundMsg():HtmlOutputText
Sequential
public
getValQuery():HtmlOutputText
Sequential
public
handleDownloadAction(
   ActionEvent event):String
Sequential
Tags: throws=Exception
Notes: Method is called in jsp. Triggers download action
@author Tobias Schraut
@return String nav rule
public static
HTMLEntityEncode(
   String s):String
Sequential
Notes: Delivers HTML encoded String form the input String.
@author: StG
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
isShowBackLink():boolean
Sequential
public
SearchResultList():
Sequential
Notes: Public constructor.
public
setLnkAdvancedSearch(
   HtmlCommandLink lnkAdvancedSearch):void
Sequential
public
setLnkBrowse(
   HtmlCommandLink lnkBrowse):void
Sequential
public
setLnkDelete(
   HtmlCommandLink lnkDelete):void
Sequential
public
setLnkEdit(
   HtmlCommandLink lnkEdit):void
Sequential
public
setLnkNewSubmission(
   HtmlCommandLink lnkNewSubmission):void
Sequential
public
setLnkSubmit(
   HtmlCommandLink lnkSubmit):void
Sequential
public
setLnkView(
   HtmlCommandLink lnkView):void
Sequential
public
setLnkWithdraw(
   HtmlCommandLink lnkWithdraw):void
Sequential
public
setUnapiURLview(
   String unapiURLview):void
Sequential
public
setValNoItemsFoundMsg(
   HtmlOutputText valNoItemsFoundMsg):void
Sequential
public
setValQuery(
   HtmlOutputText valQuery):void
Sequential
private
showBackInNoResultPage(
   boolean show):void
Sequential
Notes: Show the back link in the NoResultPage or not.
public
showDisplayExportData():String
Sequential
Notes: Returns the navigation string for loading the DisplayExportItemsPage.jsp .
@author: StG
public
showExportEmailPage():String
Sequential
Notes: Invokes the email service to send per email the the page with the selected items as attachment. This method is called when the user selects one or more items and then clicks on the EMail-Button in the Export-Items Panel.
@author: StG
public
showItem():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
startAdvancedSearch(
   ArrayList criteria):String
Sequential
Notes: Calls the advanced search method in ItemControllerSessionBean.
@author Hugo Niedermaier
@return string, identifying the page that should be navigated to after this methodcall
public
startSearch():String
Sequential
Notes: Evaluates the fields for searchString and includeFiles and calls the search method in SearchResultList.
@return string, identifying the page that should be navigated to after this methodcall
public
startSearchForAffiliation(
   AffiliationVO affiliation):String
Sequential
Notes: Searches Items by Affiliation
@return string, identifying the page that should be navigated to after this methodcall
public
viewItem():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
withdrawSelectedItem():String
Sequential
Notes: Withdraws the selected item.
@return string, identifying the page that should be navigated to after this methodcall