Package cdm.base.staticdata.codelist

Interface CodeListIdentification

All Superinterfaces:
com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
CodeListIdentification.CodeListIdentificationBuilder
All Known Implementing Classes:
CodeListIdentification.CodeListIdentificationBuilderImpl, CodeListIdentification.CodeListIdentificationImpl
@RosettaDataType(value="CodeListIdentification", builder=CodeListIdentificationBuilderImpl.class, version="7.0.0-dev.105") @RuneDataType(value="CodeListIdentification", model="cdm", builder=CodeListIdentificationBuilderImpl.class, version="7.0.0-dev.105") public interface CodeListIdentification extends com.rosetta.model.lib.RosettaModelObject
A type to identify the version of a codelist
Version:
7.0.0-dev.105

  • Field Details

  • Method Details

    • getDescription

      String getDescription()
      A description of the code list, e.g. A list of codes identifying business centers

    • getPublicationDate

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

    • getShortName

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

    • getVersion

      String getVersion()
      The the most recent version of the codelist, eg. 9-1

    • getCodeShortId

      String getCodeShortId()
      The name of the code list, e.g. business-center

    • getCanonicalUri

      String getCanonicalUri()
      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.

    • getCanonicalVersionUri

      String getCanonicalVersionUri()
      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.

    • getLocationUri

      String getLocationUri()
      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.

    • build

      CodeListIdentification build()
      Build Methods
      Specified by:
      build in interface com.rosetta.model.lib.RosettaModelObject

    • toBuilder

      CodeListIdentification.CodeListIdentificationBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static CodeListIdentification.CodeListIdentificationBuilder builder()

    • metaData

      default com.rosetta.model.lib.meta.RosettaMetaData<? extends CodeListIdentification> metaData()
      Utility Methods
      Specified by:
      metaData in interface com.rosetta.model.lib.RosettaModelObject

    • getType

      @RuneAttribute("@type") default Class<? extends CodeListIdentification> getType()
      Specified by:
      getType in interface com.rosetta.model.lib.RosettaModelObject

    • process

      default void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
      Specified by:
      process in interface com.rosetta.model.lib.RosettaModelObject