org.sdmxsource.sdmx.api.model.beans.reference

Interface IdentifiableRefBean

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IdentifiableRefBeanImpl

public interface IdentifiableRefBean
extends java.io.Serializable

Used to reference an SDMX identifiable artifact

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
IdentifiableRefBean	getChildReference() Returns a reference to the child identifiable artifact that is being referenced.
java.lang.String	getId() Returns the id of the identifiable that is being referenced (at this level of the referencing hierarchy)
IdentifiableBean	getMatch(IdentifiableBean reference) Returns the matched identifiable bean, from the given identifiable - returns null if no match is found
IdentifiableRefBean	getParentIdentifiableReference() Returns a reference to the parent identifiable artifact (not maintainable) that this identifiable artifact is a child of, returns null if the identifiable artifact has no parent identifiable artifact
StructureReferenceBean	getParentMaintainableReferece() Returns a reference to the parent maintainable that this identifiable is a child of, this will never be null
SDMX_STRUCTURE_TYPE	getStructureType() Returns the identifiable structure that is being referenced (at this level of the referencing hierarchy)

Method Detail

getStructureType

SDMX_STRUCTURE_TYPE getStructureType()

Returns the identifiable structure that is being referenced (at this level of the referencing hierarchy)

Returns:

getId

java.lang.String getId()

Returns the id of the identifiable that is being referenced (at this level of the referencing hierarchy)

Returns:

getChildReference

IdentifiableRefBean getChildReference()

Returns a reference to the child identifiable artifact that is being referenced. returns null if there is no child identifiable being referenced (i.e. this is the end of the reference chain)

Returns:

getParentIdentifiableReference

IdentifiableRefBean getParentIdentifiableReference()

Returns a reference to the parent identifiable artifact (not maintainable) that this identifiable artifact is a child of, returns null if the identifiable artifact has no parent identifiable artifact

Returns:

getParentMaintainableReferece

StructureReferenceBean getParentMaintainableReferece()

Returns a reference to the parent maintainable that this identifiable is a child of, this will never be null

Returns:

getMatch

IdentifiableBean getMatch(IdentifiableBean reference)

Returns the matched identifiable bean, from the given identifiable - returns null if no match is found

Parameters:

reference -

Returns: