org.sdmxsource.sdmx.api.model.beans.codelist

Interface CodelistBean

All Superinterfaces:

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

All Known Implementing Classes:

CodelistBeanImpl

public interface CodelistBean
extends ItemSchemeBean<CodeBean>

Represents an SDMX Code List

               __
              / _)
     _/\/\/\_/ /
   _|         /
  _|  (  | (  |
 /__.-'|_|--|_|     Raaar
 

Author:

Matt Nelson

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
CodeBean	getCodeById(java.lang.String id) Returns the code with the given id, returns null if there is no code with the id provided
CodelistMutableBean	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.
CodelistBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.
boolean	isPartial() Returns true if the codelist is only reporting a subset of the codes.

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

filterItems, getItems

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

isPartial

boolean isPartial()

Returns true if the codelist is only reporting a subset of the codes.

Partial codelists are used for dissemination purposes only not for reporting updates.

Specified by:

isPartial in interface ItemSchemeBean<CodeBean>

Returns:

getCodeById

CodeBean getCodeById(java.lang.String id)

Returns the code with the given id, returns null if there is no code with the id provided

Returns:

getStub

CodelistBean 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

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