eu.dnetlib.enabling.resultset.rmi

Interface ResultSetService

All Superinterfaces:

BaseService

public interface ResultSetService
extends BaseService

ResultSet service interface. TODO: implement other compatibility methods as needed.

Author:

marko

Method Summary

Modifier and Type	Method and Description
void	closeRS(String rsId) close a result set.
W3CEndpointReference	createPullRS(String dataProviderServiceAddress, String bdId, int initialPageSize, int expiryTime, String styleSheet, Integer keepAliveTime, Integer total) create a new pull rs.
W3CEndpointReference	createPullRSEPR(W3CEndpointReference dataProviderEPR, String bdId, int initialPageSize, int expiryTime, String styleSheet, Integer keepAliveTime, Integer total) create a new pull rs.
W3CEndpointReference	createPushRS(int expiryTime, int keepAliveTime) create a new push resultset.
int	getNumberOfElements(String rsId) get the number of result elements present in the resultset.
String	getProperty(String rsId, String name) read a resultset property.
List<String>	getResult(String rsId, int fromPosition, int toPosition, String requestMode) get one 'page' of results.
String	getRSStatus(String rsId) return current status of a resultset.
String	identify() Identifies the service's version.
String	populateRS(String rsId, List<String> elements) add new data to a push resultset.

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

notify, start

Method Detail

createPullRSEPR

W3CEndpointReference createPullRSEPR(W3CEndpointReference dataProviderEPR,
                                     String bdId,
                                     int initialPageSize,
                                     int expiryTime,
                                     String styleSheet,
                                     Integer keepAliveTime,
                                     Integer total)

create a new pull rs.

Parameters:

bdId - bulk data identifier

initialPageSize - page size for the polling on the server side.

expiryTime - RS expiry time

Returns:

createPullRS

W3CEndpointReference createPullRS(String dataProviderServiceAddress,
                                  String bdId,
                                  int initialPageSize,
                                  int expiryTime,
                                  String styleSheet,
                                  Integer keepAliveTime,
                                  Integer total)

create a new pull rs. compatibility version

Parameters:

bdId - bulk data identifier

initialPageSize - page size for the polling on the server side.

expiryTime - RS expiry time

Returns:

closeRS

void closeRS(String rsId)

close a result set. A closed resultset is guaranteed not to grow.

Parameters:

rsId -

getResult

List<String> getResult(String rsId,
                       int fromPosition,
                       int toPosition,
                       String requestMode)
                throws ResultSetException

get one 'page' of results. TODO: define how results are returned when the range is not present in the result set.

Parameters:

fromPosition - counting from 1

toPosition - included

requestMode -

Returns:

a page of data

Throws:

ResultSetException

getNumberOfElements

int getNumberOfElements(String rsId)
                 throws ResultSetException

get the number of result elements present in the resultset.

Parameters:

rsId - result set identifier

Returns:

number of results available in the resultset

Throws:

ResultSetException

createPushRS

W3CEndpointReference createPushRS(int expiryTime,
                                  int keepAliveTime)
                           throws ResultSetException

create a new push resultset.

Parameters:

expiryTime - RS expiry time

keepAliveTime - keep alive time

Returns:

epr of new resultset

Throws:

ResultSetException

populateRS

String populateRS(String rsId,
                  List<String> elements)
           throws ResultSetException

add new data to a push resultset.

Parameters:

rsId - resultset id

elements - list of elements to be addded

Returns:

dummy value

Throws:

ResultSetException

getRSStatus

String getRSStatus(String rsId)
            throws ResultSetException

return current status of a resultset.

Parameters:

rsId - resultset id

Returns:

status

Throws:

ResultSetException

getProperty

String getProperty(String rsId,
                   String name)
            throws ResultSetException

read a resultset property.

Parameters:

rsId - resultset id

name - property value

Returns:

property value

Throws:

ResultSetException

identify

String identify()

Description copied from interface: BaseService

Identifies the service's version. Version syntax: ${NAME}-${MAJOR}.${MINOR}.${MICRO}[-${LABEL}]

Specified by:

identify in interface BaseService

Returns:

the service's version