Class: CtdDocumentation::Actionable

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/actionable.rb

Overview

Actionable Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(actionable_id = SKIP, role_number = SKIP, role_name = SKIP) ⇒ Actionable

Returns a new instance of Actionable.



47
48
49
50
51
52
53
 
# File 'lib/ctd_documentation/models/actionable.rb', line 47

def initialize(actionable_id = SKIP,
               role_number = SKIP,
               role_name = SKIP)
  @actionable_id = actionable_id unless actionable_id == SKIP
  @role_number = role_number unless role_number == SKIP
  @role_name = role_name unless role_name == SKIP
end

Instance Attribute Details

#actionable_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/ctd_documentation/models/actionable.rb', line 14

def actionable_id
  @actionable_id
end

#role_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/ctd_documentation/models/actionable.rb', line 22

def role_name
  @role_name
end

#role_number ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/ctd_documentation/models/actionable.rb', line 18

def role_number
  @role_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ctd_documentation/models/actionable.rb', line 56

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  actionable_id = hash.key?('actionable_id') ? hash['actionable_id'] : SKIP
  role_number = hash.key?('role_number') ? hash['role_number'] : SKIP
  role_name = hash.key?('role_name') ? hash['role_name'] : SKIP

  # Create object from extracted values.
  Actionable.new(actionable_id,
                 role_number,
                 role_name)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/ctd_documentation/models/actionable.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['actionable_id'] = 'actionable_id'
  @_hash['role_number'] = 'role_number'
  @_hash['role_name'] = 'role_name'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/ctd_documentation/models/actionable.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/ctd_documentation/models/actionable.rb', line 34

def self.optionals
  %w[
    actionable_id
    role_number
    role_name
  ]
end