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

Interface ItemSchemeBean<T extends ItemBean>

Type Parameters:

T -

All Superinterfaces:

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

All Known Subinterfaces:

AgencySchemeBean, CategorySchemeBean, CodelistBean, ConceptSchemeBean, DataConsumerSchemeBean, DataProviderSchemeBean, OrganisationSchemeBean<T>, OrganisationUnitSchemeBean, ReportingTaxonomyBean

All Known Implementing Classes:

AgencySchemeBeanImpl, CategorySchemeBeanImpl, CodelistBeanImpl, ConceptSchemeBeanImpl, DataConsumerSchemeBeanImpl, DataProviderSchemeBeanImpl, ItemSchemeBeanImpl, OrganisationSchemeBeanImpl, OrganisationUnitSchemeBeanImpl, ReportingTaxonomyBeanImpl

public interface ItemSchemeBean<T extends ItemBean>
extends MaintainableBean

An ItemScheme contains a list of items

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
ItemSchemeBean<T>	filterItems(java.util.Collection<java.lang.String> filterIds, boolean isKeepSet) Returns a new item scheme based on the item filters, which are either removed or kept depending on the isKeepSet argument
java.util.List<T>	getItems() Returns the list of items contained within this scheme.
boolean	isPartial() Returns true if this is a partial item scheme

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

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

Method Detail

getItems

java.util.List<T> getItems()

Returns the list of items contained within this scheme.

NOTEThe list is a copy so modify the returned set will not be reflected in the ItemSchemeBean instance

Returns:

isPartial

boolean isPartial()

Returns true if this is a partial item scheme

Returns:

filterItems

ItemSchemeBean<T> filterItems(java.util.Collection<java.lang.String> filterIds,
                            boolean isKeepSet)

Returns a new item scheme based on the item filters, which are either removed or kept depending on the isKeepSet argument

Parameters:

filterIds -

isKeepSet - if true then the returned item scheme will contain only items with these ids

Returns: