Class: Kickflow::Workflow

Inherits:
Object
  • Object
show all
Defined in:
lib/kickflow/models/workflow.rb

Overview

ワークフロー

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Workflow

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/kickflow/models/workflow.rb', line 195

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kickflow::Workflow` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kickflow::Workflow`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  else
    self.code = nil
  end

  if attributes.key?(:'version_id')
    self.version_id = attributes[:'version_id']
  else
    self.version_id = nil
  end

  if attributes.key?(:'version_number')
    self.version_number = attributes[:'version_number']
  else
    self.version_number = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = nil
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'public_ticket')
    self.public_ticket = attributes[:'public_ticket']
  else
    self.public_ticket = false
  end

  if attributes.key?(:'visible_to_manager')
    self.visible_to_manager = attributes[:'visible_to_manager']
  else
    self.visible_to_manager = nil
  end

  if attributes.key?(:'visible_to_team_members')
    self.visible_to_team_members = attributes[:'visible_to_team_members']
  else
    self.visible_to_team_members = false
  end

  if attributes.key?(:'title_description')
    self.title_description = attributes[:'title_description']
  else
    self.title_description = nil
  end

  if attributes.key?(:'slip')
    self.slip = attributes[:'slip']
  else
    self.slip = false
  end

  if attributes.key?(:'slip_title')
    self.slip_title = attributes[:'slip_title']
  else
    self.slip_title = nil
  end

  if attributes.key?(:'slip_description')
    self.slip_description = attributes[:'slip_description']
  else
    self.slip_description = nil
  end

  if attributes.key?(:'slip_position')
    self.slip_position = attributes[:'slip_position']
  else
    self.slip_position = nil
  end

  if attributes.key?(:'ticket_number_format')
    self.ticket_number_format = attributes[:'ticket_number_format']
  else
    self.ticket_number_format = nil
  end

  if attributes.key?(:'overwritable')
    self.overwritable = attributes[:'overwritable']
  else
    self.overwritable = nil
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  else
    self.updated_at = nil
  end

  if attributes.key?(:'title_input_mode')
    self.title_input_mode = attributes[:'title_input_mode']
  else
    self.title_input_mode = nil
  end

  if attributes.key?(:'title_formula')
    self.title_formula = attributes[:'title_formula']
  else
    self.title_formula = nil
  end

  if attributes.key?(:'author')
    self.author = attributes[:'author']
  else
    self.author = nil
  end

  if attributes.key?(:'version_author')
    self.version_author = attributes[:'version_author']
  else
    self.version_author = nil
  end

  if attributes.key?(:'folder')
    self.folder = attributes[:'folder']
  else
    self.folder = nil
  end

  if attributes.key?(:'categories')
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  else
    self.categories = nil
  end
end

Instance Attribute Details

#author ⇒ Object

Returns the value of attribute author.



82
83
84
 
# File 'lib/kickflow/models/workflow.rb', line 82

def author
  @author
end

#categories ⇒ Object

カテゴリの配列



89
90
91
 
# File 'lib/kickflow/models/workflow.rb', line 89

def categories
  @categories
end

#code ⇒ Object

コード



23
24
25
 
# File 'lib/kickflow/models/workflow.rb', line 23

def code
  @code
end

#created_at ⇒ Object

作成日時



71
72
73
 
# File 'lib/kickflow/models/workflow.rb', line 71

def created_at
  @created_at
end

#description ⇒ Object

説明



35
36
37
 
# File 'lib/kickflow/models/workflow.rb', line 35

def description
  @description
end

#folder ⇒ Object

Returns the value of attribute folder.



86
87
88
 
# File 'lib/kickflow/models/workflow.rb', line 86

def folder
  @folder
end

#id ⇒ Object

UUID



20
21
22
 
# File 'lib/kickflow/models/workflow.rb', line 20

def id
  @id
end

#name ⇒ Object

名前



32
33
34
 
# File 'lib/kickflow/models/workflow.rb', line 32

def name
  @name
end

#overwritable ⇒ Object

承認者による上書きが可能な場合true



68
69
70
 
# File 'lib/kickflow/models/workflow.rb', line 68

def overwritable
  @overwritable
end

#public_ticket ⇒ Object

チケットが全体公開される場合true



41
42
43
 
# File 'lib/kickflow/models/workflow.rb', line 41

def public_ticket
  @public_ticket
end

#slip ⇒ Object

明細を持つ場合true



53
54
55
 
# File 'lib/kickflow/models/workflow.rb', line 53

def slip
  @slip
end

