Class: Comet::VSSComponent

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/vsscomponent.rb

Overview

VSSComponent is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ VSSComponent

Returns a new instance of VSSComponent.



31
32
33
 
# File 'lib/comet/models/vsscomponent.rb', line 31

def initialize
  clear
end

Instance Attribute Details

#ctype ⇒ Object

“VSS_CT_DATABASE” or “VSS_CT_FILEGROUP”



23
24
25
 
# File 'lib/comet/models/vsscomponent.rb', line 23

def ctype
  @ctype
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/comet/models/vsscomponent.rb', line 19

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path.



16
17
18
 
# File 'lib/comet/models/vsscomponent.rb', line 16

def path
  @path
end

#selectable ⇒ Object

Returns the value of attribute selectable.



26
27
28
 
# File 'lib/comet/models/vsscomponent.rb', line 26

def selectable
  @selectable
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



29
30
31
 
# File 'lib/comet/models/vsscomponent.rb', line 29

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/comet/models/vsscomponent.rb', line 35

def clear
  @path = ''
  @name = ''
  @ctype = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/comet/models/vsscomponent.rb', line 50

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'Path'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @path = v
    when 'Name'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @name = v
    when 'CType'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @ctype = v
    when 'Selectable'
      @selectable = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


43
44
45
46
47
 
# File 'lib/comet/models/vsscomponent.rb', line 43

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



89
90
91
 
# File 'lib/comet/models/vsscomponent.rb', line 89

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/comet/models/vsscomponent.rb', line 76

def to_hash
  ret = {}
  ret['Path'] = @path
  ret['Name'] = @name
  ret['CType'] = @ctype
  ret['Selectable'] = @selectable
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



94
95
96
 
# File 'lib/comet/models/vsscomponent.rb', line 94

def to_json(options = {})
  to_hash.to_json(options)
end