Class: AsposeCellsCloud::Validation

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/validation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Validation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
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
172
173
174
175
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 117

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'AlertStyle')
      self.alert_style = attributes[:'AlertStyle']
  end
  if attributes.has_key?(:'AreaList')
      self.area_list = attributes[:'AreaList']
  end
  if attributes.has_key?(:'ErrorMessage')
      self.error_message = attributes[:'ErrorMessage']
  end
  if attributes.has_key?(:'ErrorTitle')
      self.error_title = attributes[:'ErrorTitle']
  end
  if attributes.has_key?(:'Formula1')
      self.formula1 = attributes[:'Formula1']
  end
  if attributes.has_key?(:'Formula2')
      self.formula2 = attributes[:'Formula2']
  end
  if attributes.has_key?(:'IgnoreBlank')
      self.ignore_blank = attributes[:'IgnoreBlank']
  end
  if attributes.has_key?(:'InCellDropDown')
      self.in_cell_drop_down = attributes[:'InCellDropDown']
  end
  if attributes.has_key?(:'InputMessage')
      self.input_message = attributes[:'InputMessage']
  end
  if attributes.has_key?(:'InputTitle')
      self.input_title = attributes[:'InputTitle']
  end
  if attributes.has_key?(:'Operator')
      self.operator = attributes[:'Operator']
  end
  if attributes.has_key?(:'ShowError')
      self.show_error = attributes[:'ShowError']
  end
  if attributes.has_key?(:'ShowInput')
      self.show_input = attributes[:'ShowInput']
  end
  if attributes.has_key?(:'Type')
      self.type = attributes[:'Type']
  end
  if attributes.has_key?(:'Value1')
      self.value1 = attributes[:'Value1']
  end
  if attributes.has_key?(:'Value2')
      self.value2 = attributes[:'Value2']
  end
  if attributes.has_key?(:'link')
      self.link = attributes[:'link']
  end

end

Instance Attribute Details

#alert_style ⇒ Object

Represents the validation alert style.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 35

def alert_style
  @alert_style
end

#area_list ⇒ Object

Represents a collection of Aspose.Cells.CellArea which contains the data validation settings.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 37

def area_list
  @area_list
end

#error_message ⇒ Object

Represents the data validation error message.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 39

def error_message
  @error_message
end

#error_title ⇒ Object

Represents the title of the data-validation error dialog box.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 41

def error_title
  @error_title
end

#formula1 ⇒ Object

Represents the value or expression associated with the data validation.



43
44
45
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 43

def formula1
  @formula1
end

#formula2 ⇒ Object

Represents the value or expression associated with the data validation.



45
46
47
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 45

def formula2
  @formula2
end

#ignore_blank ⇒ Object

Indicates whether blank values are permitted by the range data validation.



47
48
49
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 47

def ignore_blank
  @ignore_blank
end

#in_cell_drop_down ⇒ Object

Indicates whether data validation displays a drop-down list that contains acceptable values.



49
50
51
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 49

def in_cell_drop_down
  @in_cell_drop_down
end

#input_message ⇒ Object

Represents the data validation input message.



51
52
53
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 51

def input_message
  @input_message
end

#input_title ⇒ Object

Represents the title of the data-validation input dialog box.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 53

def input_title
  @input_title
end

#link ⇒ Object

Returns the value of attribute link.



67
68
69
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 67

def link
  @link
end

#operator ⇒ Object

Represents the operator for the data validation.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 55

def operator
  @operator
end

#show_error ⇒ Object

Indicates whether the data validation error message will be displayed whenever the user enters invalid data.



57
58
59
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 57

def show_error
  @show_error
end

#show_input ⇒ Object

Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.



59
60
61
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 59

def show_input
  @show_input
end

#type ⇒ Object

Represents the data validation type.



61
62
63
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 61

def type
  @type
end

#value1 ⇒ Object

Represents the first value associated with the data validation.



63
64
65
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 63

def value1
  @value1
end

#value2 ⇒ Object

Represents the second value associated with the data validation.



65
66
67
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 65

def value2
  @value2
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 70

