IM-JS

Class: DataQueryHCode

data. DataQueryHCode

new DataQueryHCode()

Extends

Methods

clone()

Return a copy of this structure

Inherited From:

getAgencyId()

Returns the Id of the Agency who is responsible for maintaining this structure

Inherited From:
Returns:

The Agency Id

Type
string

getAnnotations()

Returns an array of bean.base.AnnotationBean for this structure, or an empty array if there are none

Inherited From:
Returns:

Array of AnnotationBean's for this Object

Type
Array.<bean.base.AnnotationBean>

getAnnotationsWithTitle(title)

Returns an array of bean.base.AnnotationBean with the given title, or an empty array if none exist

Parameters:
Name Type Description
title string

the title to of the Annotation
Inherited From:
Returns:

Array of Annotation beans

Type
Array.<bean.base.AnnotationBean>

getAnnotationsWithType(type)

Returns an array of bean.base.AnnotationBean with the given type, or an empty array if none exist

Parameters:
Name Type Description
type string

the type to of the Annotation
Inherited From:
Returns:

Array of Annotation beans

Type
Array.<bean.base.AnnotationBean>

getChildren()

Returns an Array of child DataQueryHCodes or an empty array if there are none

Returns:
Type
Array.<data.DataQueryHCode>

getClassType( [bean])

Get the name of the class of this object

Parameters:
Name Type Argument Default Description
bean boolean <optional>
 false

If true, the word "bean" will be omitted
Inherited From:
Throws:

If the first argument is supplied but not a boolean

Type
TypeError
Returns:

Name of the class type (constructor)

Type
string
Example
let myCodelist = new CodelistBean(jsonFromServer);
myCodelist.getClassType(); // returns 'CodelistBean' 
myCodelist.getClassType(true); // returns 'Codelist'

getDataQueryCode()

Returns the DataQueryCode, this will be null if displayOnly = true

Returns:
Type
data.DataQueryCode

getGuid()

Returns a non-editable unique Identifier for this bean, for client side only.

This GUID is generated automatically on the client on construction, the GUID is completely random and will not be the same for a structure with the same URN if the physical object differes.

Inherited From:
Returns:

An immutable string containing the a unique identifier for this structure

Type
string
Example
var jsonCL = 'get JSON from server
var codelist1 = new Codelist(jsonCL);
var codelist2 = new Codelist(jsonCL);

console.log(codelist1.getUrn() === codelist2.getUrn()); //outputs true
console.log(codelist1._guid() === codelist2._guid()); //outputs false

getId()

Returns the Id of this DataQueryCode

Returns:
Type
string

getLevel()

Returns the depth of this item in the hierarchy, starting from 1

Returns:
Type
number

getMaintainableParent()

Returns the bean.base.MaintainableBean to which which this structure belongs. All structures must either be a MaintainableBean or be contained within a MaintainableBean.

If this class is a MaintainableBean, then it will return itself as MaintainableBean is the outermost container for all structures

Inherited From:
Returns:

This objects maintainable parent

Type
bean.base.MaintainableBean
Example
var annualCode = myCodeList.getItem("A");
annualCode.getMaintainableParent() // returns 'myCodeList'

getMetadata(callBack)

Retrieves all of the associated metadata.ReferenceMetadata for this structure

Parameters:
Name Type Description
callBack IdentifiableBean~MetadataCallBack

a callback for complete
Inherited From:

getMetadataDefs()

Returns an array of @see metadata.ReferenceMetadataLink, or an empty array if there are none

Inherited From:

getName()

Returns the name of this DataQueryCode

Returns:
Type
string

getParent()

Returns the parent DataQueryHCode or null if there is no parent

Overrides:
Returns:
Type
data.DataQueryHCode

hasAnnotations()

Returns true if there are at least one annotation on this bean

Inherited From:
Returns:
Type
boolean

hasAnnotationsWithType(title)

Returns true if this has annotations with the given title

Parameters:
Name Type Description
title string

the title to of the Annotation
Inherited From:
Returns:

true if annotations exist with the given title

Type
boolean

hasChildren()

Returns true if this DataQueryHCode has child DataQueryHCodes

Returns:
Type
boolean

hasMetadata()

Returns true if this structure has any metadata.ReferenceMetadata associated with it, if so the #getMetadataDefs can be used to return the Definitions for each linked report, and #getMetadata
can be used to retrieve all the metadata.ReferenceMetadata

Inherited From:
Returns:

true if has Reference Metadata

Type
boolean

hasParent()

Returns true if this DataQueryHCode has a parent DataQueryHCode

Returns:
Type
boolean

isDisplayOnly()

Returns true if this Code is display only, if it is display only then it will be a Code which has no data available for it and can therefore not be used in
a data query. It will however have child Code(s) which do have data.

The purpose of a display only code is for building a navigational hierarchy in a User Interface

Returns:
Type
boolean

toString()

Returns a string that represents this Bean.

If this Bean is an bean.base.IdentifiableBean then this will output the URN, otherwise the GUID will be returned

Inherited From:
Returns:

The URN or GUID

Type
string
Example
let myCodelist = new CodelistBean(jsonFromServer);
myCodelist.toString() // returns: 'urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_FREQ(1.0)'