#slip_description ⇒ Object

明細の説明



59
60
61
 
# File 'lib/kickflow/models/workflow.rb', line 59

def slip_description
  @slip_description
end

#slip_position ⇒ Object

明細の位置



62
63
64
 
# File 'lib/kickflow/models/workflow.rb', line 62

def slip_position
  @slip_position
end

#slip_title ⇒ Object

明細タイトル



56
57
58
 
# File 'lib/kickflow/models/workflow.rb', line 56

def slip_title
  @slip_title
end

#status ⇒ Object

ステータス。visibleは有効、invisibleは無効、deletedは削除済み。



38
39
40
 
# File 'lib/kickflow/models/workflow.rb', line 38

def status
  @status
end

#ticket_number_format ⇒ Object

チケット番号のフォーマット



65
66
67
 
# File 'lib/kickflow/models/workflow.rb', line 65

def ticket_number_format
  @ticket_number_format
end

#title_description ⇒ Object

タイトルの説明



50
51
52
 
# File 'lib/kickflow/models/workflow.rb', line 50

def title_description
  @title_description
end

#title_formula ⇒ Object

タイトルの計算式



80
81
82
 
# File 'lib/kickflow/models/workflow.rb', line 80

def title_formula
  @title_formula
end

#title_input_mode ⇒ Object

タイトル入力モード



77
78
79
 
# File 'lib/kickflow/models/workflow.rb', line 77

def title_input_mode
  @title_input_mode
end

#updated_at ⇒ Object

更新日時



74
75
76
 
# File 'lib/kickflow/models/workflow.rb', line 74

def updated_at
  @updated_at
end

#version_author ⇒ Object

Returns the value of attribute version_author.



84
85
86
 
# File 'lib/kickflow/models/workflow.rb', line 84

def version_author
  @version_author
end

#version_id ⇒ Object

バージョンのUUID



26
27
28
 
# File 'lib/kickflow/models/workflow.rb', line 26

def version_id
  @version_id
end

#version_number ⇒ Object

バージョン番号



29
30
31
 
# File 'lib/kickflow/models/workflow.rb', line 29

def version_number
  @version_number
end

#visible_to_manager ⇒ Object

申請者の上長を閲覧者に追加するか。noneは追加しない、directは直属の上長のみ、allはすべての上長を表す。



44
45
46
 
# File 'lib/kickflow/models/workflow.rb', line 44

def visible_to_manager
  @visible_to_manager
end

#visible_to_team_members ⇒ Object

申請チームのメンバーが閲覧者に追加される場合true



47
48
49
 
# File 'lib/kickflow/models/workflow.rb', line 47

def visible_to_team_members
  @visible_to_team_members
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/kickflow/models/workflow.rb', line 606

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Kickflow.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



145
146
147
 
# File 'lib/kickflow/models/workflow.rb', line 145

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/kickflow/models/workflow.rb', line 114

