org.fosstrak.epcis.queryclient
Interface QueryControlInterface

All Known Implementing Classes:

QueryControlClient

public interface QueryControlInterface

Author:

Marco Steybe

Method Summary

List<String>	getQueryNames() Retrieves the names of queries that can be coped with.
String	getStandardVersion() Retrieves the standard version implemented by this implementation.
List<String>	getSubscriptionIds(String queryName) Retrieves the ID of a subscribed query.
String	getVendorVersion() Retrieves the vendor version.
QueryResults	poll(Poll poll) Performs a poll operation at the repository's Query Controls Module.
void	subscribe(Subscribe subscribe) Performs a subscribe operation at the repository's Query Controls Module, i.e. subscribes a query for later execution.
void	unsubscribe(String subscriptionId) Perform an unsubscribe operation at the repository's Query Controls Module, i.e. unsubscribes a previously subscribed query.

Method Detail

poll

QueryResults poll(Poll poll)
                  throws ImplementationExceptionResponse,
                         QueryTooComplexExceptionResponse,
                         QueryTooLargeExceptionResponse,
                         SecurityExceptionResponse,
                         ValidationExceptionResponse,
                         NoSuchNameExceptionResponse,
                         QueryParameterExceptionResponse

Performs a poll operation at the repository's Query Controls Module.

Parameters:

poll - The Poll object including the query name and parameters to be executed.

Returns:

The QueryResults.

Throws:

QueryParameterExceptionResponse

NoSuchNameExceptionResponse

ValidationExceptionResponse

SecurityExceptionResponse

QueryTooLargeExceptionResponse

QueryTooComplexExceptionResponse

ImplementationExceptionResponse

subscribe

void subscribe(Subscribe subscribe)
               throws DuplicateSubscriptionExceptionResponse,
                      ImplementationExceptionResponse,
                      QueryTooComplexExceptionResponse,
                      SecurityExceptionResponse,
                      InvalidURIExceptionResponse,
                      ValidationExceptionResponse,
                      SubscribeNotPermittedExceptionResponse,
                      NoSuchNameExceptionResponse,
                      SubscriptionControlsExceptionResponse,
                      QueryParameterExceptionResponse

Performs a subscribe operation at the repository's Query Controls Module, i.e. subscribes a query for later execution.

Parameters:

subscribe - The Subscribe object including the query name, the parameters, and subscription id used for subscribing the query.

Throws:

QueryParameterExceptionResponse

SubscriptionControlsExceptionResponse

NoSuchNameExceptionResponse

SubscribeNotPermittedExceptionResponse

ValidationExceptionResponse

InvalidURIExceptionResponse

SecurityExceptionResponse

QueryTooComplexExceptionResponse

ImplementationExceptionResponse

DuplicateSubscriptionExceptionResponse

unsubscribe

void unsubscribe(String subscriptionId)
                 throws ImplementationExceptionResponse,
                        SecurityExceptionResponse,
                        ValidationExceptionResponse,
                        NoSuchSubscriptionExceptionResponse

Perform an unsubscribe operation at the repository's Query Controls Module, i.e. unsubscribes a previously subscribed query.

Parameters:

subscriptionId - The ID of the query to be unsubscribed.

Throws:

NoSuchSubscriptionExceptionResponse

ValidationExceptionResponse

SecurityExceptionResponse

ImplementationExceptionResponse

getQueryNames

List<String> getQueryNames()
                           throws ImplementationExceptionResponse,
                                  SecurityExceptionResponse,
                                  ValidationExceptionResponse

Retrieves the names of queries that can be coped with.

Returns:

A List of query names.

Throws:

ValidationExceptionResponse

SecurityExceptionResponse

ImplementationExceptionResponse

getSubscriptionIds

List<String> getSubscriptionIds(String queryName)
                                throws ImplementationExceptionResponse,
                                       SecurityExceptionResponse,
                                       ValidationExceptionResponse,
                                       NoSuchNameExceptionResponse

Retrieves the ID of a subscribed query.

Parameters:

queryName - The name of the query.

Returns:

A List of IDs.

Throws:

NoSuchNameExceptionResponse

ValidationExceptionResponse

SecurityExceptionResponse

ImplementationExceptionResponse

getStandardVersion

String getStandardVersion()
                          throws ImplementationExceptionResponse,
                                 SecurityExceptionResponse,
                                 ValidationExceptionResponse

Retrieves the standard version implemented by this implementation.

Returns:

The implemented standard version.

Throws:

ValidationExceptionResponse

SecurityExceptionResponse

ImplementationExceptionResponse

getVendorVersion

String getVendorVersion()
                        throws ImplementationExceptionResponse,
                               SecurityExceptionResponse,
                               ValidationExceptionResponse

Retrieves the vendor version.

Returns:

The vendor version.

Throws:

ValidationExceptionResponse

SecurityExceptionResponse

ImplementationExceptionResponse