Class: Kickflow::SlipField

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

Overview

明細フィールド

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SlipField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



182
183
184
185
186
187
188
189
190
191
192
193
194
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
 
# File 'lib/kickflow/models/slip_field.rb', line 182

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

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

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

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

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

  if attributes.key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  else
    self.options = 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?(:'max_value')
    self.max_value = attributes[:'max_value']
  else
    self.max_value = nil
  end

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

  if attributes.key?(:'default_value')
    self.default_value = attributes[:'default_value']
  else
    self.default_value = 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?(:'allowed_extensions')
    if (value = attributes[:'allowed_extensions']).is_a?(Array)
      self.allowed_extensions = value
    end
  else
    self.allowed_extensions = 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?(:'approver')
    self.approver = attributes[:'approver']
  else
    self.approver = nil
  end

  if attributes.key?(:'author')
    self.author = attributes[:'author']
  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

#allowed_extensions ⇒ Object

添付可能な拡張子リスト



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

def allowed_extensions
  @allowed_extensions
end

#approver ⇒ Object

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



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

def approver
  @approver
end

#author ⇒ Object

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



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

def author
  @author
end

#code ⇒ Object

フィールドのコード



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

def code
  @code
end

#decimal_digit ⇒ Object

小数の桁数



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

def decimal_digit
  @decimal_digit
end

#default_value ⇒ Object

初期値



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

def default_value
  @default_value
end

#delimited ⇒ Object

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



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

def delimited
  @delimited
end

#field_type ⇒ Object

フィールドの型



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

def field_type
  @field_type
end

#formula ⇒ Object

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



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

def formula
  @formula
end

#hidden ⇒ Object

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



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

def hidden
  @hidden
end

#id ⇒ Object

UUID



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

def id
  @id
end

#max_value ⇒ Object

最大値



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

def max_value
  @max_value
end

#min_value ⇒ Object

最小値



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

def min_value
  @min_value
end

#options ⇒ Object

選択肢。プルダウンまたはチェックボックスのときのみ値が入ります。



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

def options
  @options
end

#prefix ⇒ Object

単位（接頭辞）



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

def prefix
  @prefix
end

#readonly_on_ui ⇒ Object

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



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

def readonly_on_ui
  @readonly_on_ui
end

#regexp_format ⇒ Object

正規表現フォーマット



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

def regexp_format
  @regexp_format
end

#required ⇒ Object

入力必須の場合true



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

def required
  @required
end

#show_total ⇒ Object

列の合計を表示する場合true



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

def show_total
  @show_total
end

#suffix ⇒ Object

単位（接尾辞）



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

def suffix
  @suffix
end

#title ⇒ Object

タイトル



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

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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/kickflow/models/slip_field.rb', line 459

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



132
133
134
 
# File 'lib/kickflow/models/slip_field.rb', line 132

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/kickflow/models/slip_field.rb', line 105

def self.attribute_map
  {
    :'id' => :'id',
    :'field_type' => :'fieldType',
    :'code' => :'code',
    :'title' => :'title',
    :'required' => :'required',
    :'show_total' => :'showTotal',
    :'options' => :'options',
    :'regexp_format' => :'regexpFormat',
    :'formula' => :'formula',
    :'max_value' => :'maxValue',
    :'min_value' => :'minValue',
    :'default_value' => :'defaultValue',
    :'decimal_digit' => :'decimalDigit',
    :'delimited' => :'delimited',
    :'allowed_extensions' => :'allowedExtensions',
    :'prefix' => :'prefix',
    :'suffix' => :'suffix',
    :'approver' => :'approver',
    :'author' => :'author',
    :'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



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/kickflow/models/slip_field.rb', line 435

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/kickflow/models/slip_field.rb', line 164

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

.openapi_types ⇒ Object

Attribute type mapping.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/kickflow/models/slip_field.rb', line 137

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/kickflow/models/slip_field.rb', line 530

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


422
423
424
 
# File 'lib/kickflow/models/slip_field.rb', line 422

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



428
429
430
 
# File 'lib/kickflow/models/slip_field.rb', line 428

def hash
  [id, field_type, code, title, required, show_total, options, regexp_format, formula, max_value, min_value, default_value, decimal_digit, delimited, allowed_extensions, prefix, suffix, approver, author, 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



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
360
361
362
 
# File 'lib/kickflow/models/slip_field.rb', line 322

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

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

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

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

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

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

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

  if @approver.nil?
    invalid_properties.push('invalid value for "approver", approver 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



506
507
508
 
# File 'lib/kickflow/models/slip_field.rb', line 506

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



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/kickflow/models/slip_field.rb', line 512

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



500
501
502
 
# File 'lib/kickflow/models/slip_field.rb', line 500

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/kickflow/models/slip_field.rb', line 366

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @field_type.nil?
  field_type_validator = EnumAttributeValidator.new('String', ["text", "number", "integer", "calculation", "pull_down", "checkbox", "date", "file", "master", "user", "team", "ticket"])
  return false unless field_type_validator.valid?(@field_type)
  return false if @code.nil?
  return false if @title.nil?
  return false if @required.nil?
  return false if @show_total.nil?
  return false if @options.nil?
  return false if @allowed_extensions.nil?
  return false if @approver.nil?
  true
end