org.gcube.portlets.user.results.client
Interface ResultsetService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

NewresultsetServiceImpl

public interface ResultsetService
extends com.google.gwt.user.client.rpc.RemoteService

ResultsetService interface for server calls

Version:

January 2009 (0.1)

Author:

Massimiliano Assante, ISTI-CNR - massimiliano.assante@isti.cnr.it

Method Summary

List<BasketModelItem>	getBasketContent(String basketId)
String[]	getCollectionNames()
String	getDefaultBasket() return the id of the default basket
Client_DigiObjectInfo	getDigitalObjectInitialInfo(int currPosition) used to get the additional info for the digital objects,
String	getObjectsPayload(String objectURI)
QueryDescriptor	getQueryDescFromSession()
ResultsContainer	getResultFromSearchService(int mode)
ResultsContainer	getResultsFromSession()
ResultNumber	getResultsNo()
TreeNode	getWorkspaceTree()
boolean	isSearchActive() Check whether the porlet has been loaded after a search or not
void	loadResults(String qid)
BasketSerializable	readBasketFromSession() read the basket from the session, if any
Boolean	removeBasketItemFromSession(BasketModelItem toRemove)
boolean	saveBasket() Calls the home library to save the current basket in session permanently *
Boolean	storeBasketItemInSession(BasketModelItem toAdd) add a single item in session
void	submitSimpleQuery(String queryTerm)

Method Detail

isSearchActive

boolean isSearchActive()

Check whether the porlet has been loaded after a search or not

Returns:

true if the user performed a search, false otherwise

getResultsFromSession

ResultsContainer getResultsFromSession()

Returns:

A ResultsContainer (Vector, Optional paramters) which contains the current yet shown results (if any)

getResultFromSearchService

ResultsContainer getResultFromSearchService(int mode)

Parameters:

mode - 0 means "get first results", 1 means "get previous results" and 2 means "get next results".

Returns:

a Vector containing the html representation of each record.

getDigitalObjectInitialInfo

Client_DigiObjectInfo getDigitalObjectInitialInfo(int currPosition)

used to get the additional info for the digital objects,

Parameters:

currPosition - in resultset

Returns:

additional info (name, MimeType.....)

getCollectionNames

String[] getCollectionNames()

Returns:

loadResults

void loadResults(String qid)

Parameters:

qid -

getWorkspaceTree

TreeNode getWorkspaceTree()

Returns:

getDefaultBasket

String getDefaultBasket()

return the id of the default basket

Returns:

the default basket

getBasketContent

List<BasketModelItem> getBasketContent(String basketId)

Parameters:

basketId -

Returns:

Throws:

org.gcube.portlets.user.homelibrary.home.workspace.exceptions.ItemNotFoundException

BasketNotFoundException

readBasketFromSession

BasketSerializable readBasketFromSession()

read the basket from the session, if any

Returns:

storeBasketItemInSession

Boolean storeBasketItemInSession(BasketModelItem toAdd)

add a single item in session

Parameters:

item - item to add

removeBasketItemFromSession

Boolean removeBasketItemFromSession(BasketModelItem toRemove)

Parameters:

toRemove - item to remove

Returns:

remove result

saveBasket

boolean saveBasket()

Calls the home library to save the current basket in session permanently *

getQueryDescFromSession

QueryDescriptor getQueryDescFromSession()

Returns:

getResultsNo

ResultNumber getResultsNo()

Returns:

a ResultNumber instance containing the num of results found so far plus a boolean that say if is still counting or not

submitSimpleQuery

void submitSimpleQuery(String queryTerm)

Parameters:

queryTerm -

getObjectsPayload

String getObjectsPayload(String objectURI)