org.sdmxsource.sdmx.api.model.beans.categoryscheme

Interface CategorySchemeBean

All Superinterfaces:

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

All Known Implementing Classes:

CategorySchemeBeanImpl

public interface CategorySchemeBean
extends ItemSchemeBean<CategoryBean>

Represents an SDMX Category Scheme

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
CategoryBean	getCategory(java.lang.String... id) Returns the category with the given id, additional ids are used to represent the categories parents if it is in a hierarchy.
CategorySchemeMutableBean	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.
CategorySchemeBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.

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

filterItems, getItems, isPartial

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

getStub

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

getCategory

CategoryBean getCategory(java.lang.String... id)

Returns the category with the given id, additional ids are used to represent the categories parents if it is in a hierarchy.

Returns null if the category can not be found with the given id

Parameters:

id -

Returns:

getMutableInstance

CategorySchemeMutableBean 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

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: