org.sdmxsource.sdmx.api.model.beans.registry

Interface SubscriptionBean

All Superinterfaces:

AnnotableBean, java.lang.Comparable<MaintainableBean>, IdentifiableBean, MaintainableBean, NameableBean, SDMXBean, SdmxStructureBean, java.io.Serializable

All Known Implementing Classes:

SubscriptionBeanImpl

public interface SubscriptionBean
extends MaintainableBean

Represents an SDMX Subscription

Author:

Matt Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SubscriptionBean.SUBSCRIPTION_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WILDCARD

Fields inherited from interface org.sdmxsource.sdmx.api.model.beans.base.MaintainableBean

DEFAULT_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getHTTPPostTo() Returns a list of HTTP addresses to POST any notifications to
java.util.List<java.lang.String>	getMailTo() Returns a list of email addresses to mail any notifications to
SubscriptionMutableBean	getMutableInstance() Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the MaintainableBean.
CrossReferenceBean	getOwner() Returns a reference to the owner of this subscription
java.util.List<StructureReferenceBean>	getReferences() Returns a list of structures that this subscription is subscribing to, or in the case that this is subscribing to a provision or registration, returns the structure reference that it is subscribing to the provision or registration by.
SubscriptionBean.SUBSCRIPTION_TYPE	getSubscriptionType() Returns if this is a subscription for a structure event a provision event or a registration event

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.MaintainableBean

addAnnotations, getAgencyId, getEndDate, getServiceURL, getStartDate, getStructureURL, getStub, getVersion, isExternalReference, isFinal

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.NameableBean

getDescription, getDescriptions, getName, getNames

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.IdentifiableBean

asReference, getAllTextTypes, getFullIdPath, getId, getUri, getUrn

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.AnnotableBean

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SdmxStructureBean

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SDMXBean

deepEquals, getComposites, getComposites, getCrossReferences, getParent, getStructureType

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

WILDCARD

static final java.lang.String WILDCARD

See Also:

Constant Field Values

Method Detail

getOwner

CrossReferenceBean getOwner()

Returns a reference to the owner of this subscription

Returns:

getMailTo

java.util.List<java.lang.String> getMailTo()

Returns a list of email addresses to mail any notifications to

Returns:

getHTTPPostTo

java.util.List<java.lang.String> getHTTPPostTo()

Returns a list of HTTP addresses to POST any notifications to

Returns:

getReferences

java.util.List<StructureReferenceBean> getReferences()

Returns a list of structures that this subscription is subscribing to, or in the case that this is subscribing to a provision or registration, returns the structure reference that it is subscribing to the provision or registration by.

Returns:

getSubscriptionType

SubscriptionBean.SUBSCRIPTION_TYPE getSubscriptionType()

Returns if this is a subscription for a structure event a provision event or a registration event

Returns:

getMutableInstance

SubscriptionMutableBean getMutableInstance()

Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the MaintainableBean.

Specified by:

getMutableInstance in interface MaintainableBean

Returns: