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

Interface RegistrationBean

All Superinterfaces:

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

All Known Implementing Classes:

RegistrationBeanImpl

public interface RegistrationBean
extends MaintainableBean, ConstrainableBean

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
DataSourceBean	getDataSource()
TERTIARY_BOOL	getIndexAttributes() The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition).
TERTIARY_BOOL	getIndexDataset() The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition).
TERTIARY_BOOL	getIndexReportingPeriod() The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source.
TERTIARY_BOOL	getIndexTimeSeries() The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data.
SdmxDate	getLastUpdated() Returns when the registration was last updated
RegistrationMutableBean	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 RegistrationMutableBean.
CrossReferenceBean	getProvisionAgreementRef()
SdmxDate	getValidFrom()
SdmxDate	getValidTo()
boolean	isIndexed() Returns true if one of the index getters is set to true

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

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

getCrossReferencedConstrainables

Method Detail

isIndexed

boolean isIndexed()

Returns true if one of the index getters is set to true

Returns:

getIndexTimeSeries

TERTIARY_BOOL getIndexTimeSeries()

The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data.

The index will create a Keyset Constraint

The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.

Returns:

getIndexDataset

TERTIARY_BOOL getIndexDataset()

The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition).

The index will create a Cube Region Constraint

The default value is false.

Returns:

getIndexAttributes

TERTIARY_BOOL getIndexAttributes()

The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition).

The default value is false.

Returns:

getIndexReportingPeriod

TERTIARY_BOOL getIndexReportingPeriod()

The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source.

The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.

Returns:

getLastUpdated

SdmxDate getLastUpdated()

Returns when the registration was last updated

Returns:

getValidFrom

SdmxDate getValidFrom()

getValidTo

SdmxDate getValidTo()

getDataSource

DataSourceBean getDataSource()

getProvisionAgreementRef

CrossReferenceBean getProvisionAgreementRef()

getMutableInstance

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

Specified by:

getMutableInstance in interface MaintainableBean

Returns: