Class: Kickflow::FormField

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

Overview

フォームフィールド

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/kickflow/models/form_field.rb', line 196

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kickflow::FormField` 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::FormField`. 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?(:'title')
    self.title = attributes[:'title']
  else
    self.title = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'hidden')
    self.hidden = attributes[:'hidden']
  end

  if attributes.key?(:'readonly_on_ui')
    self.readonly_on_ui = attributes[:'readonly_on_ui']
  end
end

Instance Attribute Details

#approver ⇒ Object

承認者が編集可能かどうか



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

def approver
  @approver
end

#author ⇒ Object

申請者が編集可能かどうか



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

def author
  @author
end

#code ⇒ Object

コード



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

def code
  @code
end

#decimal_digit ⇒ Object

小数の桁数



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

def decimal_digit
  @decimal_digit
end

#default_value ⇒ Object

初期値



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

def default_value
  @default_value
end

#delimited ⇒ Object

カンマ区切りで表示する場合true。 整数、数値、自動計算フィールド以外ではnullが入ります。



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

def delimited
  @delimited
end

#description ⇒ Object

説明文



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

def description
  @description
end

#field_type ⇒ Object

フィールドの型



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

def field_type
  @field_type
end

#formula ⇒ Object

計算式。 型がcalculationのときのみ値が入ります。



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

def formula
  @formula
end

#hidden ⇒ Object

隠しフィールドである場合true



83
84
85
 
# File 'lib/kickflow/models/form_field.rb', line 83

def hidden
  @hidden
end

#id ⇒ Object

UUID



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

def id
  @id
end

#max_length ⇒ Object

最大文字数



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

def max_length
  @max_length
end

#max_value ⇒ Object

最大値



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

def max_value
  @max_value
end

#min_length ⇒ Object

最小文字数



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

def min_length
  @min_length
end

#min_value ⇒ Object

最小値



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

def min_value
  @min_value
end

#options ⇒ Object

選択肢のリスト。型がcheckboxまたはpull_downのときのみ値が入ります。



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

def options
  @options
end

#prefix ⇒ Object

単位（接頭辞）



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

def prefix
  @prefix
end

#readonly_on_ui ⇒ Object

trueの時、申請者・承認者が画面上から値を入力することを禁止します。 ボタン（外部API連携）による代入や、REST API経由での入力はこのオプションの対象外です。



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

def readonly_on_ui
  @readonly_on_ui
end

#regexp_format ⇒ Object

正規表現フォーマット



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

def regexp_format
  @regexp_format
end

#required ⇒ Object

必須項目かどうか



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

def required
  @required
end

#size ⇒ Object

フォームサイズ。fullの場合全幅、halfの場合1/2になります。



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

def size
  @size
end

#suffix ⇒ Object

単位（接尾辞）



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

def suffix
  @suffix
end

#title ⇒ Object

説明文



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

def title
  @title
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



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/kickflow/models/form_field.rb', line 570

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



140
141
142
 
# File 'lib/kickflow/models/form_field.rb', line 140

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/kickflow/models/form_field.rb', line 111

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'description' => :'description',
    :'field_type' => :'fieldType',
    :'required' => :'required',
    :'approver' => :'approver',
    :'author' => :'author',
    :'options' => :'options',
    :'code' => :'code',
    :'size' => :'size',
    :'regexp_format' => :'regexpFormat',
    :'formula' => :'formula',
    :'default_value' => :'defaultValue',
    :'min_value' => :'minValue',
    :'max_value' => :'maxValue',
    :'min_length' => :'minLength',
    :'max_length' => :'maxLength',
    :'decimal_digit' => :'decimalDigit',
    :'delimited' => :'delimited',
    :'prefix' => :'prefix',
    :'suffix' => :'suffix',
    :'hidden' => :'hidden',
    :'readonly_on_ui' => :'readonlyOnUi'
  }
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



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/kickflow/models/form_field.rb', line 546

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/kickflow/models/form_field.rb', line 174

