org.dataone.service.mn.v2

Interface MNQuery

All Known Subinterfaces:

MNode

All Known Implementing Classes:

MultipartMNode

public interface MNQuery

The DataONE MemberNode Optional Query interface. This defines an implementation interface for MemberNodes Nodes that wish to build an implementation that is compliant with the DataONE service definitions.

Author:

Rob Nahf

Method Summary

Modifier and Type	Method and Description
QueryEngineDescription	getQueryEngineDescription(Session session, String queryEngine)
QueryEngineList	listQueryEngines(Session session)
InputStream	query(Session session, String queryEngine, String query)

Method Detail

query

InputStream query(Session session,
                  String queryEngine,
                  String query)
           throws InvalidToken,
                  ServiceFailure,
                  NotAuthorized,
                  InvalidRequest,
                  NotImplemented,
                  NotFound

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNQuery.query

getQueryEngineDescription

QueryEngineDescription getQueryEngineDescription(Session session,
                                                 String queryEngine)
                                          throws InvalidToken,
                                                 ServiceFailure,
                                                 NotAuthorized,
                                                 NotImplemented,
                                                 NotFound

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNQuery.getQueryEngineDescription

listQueryEngines

QueryEngineList listQueryEngines(Session session)
                          throws InvalidToken,
                                 ServiceFailure,
                                 NotAuthorized,
                                 NotImplemented

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNQuery.listQueryEngines