interface: PubItemSearching

public abstract <<interface>> interface: PubItemSearching
Author: $Author: tendres $
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 423 $ $LastChangedDate: 2007-11-07 17:2; Complexity: 1
Dates: Created: 16.07.2009 15:31:25; Modified: 16.07.2009 15:31:25;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {FDE3E045-BB73-4e9a-9012-9BF0D00392FE}
Interface of the PubMan Search Service.
@created 22-Jan-2007 16:17:37 Revised by NiH: 13.09.2007
 

Goto: Fields, Methods

See also: RestServlet, PubItemSearchingBean, AdvancedSearchTest, SearchAndOutputTest, SearchPubItemsByAffiliationTest, SearchTest

Appears in: pubman

Connections
 
PubItemSearching Attributes
Attribute Details
public static const String
  SERVICE_NAME
Initial: "ejb/de/mpg/escidoc/services/pubman/PubItemSearching"
Notes: The service name.
 
PubItemSearching Methods
Operation Details
public
advancedSearch(
   ArrayList list,
   String language):List
Sequential
Tags: throws=ParseException,TechnicalException
Notes: Searches for publication items that matches the given query.
@return The list of PubItemResultVOs that matched the query.
public
getCqlQuery():String
Sequential
Notes: retieves the cql search query of the advanced search method.
@return (String): the cql query string.
public
search(
   String searchString,
   boolean searchInFiles):List
Sequential
Tags: throws=ParseException,TechnicalException
Notes: Searches for publication items that matches the given query.
@return The list of PubItemResultVOs that matched the query.
public
searchAndOutput(
   String cqlQuery,
   String language,
   String exportFormat,
   String outputFormat):byte
Sequential
Tags: throws=ParseException,TechnicalException
Notes: Searches for publication items that matches the given query and returns output as one of the export formats.
@return the result of the output according as byte array
public
searchByContextObjectIdAndDate(
   String contextobjId,
   Date greaterDate):List
Sequential
Tags: throws=ParseException,TechnicalException
Notes: Searches for publication items that matches the given context object id and the given date. All items which are greater than the given date matches.
@param searchString The search query.
@param searchInFiles If true, search is also executed in files.
@return The list of PubItemResultVOs that matched the query.
public
searchPubItemsByAffiliation(
   AffiliationVO affilation):List
Sequential
Tags: throws=TechnicalException,AffiliationNotFoundException
Notes: Searches for all items that belong to the given affiliation. An item belongs to an affilation if it has the affiliationPID set in the item metadata as a creator-organization-id or a creator-person-organisation-id.
@param affilationRef The reference of the affiliation
@return The list of PubItemVOs that belong to the given affiliation.