class: SearchRetrieverRequestBean

public class: SearchRetrieverRequestBean
Author: Markus Haarlaender (initial creation)
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 2764 $ $LastChangedDate: 2009-06-22 16:; Complexity: 1
Dates: Created: 16.07.2009 15:33:23; Modified: 16.07.2009 15:33:23;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {2B05784D-1480-4cbb-98AB-C612DBE41DE8}
This bean is an implementation of the BaseListRetrieverRequestBean class for the Search result list. It executes the Search whenever the page is called with a GET cql parameter and a valid cql query. It uses the PubItemListSessionBean as corresponding BasePaginatorListSessionBean.
 

Goto: Custom Properties, Fields, Methods

Extends: BaseListRetrieverRequestBean

See also: Search, BaseListRetrieverRequestBean

Appears in: search

Connections
 
Custom Properties
 
SearchRetrieverRequestBean Attributes
Attribute Details
public static String
  BEAN_NAME
Initial: "SearchRetrieverRequestBean"
private String
  cqlQuery
Notes: The current cqlQuery
private static Logger
  logger
Initial: Logger.getLogger(SearchRetrieverRequestBean.class)
private int
  numberOfRecords
Notes: The total number of records from the search request
public static String
  parameterCqlQuery
Initial: "cql"
Notes: The HTTP-GET parameter name for the cql query
public static String
  parameterSearchType
Initial: "searchType"
Notes: The HTTP-GET parameter name for the search type (advanced, simple, ...)
private Search
  searchService
Notes: An instance of the search service.
private String
  searchType
Notes: The type of the search (simple, advanced, ...)
 
SearchRetrieverRequestBean Methods
Operation Details
protected
checkSortCriterias(
   SORT_CRITERIA sc):void
Sequential
Notes: Checks if the selected sorting criteria is currently available. If not (empty string), it displays a warning message to the user.
private
extractItemsOfSearchResult(
   ItemContainerSearchResult result):ArrayList
Sequential
Notes: Helper method that transforms the result of the search into a list of PubItemVOPresentation objects.
@return
public
getAtomFeedLink():String
Sequential
Tags: throws=PubManVersionNotAvailableException
Notes: @return link to the atom feed for the current search
public
getCqlQuery():String
Sequential
Notes: Returns the current cql query
@return
public
getListPageName():String
Sequential
Tags: annotations=@Override
public
getNormalizedCqlQuery():String
Sequential
Notes: Returns the current cql query without blanks
@return
public
getRssFeedLink():String
Sequential
Tags: throws=PubManVersionNotAvailableException
Notes: @return link to the rss feed for the current search
public
getSearchType():String
Sequential
Notes: Returns the search type (e.g. advanced, simple, ...) Can be used in the jspf in order to display search type specific elements
@return
public
getTotalNumberOfRecords():int
Sequential
Tags: annotations=@Override
public
getType():String
Sequential
Tags: annotations=@Override
public
init():void
Sequential
Tags: annotations=@Override
public
isItemSpecific():boolean
Sequential
Tags: annotations=@Override
public
readOutParameters():void
Sequential
Tags: annotations=@Override
Notes: Reads out the qql query and the search type from HTTP-GET parameeters. If cql is null, an error message is shown. If search type is null, an default value is set
public
retrieveList(
   int offset,
   int limit,
   SORT_CRITERIA sc):List
Sequential
Tags: annotations=@Override
Notes: Calls the search service and requests the items for the current cql query.
public
SearchRetrieverRequestBean():
Sequential
public
setCqlQuery(
   String cqlQuery):void
Sequential
Notes: Sets the current cql query
public
setSearchType(
   String searchType):void
Sequential
Notes: Sets the search type (e.g. advanced, simple, ...) Can be used in the jspf in order to display search type specific elements.