Package cdm.base.staticdata.codelist

Class CodeListIdentification.CodeListIdentificationImpl

java.lang.Object

cdm.base.staticdata.codelist.CodeListIdentification.CodeListIdentificationImpl

All Implemented Interfaces:

CodeListIdentification, com.rosetta.model.lib.RosettaModelObject

Enclosing interface:

CodeListIdentification

public static class CodeListIdentification.CodeListIdentificationImpl
extends Object
implements CodeListIdentification

Immutable Implementation of CodeListIdentification

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.base.staticdata.codelist.CodeListIdentification

CodeListIdentification.CodeListIdentificationBuilder, CodeListIdentification.CodeListIdentificationBuilderImpl, CodeListIdentification.CodeListIdentificationImpl

Field Summary

Fields inherited from interface cdm.base.staticdata.codelist.CodeListIdentification

metaData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CodeListIdentificationImpl(CodeListIdentification.CodeListIdentificationBuilder builder)

Method Summary

Modifier and Type	Method	Description
CodeListIdentification	build()	Build Methods
boolean	equals(Object o)
String	getCanonicalUri()	Canonical URI which uniquely identifies all versions (collectively) of the referenced code list.
String	getCanonicalVersionUri()	Canonical URI which uniquely identifies a specific version of the referenced code list.
String	getCodeShortId()	The name of the code list, e.g. business-center
String	getDescription()	A description of the code list, e.g.
String	getLocationUri()	Suggested retrieval location for this version, in genericode format.
String	getPublicationDate()	The most recent date the code list was published, e.g. 2021-10-05
String	getShortName()	A short name (without whitespace) for the code list, e.g. businessCenterScheme
String	getVersion()	The the most recent version of the codelist, eg. 9-1
int	hashCode()
protected void	setBuilderFields(CodeListIdentification.CodeListIdentificationBuilder builder)
CodeListIdentification.CodeListIdentificationBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cdm.base.staticdata.codelist.CodeListIdentification

getType, metaData, process

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Constructor Details

CodeListIdentificationImpl

protected CodeListIdentificationImpl(CodeListIdentification.CodeListIdentificationBuilder builder)

Method Details

getDescription

@RosettaAttribute("description")
@Accessor(GETTER)
@RuneAttribute("description")
public String getDescription()

Description copied from interface: CodeListIdentification

A description of the code list, e.g. A list of codes identifying business centers

Specified by:

getDescription in interface CodeListIdentification

getPublicationDate

@RosettaAttribute("publicationDate")
@Accessor(GETTER)
@RuneAttribute("publicationDate")
public String getPublicationDate()

Description copied from interface: CodeListIdentification

The most recent date the code list was published, e.g. 2021-10-05

Specified by:

getPublicationDate in interface CodeListIdentification

getShortName

@RosettaAttribute("shortName")
@Accessor(GETTER)
@Required
@RuneAttribute("shortName")
public String getShortName()

Description copied from interface: CodeListIdentification

A short name (without whitespace) for the code list, e.g. businessCenterScheme

Specified by:

getShortName in interface CodeListIdentification

getVersion

@RosettaAttribute("version")
@Accessor(GETTER)
@Required
@RuneAttribute("version")
public String getVersion()

Description copied from interface: CodeListIdentification

The the most recent version of the codelist, eg. 9-1

Specified by:

getVersion in interface CodeListIdentification

getCodeShortId

@RosettaAttribute("codeShortId")
@Accessor(GETTER)
@RuneAttribute("codeShortId")
public String getCodeShortId()

Description copied from interface: CodeListIdentification

The name of the code list, e.g. business-center

Specified by:

getCodeShortId in interface CodeListIdentification

getCanonicalUri

@RosettaAttribute("canonicalUri")
@Accessor(GETTER)
@Required
@RuneAttribute("canonicalUri")
public String getCanonicalUri()

Description copied from interface: CodeListIdentification

Canonical URI which uniquely identifies all versions (collectively) of the referenced code list. Must be an absolute URI. Must not be used as a de facto location URI.

Specified by:

getCanonicalUri in interface CodeListIdentification

getCanonicalVersionUri

@RosettaAttribute("canonicalVersionUri")
@Accessor(GETTER)
@RuneAttribute("canonicalVersionUri")
public String getCanonicalVersionUri()

Description copied from interface: CodeListIdentification

Canonical URI which uniquely identifies a specific version of the referenced code list. Must be an absolute URI. Must not be used as a de facto location URI.

Specified by:

getCanonicalVersionUri in interface CodeListIdentification

getLocationUri

@RosettaAttribute("locationUri")
@Accessor(GETTER)
@RuneAttribute("locationUri")
public String getLocationUri()

Description copied from interface: CodeListIdentification

Suggested retrieval location for this version, in genericode format. An application must signal an error to the user if a document retrieved using a LocationUri is not in genericode format.

Specified by:

getLocationUri in interface CodeListIdentification

build

public CodeListIdentification build()

Description copied from interface: CodeListIdentification

Build Methods

Specified by:

build in interface CodeListIdentification

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

toBuilder

public CodeListIdentification.CodeListIdentificationBuilder toBuilder()

Specified by:

toBuilder in interface CodeListIdentification

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

setBuilderFields

protected void setBuilderFields(CodeListIdentification.CodeListIdentificationBuilder builder)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object