org.sdmxsource.sdmx.api.model.beans.metadatastructure

Interface MetadataStructureDefinitionBean

All Superinterfaces:

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

All Known Implementing Classes:

MetadataStructureDefinitionBeanImpl

public interface MetadataStructureDefinitionBean
extends MaintainableBean

Represents a SDMX Metadata Structure Definition (MSD)

Field Summary

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

DEFAULT_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
MetadataTargetBean	getMetadataTarget(java.lang.String id) Returns the metadata target with the given id, or null if no such target exists
java.util.List<MetadataTargetBean>	getMetadataTargets() Returns all the available targets as defined by this MSD
MetadataStructureDefinitionMutableBean	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.
ReportStructureBean	getReportStructure(java.lang.String id) Returns the report structure with the given id, or null if no such report structure exists
java.util.List<ReportStructureBean>	getReportStructures() Returns all the report structures defined by the MSD
MetadataStructureDefinitionBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.

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

addAnnotations, getAgencyId, 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, 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

Method Detail

getMetadataTargets

java.util.List<MetadataTargetBean> getMetadataTargets()

Returns all the available targets as defined by this MSD

Returns:

getMetadataTarget

MetadataTargetBean getMetadataTarget(java.lang.String id)

Returns the metadata target with the given id, or null if no such target exists

Parameters:

id -

Returns:

getReportStructures

java.util.List<ReportStructureBean> getReportStructures()

Returns all the report structures defined by the MSD

Returns:

getReportStructure

ReportStructureBean getReportStructure(java.lang.String id)

Returns the report structure with the given id, or null if no such report structure exists

Returns:

getStub

MetadataStructureDefinitionBean 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

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

MetadataStructureDefinitionMutableBean 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: