org.sdmxsource.sdmx.sdmxbeans.model.beans.registry

Class SubscriptionBeanImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SDMXBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SdmxStructureBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.AnnotableBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.IdentifiableBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.NameableBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.MaintainableBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.registry.SubscriptionBeanImpl

All Implemented Interfaces:

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

public class SubscriptionBeanImpl
extends MaintainableBeanImpl
implements SubscriptionBean

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.sdmxsource.sdmx.api.model.beans.registry.SubscriptionBean

SubscriptionBean.SUBSCRIPTION_TYPE

Field Summary

Fields inherited from interface org.sdmxsource.sdmx.api.model.beans.registry.SubscriptionBean

WILDCARD

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

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
SubscriptionBeanImpl(SubscriptionMutableBean mutableBean)
SubscriptionBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.registry.SubscriptionType subscription)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deepEquals(SDMXBean bean, boolean includeFinalProperties) Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration) This method calls deepEquals on any SdmxBean composites.
java.lang.String	getAgencyId() Returns the agency id that is responsible for maintaining this maintainable artifact
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.
MaintainableBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.
SubscriptionBean.SUBSCRIPTION_TYPE	getSubscriptionType() Returns if this is a subscription for a structure event a provision event or a registration event
java.lang.String	getUrn() Returns the URN for this component.

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.MaintainableBeanImpl

addAnnotations, compareTo, getEndDate, getServiceURL, getStartDate, getStructureURL, getVersion, isExternalReference, isFinal

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.NameableBeanImpl

getAllTextTypes, getDescription, getDescriptions, getName, getNames

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.IdentifiableBeanImpl

asReference, equals, getFullIdPath, getId, getUri, hashCode, toString

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.AnnotableBeanImpl

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SdmxStructureBeanImpl

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent, getStructureType

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SDMXBeanImpl

getComposites, getComposites, getCrossReferences, getParent

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

addAnnotations, getEndDate, getServiceURL, getStartDate, getStructureURL, 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

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

getComposites, getComposites, getCrossReferences, getParent, getStructureType

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

SubscriptionBeanImpl

public SubscriptionBeanImpl(SubscriptionMutableBean mutableBean)

SubscriptionBeanImpl

public SubscriptionBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.registry.SubscriptionType subscription)

Method Detail

deepEquals

public boolean deepEquals(SDMXBean bean,
                 boolean includeFinalProperties)

Description copied from interface: SDMXBean

Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration)

This method calls deepEquals on any SdmxBean composites.

Specified by:

deepEquals in interface SDMXBean

Overrides:

deepEquals in class SDMXBeanImpl

Parameters:

bean - if null, then false will be returned

includeFinalProperties - - if true, then this method will check every single property from this bean is equal to the passed in bean. If false, then this method will ignore the following properties:

• Name
• Description
• Annotation
• Valid From (Start Date)
• Valid To (End Date)
• Structure URL
• Service URL
• URI
• Is External Reference

Returns:

getStub

public MaintainableBean getStub(java.net.URL actualLocation,
                       boolean isServiceUrl)

Description copied from interface: MaintainableBean

Returns a stub reference of itself.

A stub bean only contains Maintainable and Identifiable Attributes, not the composite Objects that are contained within the Maintainable

Specified by:

getStub in interface MaintainableBean

Parameters:

actualLocation - the URL indicating where the full structure can be returned from

isServiceUrl - if true this URL will be present on the serviceURL attribute, otherwise it will be treated as a structureURL attribute

Returns:

getMutableInstance

public SubscriptionMutableBean getMutableInstance()

Description copied from interface: SubscriptionBean

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

Specified by:

getMutableInstance in interface SubscriptionBean

Returns:

getOwner

public CrossReferenceBean getOwner()

Description copied from interface: SubscriptionBean

Returns a reference to the owner of this subscription

Specified by:

getOwner in interface SubscriptionBean

Returns:

getAgencyId

public java.lang.String getAgencyId()

Description copied from interface: MaintainableBean

Returns the agency id that is responsible for maintaining this maintainable artifact

Specified by:

getAgencyId in interface MaintainableBean

Overrides:

getAgencyId in class MaintainableBeanImpl

Returns:

getMailTo

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

Description copied from interface: SubscriptionBean

Returns a list of email addresses to mail any notifications to

Specified by:

getMailTo in interface SubscriptionBean

Returns:

getHTTPPostTo

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

Description copied from interface: SubscriptionBean

Returns a list of HTTP addresses to POST any notifications to

Specified by:

getHTTPPostTo in interface SubscriptionBean

Returns:

getReferences

public java.util.List<StructureReferenceBean> getReferences()

Description copied from interface: SubscriptionBean

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.

Specified by:

getReferences in interface SubscriptionBean

Returns:

getSubscriptionType

public SubscriptionBean.SUBSCRIPTION_TYPE getSubscriptionType()

Description copied from interface: SubscriptionBean

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

Specified by:

getSubscriptionType in interface SubscriptionBean

Returns:

getUrn

public java.lang.String getUrn()

Description copied from interface: IdentifiableBean

Returns the URN for this component. The URN is unique to this instance and is a computable generated value based on other attributes set within the component.

Specified by:

getUrn in interface IdentifiableBean

Overrides:

getUrn in class IdentifiableBeanImpl

Returns: