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.



40
41
42
 
# File 'lib/comet/models/group_policy.rb', line 40

def initialize
  clear
end

Instance Attribute Details

#created_date ⇒ Object

Unix timestamp in seconds. May be zero for Policies created prior to Comet 23.3.3.



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

def created_date
  @created_date
end

#default_user_policy ⇒ Object

DefaultUserPolicy marks that this UserPolicy should be applied to all new users. The Comet Server will ensure that only one policy can be set as default.



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

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

#modified_date ⇒ Object

Unix timestamp in seconds. May be zero for Policies created prior to Comet 23.3.3.



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

def modified_date
  @modified_date
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.



38
39
40
 
# File 'lib/comet/models/group_policy.rb', line 38

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'lib/comet/models/group_policy.rb', line 44

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/comet/models/group_policy.rb', line 61

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

      @created_date = v
    when 'ModifiedDate'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @modified_date = 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) 


54
55
56
57
58
 
# File 'lib/comet/models/group_policy.rb', line 54

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



109
110
111
 
# File 'lib/comet/models/group_policy.rb', line 109

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



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/comet/models/group_policy.rb', line 94

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



114
115
116
 
# File 'lib/comet/models/group_policy.rb', line 114

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