def self.openapi_nullable
  Set.new([
    :'description',
    :'options',
    :'regexp_format',
    :'formula',
    :'default_value',
    :'min_value',
    :'max_value',
    :'min_length',
    :'max_length',
    :'decimal_digit',
    :'delimited',
    :'prefix',
    :'suffix',
    :'hidden',
    :'readonly_on_ui'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/kickflow/models/form_field.rb', line 145

def self.openapi_types
  {
    :'id' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'field_type' => :'String',
    :'required' => :'Boolean',
    :'approver' => :'Boolean',
    :'author' => :'Boolean',
    :'options' => :'Array<String>',
    :'code' => :'String',
    :'size' => :'String',
    :'regexp_format' => :'String',
    :'formula' => :'String',
    :'default_value' => :'String',
    :'min_value' => :'Float',
    :'max_value' => :'Float',
    :'min_length' => :'Float',
    :'max_length' => :'Float',
    :'decimal_digit' => :'Integer',
    :'delimited' => :'Boolean',
    :'prefix' => :'String',
    :'suffix' => :'String',
    :'hidden' => :'Boolean',
    :'readonly_on_ui' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/kickflow/models/form_field.rb', line 503

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      description == o.description &&
      field_type == o.field_type &&
      required == o.required &&
      approver == o.approver &&
      author == o.author &&
      options == o.options &&
      code == o.code &&
      size == o.size &&
      regexp_format == o.regexp_format &&
      formula == o.formula &&
      default_value == o.default_value &&
      min_value == o.min_value &&
      max_value == o.max_value &&
      min_length == o.min_length &&
      max_length == o.max_length &&
      decimal_digit == o.decimal_digit &&
      delimited == o.delimited &&
      prefix == o.prefix &&
      suffix == o.suffix &&
      hidden == o.hidden &&
      readonly_on_ui == o.readonly_on_ui
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



641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/kickflow/models/form_field.rb', line 641

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


533
534
535
 
# File 'lib/kickflow/models/form_field.rb', line 533

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



539
540
541
 
# File 'lib/kickflow/models/form_field.rb', line 539

def hash
  [id, title, description, field_type, required, approver, author, options, code, size, regexp_format, formula, default_value, min_value, max_value, min_length, max_length, decimal_digit, delimited, prefix, suffix, hidden, readonly_on_ui].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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
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
 
# File 'lib/kickflow/models/form_field.rb', line 346

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 @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @title.to_s.length > 255
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
  end

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

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

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

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

  if @code.to_s.length > 255
    invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 255.')
  end

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

  if @min_length < 0
    invalid_properties.push('invalid value for "min_length", must be greater than or equal to 0.')
  end

  if @max_length < 0
    invalid_properties.push('invalid value for "max_length", must be greater than or equal to 0.')
  end

  if @decimal_digit < 0
    invalid_properties.push('invalid value for "decimal_digit", must be greater than or equal to 0.')
  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



617
618
619
 
# File 'lib/kickflow/models/form_field.rb', line 617

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



623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/kickflow/models/form_field.rb', line 623

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



611
612
613
 
# File 'lib/kickflow/models/form_field.rb', line 611

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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/kickflow/models/form_field.rb', line 402

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @title.nil?
  return false if @title.to_s.length > 255
  return false if @field_type.nil?
  field_type_validator = EnumAttributeValidator.new('String', ["text", "text_long", "number", "integer", "checkbox", "pull_down", "date", "file", "master", "user", "team", "ticket", "calculation", "button_api"])
  return false unless field_type_validator.valid?(@field_type)
  return false if @required.nil?
  return false if @approver.nil?
  return false if @code.nil?
  return false if @code.to_s.length > 255
  return false if @size.nil?
  size_validator = EnumAttributeValidator.new('String', ["full", "half"])
  return false unless size_validator.valid?(@size)
  return false if @min_length < 0
  return false if @max_length < 0
  return false if @decimal_digit < 0
  true
end