Class: AlfrescoAPI::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco_api/models/node.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Node

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
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
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/alfresco_api/models/node.rb', line 106

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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'nodeType')
    self.node_type = attributes[:'nodeType']
  end

  if attributes.has_key?(:'isFolder')
    self.is_folder = attributes[:'isFolder']
  end

  if attributes.has_key?(:'isFile')
    self.is_file = attributes[:'isFile']
  end

  if attributes.has_key?(:'isLocked')
    self.is_locked = attributes[:'isLocked']
  else
    self.is_locked = false
  end

  if attributes.has_key?(:'modifiedAt')
    self.modified_at = attributes[:'modifiedAt']
  end

  if attributes.has_key?(:'modifiedByUser')
    self.modified_by_user = attributes[:'modifiedByUser']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'createdByUser')
    self.created_by_user = attributes[:'createdByUser']
  end

  if attributes.has_key?(:'parentId')
    self.parent_id = attributes[:'parentId']
  end

  if attributes.has_key?(:'isLink')
    self.is_link = attributes[:'isLink']
  end

  if attributes.has_key?(:'content')
    self.content = attributes[:'content']
  end

  if attributes.has_key?(:'aspectNames')
    if (value = attributes[:'aspectNames']).is_a?(Array)
      self.aspect_names = value
    end
  end

  if attributes.has_key?(:'properties')
    self.properties = attributes[:'properties']
  end

  if attributes.has_key?(:'allowableOperations')
    if (value = attributes[:'allowableOperations']).is_a?(Array)
      self.allowable_operations = value
    end
  end

  if attributes.has_key?(:'path')
    self.path = attributes[:'path']
  end

  if attributes.has_key?(:'permissions')
    self.permissions = attributes[:'permissions']
  end

end

Instance Attribute Details

#allowable_operations ⇒ Object

Returns the value of attribute allowable_operations.



49
50
51
 
# File 'lib/alfresco_api/models/node.rb', line 49

def allowable_operations
  @allowable_operations
end

#aspect_names ⇒ Object

Returns the value of attribute aspect_names.



45
46
47
 
# File 'lib/alfresco_api/models/node.rb', line 45

def aspect_names
  @aspect_names
end

#content ⇒ Object

Returns the value of attribute content.



43
44
45
 
# File 'lib/alfresco_api/models/node.rb', line 43

def content
  @content
end

#created_at ⇒ Object

Returns the value of attribute created_at.



35
36
37
 
# File 'lib/alfresco_api/models/node.rb', line 35

def created_at
  @created_at
end

#created_by_user ⇒ Object

Returns the value of attribute created_by_user.



37
38
39
 
# File 'lib/alfresco_api/models/node.rb', line 37

def created_by_user
  @created_by_user
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/alfresco_api/models/node.rb', line 18

def id
  @id
end

#is_file ⇒ Object

Returns the value of attribute is_file.



27
28
29
 
# File 'lib/alfresco_api/models/node.rb', line 27

def is_file
  @is_file
end

#is_folder ⇒ Object

Returns the value of attribute is_folder.



25
26
27
 
# File 'lib/alfresco_api/models/node.rb', line 25

def is_folder
  @is_folder
end

#is_link ⇒ Object

Returns the value of attribute is_link.



41
42
43
 
# File 'lib/alfresco_api/models/node.rb', line 41

def is_link
  @is_link
end

#is_locked ⇒ Object

Returns the value of attribute is_locked.



29
30
31
 
# File 'lib/alfresco_api/models/node.rb', line 29

def is_locked
  @is_locked
end

#modified_at ⇒ Object

Returns the value of attribute modified_at.



31
32
33
 
# File 'lib/alfresco_api/models/node.rb', line 31

def modified_at
  @modified_at
end

#modified_by_user ⇒ Object

Returns the value of attribute modified_by_user.



33
34
35
 
# File 'lib/alfresco_api/models/node.rb', line 33

def modified_by_user
  @modified_by_user
end

#name ⇒ Object

The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name.



21
22
23
 
# File 'lib/alfresco_api/models/node.rb', line 21

def name
  @name
end

#node_type ⇒ Object

Returns the value of attribute node_type.



23
24
25
 
# File 'lib/alfresco_api/models/node.rb', line 23

