org.sdmxsource.sdmx.api.model.beans.base

Interface MaintainableBean

All Superinterfaces:

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

All Known Subinterfaces:

AgencySchemeBean, AttachmentConstraintBean, CategorisationBean, CategorySchemeBean, CodelistBean, ConceptSchemeBean, ConstraintBean, ContentConstraintBean, CrossSectionalDataStructureBean, DataConsumerSchemeBean, DataflowBean, DataProviderSchemeBean, DataStructureBean, HierarchicalCodelistBean, ItemSchemeBean<T>, MetadataFlowBean, MetadataStructureDefinitionBean, OrganisationSchemeBean<T>, OrganisationUnitSchemeBean, ProcessBean, ProvisionAgreementBean, RegistrationBean, ReportingTaxonomyBean, StructureSetBean, StructureUsage, SubscriptionBean

All Known Implementing Classes:

AgencySchemeBeanImpl, AttachmentConstraintBeanImpl, CategorisationBeanImpl, CategorySchemeBeanImpl, CodelistBeanImpl, ConceptSchemeBeanImpl, ConstraintBeanImpl, ContentConstraintBeanImpl, CrossSectionalDataStructureBeanImpl, DataConsumerSchemeBeanImpl, DataflowBeanImpl, DataProviderSchemeBeanImpl, DataStructureBeanImpl, HierarchicalCodelistBeanImpl, ItemSchemeBeanImpl, MaintainableBeanImpl, MetadataflowBeanImpl, MetadataStructureDefinitionBeanImpl, OrganisationSchemeBeanImpl, OrganisationUnitSchemeBeanImpl, ProcessBeanImpl, ProvisionAgreementBeanImpl, RegistrationBeanImpl, ReportingTaxonomyBeanImpl, StructureSetBeanImpl, SubscriptionBeanImpl

public interface MaintainableBean
extends NameableBean, java.lang.Comparable<MaintainableBean>

A MaintainableBean is a top level bean (contains no parents), it has a reference to an Agency getAgencyId() and has a mandatory id and a mandatory version, defaulting to 1.0.

The unique identifier of a maintainable artefact is the AgencyId, Id and Version.

Each maintainable artefact can create a mutable representation of itself (getMutableInstance()) and can also return a stub representation of itself getStub().

Author:

Matt Nelson

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
MaintainableBean	addAnnotations(java.util.Map<StructureReferenceBean,java.util.Set<AnnotationMutableBean>> annotations) Adds a annotations to a copy of this bean, and returns the copy
java.lang.String	getAgencyId() Returns the agency id that is responsible for maintaining this maintainable artifact
SdmxDate	getEndDate() Returns the end date of this maintainable artifact, returns null if there is no endDate
MaintainableMutableBean	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.
java.net.URL	getServiceURL() The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved.
SdmxDate	getStartDate() Returns the start date of this maintainable artifact, returns null if there is no startDate
java.net.URL	getStructureURL() The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained.
MaintainableBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.
java.lang.String	getVersion() Returns the version of this maintainable artifact, default version is 1.0 Version is a integer value with period '.' separators between integers, for example 1.2.3.19
TERTIARY_BOOL	isExternalReference() Returns TERTIARY_BOOL.TRUE if this maintainable artifact is externally referenced
TERTIARY_BOOL	isFinal() Returns TERTIARY_BOOL.TRUE if the structure is marked as final, meaning the structure can not be modified

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

DEFAULT_VERSION

static final java.lang.String DEFAULT_VERSION

See Also:

Constant Field Values

Method Detail

getAgencyId

java.lang.String getAgencyId()

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

Returns:

getVersion

java.lang.String getVersion()

Returns the version of this maintainable artifact, default version is 1.0

Version is a integer value with period '.' separators between integers, for example 1.2.3.19

Returns:

getStartDate

SdmxDate getStartDate()

Returns the start date of this maintainable artifact, returns null if there is no startDate

Returns:

getEndDate

SdmxDate getEndDate()

Returns the end date of this maintainable artifact, returns null if there is no endDate

Returns:

isFinal

TERTIARY_BOOL isFinal()

Returns TERTIARY_BOOL.TRUE if the structure is marked as final, meaning the structure can not be modified

Returns:

isExternalReference

TERTIARY_BOOL isExternalReference()

Returns TERTIARY_BOOL.TRUE if this maintainable artifact is externally referenced

Returns:

getStub

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

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

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:

addAnnotations

MaintainableBean addAnnotations(java.util.Map<StructureReferenceBean,java.util.Set<AnnotationMutableBean>> annotations)

Adds a annotations to a copy of this bean, and returns the copy

Parameters:

ref - a map of structure references to a set of annotations to add

Returns:

getMutableInstance

MaintainableMutableBean 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.

Returns:

getServiceURL

java.net.URL getServiceURL()

The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. Optional.

Returns:

Since:

v2.1 SDMX Schema

getStructureURL

java.net.URL getStructureURL()

The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this my be a URL of an SDMX RESTful web service which will return the referenced object. Optional.

Returns:

Since:

v2.1 SDMX Schema