def self.attribute_map
  {
    :'id' => :'id',
    :'code' => :'code',
    :'version_id' => :'versionId',
    :'version_number' => :'versionNumber',
    :'name' => :'name',
    :'description' => :'description',
    :'status' => :'status',
    :'public_ticket' => :'publicTicket',
    :'visible_to_manager' => :'visibleToManager',
    :'visible_to_team_members' => :'visibleToTeamMembers',
    :'title_description' => :'titleDescription',
    :'slip' => :'slip',
    :'slip_title' => :'slipTitle',
    :'slip_description' => :'slipDescription',
    :'slip_position' => :'slipPosition',
    :'ticket_number_format' => :'ticketNumberFormat',
    :'overwritable' => :'overwritable',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'title_input_mode' => :'titleInputMode',
    :'title_formula' => :'titleFormula',
    :'author' => :'author',
    :'version_author' => :'versionAuthor',
    :'folder' => :'folder',
    :'categories' => :'categories'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/kickflow/models/workflow.rb', line 582

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/kickflow/models/workflow.rb', line 181

def self.openapi_nullable
  Set.new([
    :'title_description',
    :'slip_title',
    :'slip_description',
    :'ticket_number_format',
    :'title_formula',
    :'author',
    :'version_author',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/kickflow/models/workflow.rb', line 150

def self.openapi_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'version_id' => :'String',
    :'version_number' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'public_ticket' => :'Boolean',
    :'visible_to_manager' => :'String',
    :'visible_to_team_members' => :'Boolean',
    :'title_description' => :'String',
    :'slip' => :'Boolean',
    :'slip_title' => :'String',
    :'slip_description' => :'String',
    :'slip_position' => :'String',
    :'ticket_number_format' => :'String',
    :'overwritable' => :'Boolean',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'title_input_mode' => :'String',
    :'title_formula' => :'String',
    :'author' => :'User',
    :'version_author' => :'User',
    :'folder' => :'Folder',
    :'categories' => :'Array<Category>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/kickflow/models/workflow.rb', line 537

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      code == o.code &&
      version_id == o.version_id &&
      version_number == o.version_number &&
      name == o.name &&
      description == o.description &&
      status == o.status &&
      public_ticket == o.public_ticket &&
      visible_to_manager == o.visible_to_manager &&
      visible_to_team_members == o.visible_to_team_members &&
      title_description == o.title_description &&
      slip == o.slip &&
      slip_title == o.slip_title &&
      slip_description == o.slip_description &&
      slip_position == o.slip_position &&
      ticket_number_format == o.ticket_number_format &&
      overwritable == o.overwritable &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      title_input_mode == o.title_input_mode &&
      title_formula == o.title_formula &&
      author == o.author &&
      version_author == o.version_author &&
      folder == o.folder &&
      categories == o.categories
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/kickflow/models/workflow.rb', line 677

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


569
570
571
 
# File 'lib/kickflow/models/workflow.rb', line 569

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



575
576
577
 
# File 'lib/kickflow/models/workflow.rb', line 575

def hash
  [id, code, version_id, version_number, name, description, status, public_ticket, visible_to_manager, visible_to_team_members, title_description, slip, slip_title, slip_description, slip_position, ticket_number_format, overwritable, created_at, updated_at, title_input_mode, title_formula, author, version_author, folder, categories].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/kickflow/models/workflow.rb', line 363

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @code !~ pattern
    invalid_properties.push("invalid value for \"code\", must conform to the pattern #{pattern}.")
  end

  if @version_id.nil?
    invalid_properties.push('invalid value for "version_id", version_id cannot be nil.')
  end

  if @version_number.nil?
    invalid_properties.push('invalid value for "version_number", version_number cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @public_ticket.nil?
    invalid_properties.push('invalid value for "public_ticket", public_ticket cannot be nil.')
  end

  if @visible_to_manager.nil?
    invalid_properties.push('invalid value for "visible_to_manager", visible_to_manager cannot be nil.')
  end

  if @visible_to_team_members.nil?
    invalid_properties.push('invalid value for "visible_to_team_members", visible_to_team_members cannot be nil.')
  end

  if @slip.nil?
    invalid_properties.push('invalid value for "slip", slip cannot be nil.')
  end

  if @slip_position.nil?
    invalid_properties.push('invalid value for "slip_position", slip_position cannot be nil.')
  end

  if @overwritable.nil?
    invalid_properties.push('invalid value for "overwritable", overwritable cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @title_input_mode.nil?
    invalid_properties.push('invalid value for "title_input_mode", title_input_mode cannot be nil.')
  end

  if @folder.nil?
    invalid_properties.push('invalid value for "folder", folder cannot be nil.')
  end

  if @categories.nil?
    invalid_properties.push('invalid value for "categories", categories cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



653
654
655
 
# File 'lib/kickflow/models/workflow.rb', line 653

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/kickflow/models/workflow.rb', line 659

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



647
648
649
 
# File 'lib/kickflow/models/workflow.rb', line 647

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/kickflow/models/workflow.rb', line 448

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @code.nil?
  return false if @code !~ Regexp.new(/^[a-zA-Z0-9_-]+$/)
  return false if @version_id.nil?
  return false if @version_number.nil?
  return false if @name.nil?
  return false if @description.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["visible", "invisible", "deleted"])
  return false unless status_validator.valid?(@status)
  return false if @public_ticket.nil?
  return false if @visible_to_manager.nil?
  visible_to_manager_validator = EnumAttributeValidator.new('String', ["none", "direct", "all"])
  return false unless visible_to_manager_validator.valid?(@visible_to_manager)
  return false if @visible_to_team_members.nil?
  return false if @slip.nil?
  return false if @slip_position.nil?
  slip_position_validator = EnumAttributeValidator.new('String', ["top", "bottom"])
  return false unless slip_position_validator.valid?(@slip_position)
  return false if @overwritable.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @title_input_mode.nil?
  title_input_mode_validator = EnumAttributeValidator.new('String', ["none", "input", "calculate"])
  return false unless title_input_mode_validator.valid?(@title_input_mode)
  return false if @folder.nil?
  return false if @categories.nil?
  true
end