def node_type
  @node_type
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



39
40
41
 
# File 'lib/alfresco_api/models/node.rb', line 39

def parent_id
  @parent_id
end

#path ⇒ Object

Returns the value of attribute path.



51
52
53
 
# File 'lib/alfresco_api/models/node.rb', line 51

def path
  @path
end

#permissions ⇒ Object

Returns the value of attribute permissions.



53
54
55
 
# File 'lib/alfresco_api/models/node.rb', line 53

def permissions
  @permissions
end

#properties ⇒ Object

Returns the value of attribute properties.



47
48
49
 
# File 'lib/alfresco_api/models/node.rb', line 47

def properties
  @properties
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/alfresco_api/models/node.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'node_type' => :'nodeType',
    :'is_folder' => :'isFolder',
    :'is_file' => :'isFile',
    :'is_locked' => :'isLocked',
    :'modified_at' => :'modifiedAt',
    :'modified_by_user' => :'modifiedByUser',
    :'created_at' => :'createdAt',
    :'created_by_user' => :'createdByUser',
    :'parent_id' => :'parentId',
    :'is_link' => :'isLink',
    :'content' => :'content',
    :'aspect_names' => :'aspectNames',
    :'properties' => :'properties',
    :'allowable_operations' => :'allowableOperations',
    :'path' => :'path',
    :'permissions' => :'permissions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/alfresco_api/models/node.rb', line 81

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'node_type' => :'String',
    :'is_folder' => :'BOOLEAN',
    :'is_file' => :'BOOLEAN',
    :'is_locked' => :'BOOLEAN',
    :'modified_at' => :'DateTime',
    :'modified_by_user' => :'UserInfo',
    :'created_at' => :'DateTime',
    :'created_by_user' => :'UserInfo',
    :'parent_id' => :'String',
    :'is_link' => :'BOOLEAN',
    :'content' => :'ContentInfo',
    :'aspect_names' => :'Array<String>',
    :'properties' => :'Object',
    :'allowable_operations' => :'Array<String>',
    :'path' => :'PathInfo',
    :'permissions' => :'PermissionsInfo'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/alfresco_api/models/node.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      node_type == o.node_type &&
      is_folder == o.is_folder &&
      is_file == o.is_file &&
      is_locked == o.is_locked &&
      modified_at == o.modified_at &&
      modified_by_user == o.modified_by_user &&
      created_at == o.created_at &&
      created_by_user == o.created_by_user &&
      parent_id == o.parent_id &&
      is_link == o.is_link &&
      content == o.content &&
      aspect_names == o.aspect_names &&
      properties == o.properties &&
      allowable_operations == o.allowable_operations &&
      path == o.path &&
      permissions == o.permissions
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



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
363
364
365
366
 
# File 'lib/alfresco_api/models/node.rb', line 330

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 = AlfrescoAPI.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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/alfresco_api/models/node.rb', line 396

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/alfresco_api/models/node.rb', line 309

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


296
297
298
 
# File 'lib/alfresco_api/models/node.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



302
303
304
 
# File 'lib/alfresco_api/models/node.rb', line 302

def hash
  [id, name, node_type, is_folder, is_file, is_locked, modified_at, modified_by_user, created_at, created_by_user, parent_id, is_link, content, aspect_names, properties, allowable_operations, path, permissions].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



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
 
# File 'lib/alfresco_api/models/node.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

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

  if @name !~ Regexp.new(/^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/)
    invalid_properties.push("invalid value for 'name', must conform to the pattern /^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/.")
  end

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

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

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

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

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

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

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



376
377
378
 
# File 'lib/alfresco_api/models/node.rb', line 376

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



382
383
384
385
386
387
388
389
390
 
# File 'lib/alfresco_api/models/node.rb', line 382

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



370
371
372
 
# File 'lib/alfresco_api/models/node.rb', line 370

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/alfresco_api/models/node.rb', line 241

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @name !~ Regexp.new(/^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/)
  return false if @node_type.nil?
  return false if @is_folder.nil?
  return false if @is_file.nil?
  return false if @modified_at.nil?
  return false if @modified_by_user.nil?
  return false if @created_at.nil?
  return false if @created_by_user.nil?
  return true
end