org.fosstrak.epcis.repository
Interface EpcisQueryCallbackInterface

All Known Implementing Classes:

QuerySubscription, QuerySubscriptionScheduled, QuerySubscriptionTriggered

public interface EpcisQueryCallbackInterface

The EPCIS Query Callback Interface is the path by which an EPCIS service delivers standing query results to a client.

Each time the EPCIS service executes a standing query according to a QuerySchedule, it SHALL attempt to deliver results to the subscriber by invoking one of the three methods of the Query Callback Interface. If the query executed normally, the EPCIS service SHALL invoke the callbackResults method. If the query resulted in a QueryTooLargeException or ImplementationException, the EPCIS service SHALL invoke the corresponding method of the Query Callback Interface.

Note that "exceptions" in the Query Callback Interface are not exceptions in the usual sense of an API exception, because they are not raised as a consequence of a client invoking a method. Instead, the exception is delivered to the recipient in a similar manner to a normal result, as an argument to an interface method.

Method Summary

void	callbackImplementationException(ImplementationException e) Delivers the results of a standing query to the subscriber when the query resulted in a ImplementationException.
void	callbackQueryTooLargeException(QueryTooLargeException e) Delivers the results of a standing query to the subscriber when the query resulted in a QueryTooLargeException.
void	callbackResults(QueryResults resultData) Delivers the results of a standing query to the subscriber when the query executed normally.

Method Detail

callbackResults

void callbackResults(QueryResults resultData)

Delivers the results of a standing query to the subscriber when the query executed normally.

Parameters:

resultData - The results of the execution of a standing query.

callbackQueryTooLargeException

void callbackQueryTooLargeException(QueryTooLargeException e)

Delivers the results of a standing query to the subscriber when the query resulted in a QueryTooLargeException.

Parameters:

e - The QueryTooLargeException thrown during execution of a standing query.

callbackImplementationException

void callbackImplementationException(ImplementationException e)

Delivers the results of a standing query to the subscriber when the query resulted in a ImplementationException.

Parameters:

e - The ImplementationException thrown during execution of a standing query.