Class: Comet::GroupPolicy

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GroupPolicy

Returns a new instance of GroupPolicy.



30
31
32
 
# File 'lib/comet/models/group_policy.rb', line 30

def initialize
  clear
end

Instance Attribute Details

#default_user_policy ⇒ Object

Returns the value of attribute default_user_policy.



25
26
27
 
# File 'lib/comet/models/group_policy.rb', line 25

def default_user_policy
  @default_user_policy
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



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

def organization_id
  @organization_id
end

#policy ⇒ Object

Returns the value of attribute policy.



22
23
24
 
# File 'lib/comet/models/group_policy.rb', line 22

def policy
  @policy
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



28
29
30
 
# File 'lib/comet/models/group_policy.rb', line 28

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @description = ''
  @organization_id = ''
  @policy = Comet::UserPolicy.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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

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 'Description'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

      @organization_id = v
    when 'Policy'
      @policy = Comet::UserPolicy.new
      @policy.from_hash(v)
    when 'DefaultUserPolicy'
      @default_user_policy = 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) 


42
43
44
45
46
 
# File 'lib/comet/models/group_policy.rb', line 42

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



87
88
89
 
# File 'lib/comet/models/group_policy.rb', line 87

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



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/comet/models/group_policy.rb', line 74

def to_hash
  ret = {}
  ret['Description'] = @description
  ret['OrganizationID'] = @organization_id
  ret['Policy'] = @policy
  ret['DefaultUserPolicy'] = @default_user_policy
  @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



92
93
94
 
# File 'lib/comet/models/group_policy.rb', line 92

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