org.sdmxsource.sdmx.api.manager.retrieval

Interface SdmxSubscriptionRetrievalManager

public interface SdmxSubscriptionRetrievalManager

Manages the retrieval of subscriptions

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
int	getSubscriptionCount() Returns a count of all the subscriptions in the system
java.util.Set<SubscriptionBean>	getSubscriptions(OrganisationBean organisation) Returns a set of all the subscriptions which are owned by the a given organisation.
java.util.Set<SubscriptionBean>	getSubscriptions(StructureReferenceBean organisationReference) Returns a set of all the subscriptions for a given organisation (Data Consumer, Data Provider or Agency)
java.util.Set<SubscriptionBean>	getSubscriptionsForEvent(IdentifiableBean triggerEvent, SubscriptionBean.SUBSCRIPTION_TYPE type) Returns a set of subscriptions of the given type for the trigger identifiable

Method Detail

getSubscriptionCount

int getSubscriptionCount()

Returns a count of all the subscriptions in the system

Returns:

getSubscriptions

java.util.Set<SubscriptionBean> getSubscriptions(OrganisationBean organisation)

Returns a set of all the subscriptions which are owned by the a given organisation.

Returns an empty set if no subscriptions are found

Returns:

getSubscriptions

java.util.Set<SubscriptionBean> getSubscriptions(StructureReferenceBean organisationReference)

Returns a set of all the subscriptions for a given organisation (Data Consumer, Data Provider or Agency)

Parameters:

organisationReference - this will be validated that the reference is to a data consumer, and it a full reference (contains all reference parameters)

Returns:

Throws:

CrossReferenceException - if the StructureReferenceBean does not reference a valid Organisation

getSubscriptionsForEvent

java.util.Set<SubscriptionBean> getSubscriptionsForEvent(IdentifiableBean triggerEvent,
                                                       SubscriptionBean.SUBSCRIPTION_TYPE type)

Returns a set of subscriptions of the given type for the trigger identifiable

Parameters:

triggerEvent - the identifiable that triggers this event

type - This defines the type of subscriptions to return

Returns: