Class: GOBL::CBC::Definition

Inherits:

Object

• Object
• Struct
• Object
• GOBL::CBC::Definition

Defined in:

lib/generated/gobl/cbc/definition.rb

Overview

Definition defines properties of a key, code, or other value that has a specific meaning or utility.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Definition structure

'https://gobl.org/draft-0/cbc/definition'

Instance Attribute Summary

• #code ⇒ GOBL::CBC::Code readonly

  Code this definition represents.

• #desc ⇒ GOBL::I18n::String readonly

  Description offering more details about when the key should be used.

• #key ⇒ GOBL::CBC::Key readonly

  Key being defined.

• #map ⇒ GOBL::CBC::CodeMap readonly

  Map helps map local keys to specific codes, useful for converting the described key into a local code.

• #meta ⇒ GOBL::CBC::Meta readonly

  Meta defines any additional details that may be useful or associated with the key.

• #name ⇒ GOBL::I18n::String readonly

  Short name for the key.

• #pattern ⇒ String readonly

  Pattern is used to validate the key value instead of using a fixed value from the code or key definitions.

• #sources ⇒ Array<GOBL::CBC::Source> readonly

  Where the information was sourced from.

• #values ⇒ Array<GOBL::CBC::Definition> readonly

  Values defines the possible values associated with the key, which themselves will either be keys or codes depending on the context.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#code ⇒ GOBL::CBC::Code (readonly)

Code this definition represents.

Returns:

• (GOBL::CBC::Code)

# File 'lib/generated/gobl/cbc/definition.rb', line 23

property :code, GOBL::CBC::Code

#desc ⇒ GOBL::I18n::String (readonly)

Description offering more details about when the key should be used.

Returns:

• (GOBL::I18n::String)

# File 'lib/generated/gobl/cbc/definition.rb', line 34

property :desc, GOBL::I18n::String

#key ⇒ GOBL::CBC::Key (readonly)

Key being defined.

Returns:

• (GOBL::CBC::Key)

# File 'lib/generated/gobl/cbc/definition.rb', line 18

property :key, GOBL::CBC::Key

#map ⇒ GOBL::CBC::CodeMap (readonly)

Map helps map local keys to specific codes, useful for converting the described key into a local code.

Returns:

• (GOBL::CBC::CodeMap)

# File 'lib/generated/gobl/cbc/definition.rb', line 59

property :map, GOBL::CBC::CodeMap

#meta ⇒ GOBL::CBC::Meta (readonly)

Meta defines any additional details that may be useful or associated with the key.

Returns:

• (GOBL::CBC::Meta)

# File 'lib/generated/gobl/cbc/definition.rb', line 39

property :meta, GOBL::CBC::Meta

#name ⇒ GOBL::I18n::String (readonly)

Short name for the key.

Returns:

• (GOBL::I18n::String)

# File 'lib/generated/gobl/cbc/definition.rb', line 28

property :name, GOBL::I18n::String

#pattern ⇒ String (readonly)

Pattern is used to validate the key value instead of using a fixed value from the code or key definitions.

Returns:

• (String)

# File 'lib/generated/gobl/cbc/definition.rb', line 54

property :pattern, String

#sources ⇒ Array<GOBL::CBC::Source> (readonly)

Where the information was sourced from.

Returns:

• (Array<GOBL::CBC::Source>)

# File 'lib/generated/gobl/cbc/definition.rb', line 44

property :sources, [GOBL::CBC::Source]

#values ⇒ Array<GOBL::CBC::Definition> (readonly)

Values defines the possible values associated with the key, which themselves will either be keys or codes depending on the context.

Returns:

• (Array<GOBL::CBC::Definition>)

# File 'lib/generated/gobl/cbc/definition.rb', line 49

property :values, [GOBL::CBC::Definition]