Class: GOBL::CBC::ValueDefinition

Inherits:
Object show all
Defined in:
lib/generated/gobl/cbc/value_definition.rb

Overview

ValueDefinition describes a specific value and how it maps to a human name and description if appropriate.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL ValueDefinition structure

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

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

Returns:



29
 
# File 'lib/generated/gobl/cbc/value_definition.rb', line 29

property :desc, GOBL::I18n::String

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

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

Returns:



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

property :meta, GOBL::CBC::Meta

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

Short name for the value, if relevant.

Returns:



24
 
# File 'lib/generated/gobl/cbc/value_definition.rb', line 24

property :name, GOBL::I18n::String

#value ⇒ String (readonly)

Value for which the definition is for.

Returns:

  • (String) 


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

property :value, String