Class: UU::OS::Role::RoleSetAttributes

Inherits:
UU::OS::REST::DTO show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from UU::OS::REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (Object) code

The new code of the role. When null is set, the code is not modified.The code must be unique in a given territory, otherwise thesetAttributes command fails.



18
19
20
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 18

def code
  @code
end

- (Object) description

The new description of the role. When null is set, the description is not modified.



21
22
23
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 21

def description
  @description
end

- (Object) grant_all_from_organizational_unit

Specifies if the role will be included among All roles from organizational unit. When null is set, this attribute on the role is not modified.



59
60
61
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 59

def grant_all_from_organizational_unit
  @grant_all_from_organizational_unit
end

- (Object) icon_uri

URI of the role's icon. When null is set, the icon is not modified.When NULL_URI value is set, the role icon is removed and the role uses icon from meta artifact.
Allowed format URI of icon:

ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{CODE_OF_ICON}<br>


For example:

ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{ART_077}


55
56
57
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 55

def icon_uri
  @icon_uri
end

- (Object) name

The new name of the role. When null is set, the name is not modified.
Note that the role name is automatically extended by the name of casted access roles names, when this attribute is not null. Therefore the name attribute returned by the getAttributescommand contains different string.



14
15
16
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 14

def name
  @name
end

- (Object) searchable_across_territories

Deprecated. 


36
37
38
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 36

def searchable_across_territories
  @searchable_across_territories
end

- (Object) searchable_in_territory

Specifies if it is possible to search the role in its territory. When null is set, this attribute on the role is not modified.



30
31
32
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 30

def searchable_in_territory
  @searchable_in_territory
end

- (Object) security_level

The new security level of the role. When null is set, the security level is not modified. If the meta artifact tSecurityLevel is higher than the user's security clearance, the setAttributescommand fails.



26
27
28
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 26

def security_level
  @security_level
end

- (Object) territory_switch_visible

Deprecated. 


47
48
49
 
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_set_attributes.rb', line 47

def territory_switch_visible
  @territory_switch_visible
end