Class: GOBL::CBC::KeyDefinition

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

Overview

KeyDefinition defines properties of a key that is specific for a regime.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL KeyDefinition structure

'https://gobl.org/draft-0/cbc/key-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

#codes ⇒ Array<GOBL::CBC::CodeDefinition> (readonly)

Codes describes the list of codes that can be used alongside the Key, for example with identities.

Returns:



40
 
# File 'lib/generated/gobl/cbc/key_definition.rb', line 40

property :codes, [GOBL::CBC::CodeDefinition]

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

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

Returns:



30
 
# File 'lib/generated/gobl/cbc/key_definition.rb', line 30

property :desc, GOBL::I18n::String

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

Actual key value.

Returns:



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

property :key, GOBL::CBC::Key

#keys ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

Keys is used instead of codes to define a further sub-set of keys that can be used alongside this one.

Returns:



45
 
# File 'lib/generated/gobl/cbc/key_definition.rb', line 45

property :keys, [GOBL::CBC::KeyDefinition]

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

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

Returns:



55
 
# File 'lib/generated/gobl/cbc/key_definition.rb', line 55

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:



35
 
# File 'lib/generated/gobl/cbc/key_definition.rb', line 35

property :meta, GOBL::CBC::Meta

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

Short name for the key.

Returns:



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

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) 


50
 
# File 'lib/generated/gobl/cbc/key_definition.rb', line 50

property :pattern, String