Class: UU::OS::PersonalAccessRole::PersonalAccessRoleSetAttributes

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from 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 personal access role. When nil is set, the code is not modified. When blank string is set, the code is generated automatically using the system sequence. The code must be unique in a given territory, otherwise the setAttributes command fails.



22
23
24
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 22

def code
  @code
end

- (Object) description

The new description of the personal access role. When nil is set, the description is not modified.



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

def description
  @description
end

- (Object) first_name

The new first name of the personal access role. When nil is set, the first name is not modified.



13
14
15
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 13

def first_name
  @first_name
end

- (Object) grant_all_from_organizational_unit

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



53
54
55
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 53

def grant_all_from_organizational_unit
  @grant_all_from_organizational_unit
end

- (Object) icon_uri

UESURI of the personal access role's icon. When nil is set, the personal access role is not modified. When nil_URI value is set, the role icon is removed and the role uses icon from meta artifact.

Examples:

Allowed format URI of icon:

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

For example:

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


49
50
51
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 49

def icon_uri
  @icon_uri
end

- (Object) searchable_in_territory

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



39
40
41
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 39

def searchable_in_territory
  @searchable_in_territory
end

- (Object) security_clearance

Security clearance of the new personal access role. When nil is set, the security clearance is not modified.



35
36
37
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 35

def security_clearance
  @security_clearance
end

- (Object) security_level

Security level of the new personal access role. When nil is set, security level is taken from the meta artifact SecurityLevel. If the meta artifact SecurityLevel is higher than the user's security clearance, the create command fails.



31
32
33
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 31

def security_level
  @security_level
end

- (Object) surname

The new surname of the personal access role. When nil is set, the surname is not modified.



16
17
18
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_set_attributes.rb', line 16

def surname
  @surname
end