def self.attribute_map
  {
    :'alert_style' => :'AlertStyle',
    :'area_list' => :'AreaList',
    :'error_message' => :'ErrorMessage',
    :'error_title' => :'ErrorTitle',
    :'formula1' => :'Formula1',
    :'formula2' => :'Formula2',
    :'ignore_blank' => :'IgnoreBlank',
    :'in_cell_drop_down' => :'InCellDropDown',
    :'input_message' => :'InputMessage',
    :'input_title' => :'InputTitle',
    :'operator' => :'Operator',
    :'show_error' => :'ShowError',
    :'show_input' => :'ShowInput',
    :'type' => :'Type',
    :'value1' => :'Value1',
    :'value2' => :'Value2',
    :'link' => :'link'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 93

def self.swagger_types
  {
    :'alert_style' => :'String',
    :'area_list' => :'Array<CellArea>',
    :'error_message' => :'String',
    :'error_title' => :'String',
    :'formula1' => :'String',
    :'formula2' => :'String',
    :'ignore_blank' => :'BOOLEAN',
    :'in_cell_drop_down' => :'BOOLEAN',
    :'input_message' => :'String',
    :'input_title' => :'String',
    :'operator' => :'String',
    :'show_error' => :'BOOLEAN',
    :'show_input' => :'BOOLEAN',
    :'type' => :'String',
    :'value1' => :'String',
    :'value2' => :'String',
    :'link' => :'Link'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alert_style == o.alert_style &&
      area_list == o.area_list &&
      error_message == o.error_message &&
      error_title == o.error_title &&
      formula1 == o.formula1 &&
      formula2 == o.formula2 &&
      ignore_blank == o.ignore_blank &&
      in_cell_drop_down == o.in_cell_drop_down &&
      input_message == o.input_message &&
      input_title == o.input_title &&
      operator == o.operator &&
      show_error == o.show_error &&
      show_input == o.show_input &&
      type == o.type &&
      value1 == o.value1 &&
      value2 == o.value2 &&
      link == o.link 
      std_dev == o.std_dev
end

#_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



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
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 320

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 386

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

#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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 299

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 292

def hash
  [ alert_style , area_list , error_message , error_title , formula1 , formula2 , ignore_blank , in_cell_drop_down , input_message , input_title , operator , show_error , show_input , type , value1 , value2 , link ].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



179
180
181
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
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @alert_style.nil?
      invalid_properties.push("invalid value for 'alert_style', alert_style cannot be nil.")
  end
  if @area_list.nil?
      invalid_properties.push("invalid value for 'area_list', area_list cannot be nil.")
  end
  if @error_message.nil?
      invalid_properties.push("invalid value for 'error_message', error_message cannot be nil.")
  end
  if @error_title.nil?
      invalid_properties.push("invalid value for 'error_title', error_title cannot be nil.")
  end
  if @formula1.nil?
      invalid_properties.push("invalid value for 'formula1', formula1 cannot be nil.")
  end
  if @formula2.nil?
      invalid_properties.push("invalid value for 'formula2', formula2 cannot be nil.")
  end
  if @ignore_blank.nil?
      invalid_properties.push("invalid value for 'ignore_blank', ignore_blank cannot be nil.")
  end
  if @in_cell_drop_down.nil?
      invalid_properties.push("invalid value for 'in_cell_drop_down', in_cell_drop_down cannot be nil.")
  end
  if @input_message.nil?
      invalid_properties.push("invalid value for 'input_message', input_message cannot be nil.")
  end
  if @input_title.nil?
      invalid_properties.push("invalid value for 'input_title', input_title cannot be nil.")
  end
  if @operator.nil?
      invalid_properties.push("invalid value for 'operator', operator cannot be nil.")
  end
  if @show_error.nil?
      invalid_properties.push("invalid value for 'show_error', show_error cannot be nil.")
  end
  if @show_input.nil?
      invalid_properties.push("invalid value for 'show_input', show_input cannot be nil.")
  end
  if @type.nil?
      invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end
  if @value1.nil?
      invalid_properties.push("invalid value for 'value1', value1 cannot be nil.")
  end
  if @value2.nil?
      invalid_properties.push("invalid value for 'value2', value2 cannot be nil.")
  end
  if @link.nil?
      invalid_properties.push("invalid value for 'link', link cannot be nil.")
  end

  return 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



366
367
368
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 366

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



372
373
374
375
376
377
378
379
380
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 372

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



360
361
362
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 360

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose_cells_cloud/models/validation.rb', line 238

def valid?
  return false if @alert_style.nil?
  return false if @area_list.nil?
  return false if @error_message.nil?
  return false if @error_title.nil?
  return false if @formula1.nil?
  return false if @formula2.nil?
  return false if @ignore_blank.nil?
  return false if @in_cell_drop_down.nil?
  return false if @input_message.nil?
  return false if @input_title.nil?
  return false if @operator.nil?
  return false if @show_error.nil?
  return false if @show_input.nil?
  return false if @type.nil?
  return false if @value1.nil?
  return false if @value2.nil?
  return false if @link.nil?
  return true
end