Class: UU::OS::PersonalAccessRole::PersonalAccessRoleCreate

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.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

Code of the new personal access role. When nil is set, the code is generated automatically using the system sequence. The code must be unique in the given territory, otherwise the create command fails.



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

def code
  @code
end

- (Object) competent_role_uri

UESURI of the competent role. When nil is set, the executive role from authorization is used. If no role is authorized to create the personal access role into specified container, the create command fails. If the selected role doesn't have connected the access role interface with the selected meta artifact, the create command fails. If the selected role doesn't belong to the same organizational unit as anew role or if it doesn't belong to one of superior organizational units, the create command fails.



42
43
44
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 42

def competent_role_uri
  @competent_role_uri
end

- (Object) description

Description of the new personal access role. When nil is set, description from meta artifact is used if set, otherwise no description is set on the new personal access role.



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

def description
  @description
end

- (Object) first_name

First name of the new personal access role. When nil is set, the create command fails.



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

def first_name
  @first_name
end

- (Object) force

If set to true, new Personal Access Role will be created even if Personal Access Role in final state for the same user exists in the given Territory.



74
75
76
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 74

def force
  @force
end

- (Object) grant_all_from_organizational_unit

Specifies if the personal access role will be included among All roles from organizational unit. When true or nil is set, the personal access role will be included, otherwise it will not be included among All roles from organizational unit.



70
71
72
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 70

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 uses icon from meta artifact.

Examples:

Allowed format UESURI 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}


65
66
67
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 65

def icon_uri
  @icon_uri
end

- (Object) meta_artifact_uri

UESURI of the meta artifact. Only a meta artifact with the template class of an Access role (not its descendants) can be used. If the rights does not permit to create a new personal access role from the meta artifact in the specified location, the create command fails.



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

def meta_artifact_uri
  @meta_artifact_uri
end

- (Object) searchable_in_territory

Specifies if it is possible to search the new personal access role in its territory. When nil is set, SearchableInTerritory from meta artifact is used if set, otherwise the create command fails.



56
57
58
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 56

def searchable_in_territory
  @searchable_in_territory
end

- (Object) security_clearance

Security clearance of the new personal access role. When nil is set, the value NO_CONFIDENTIALITY is used.



51
52
53
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 51

def security_clearance
  @security_clearance
end

- (Object) security_level

Security level. When nil is set, security level is taken from the meta artifact default security level. If the meta artifact template security level is higher than the user's security clearance, the create command fails.



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

def security_level
  @security_level
end

- (Object) surname

Surname of the new personal access role. When nil is set, the create command fails.



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

def surname
  @surname
end

- (Object) universe_id

Universe identifier of the user. When nil is set, the create command fails.



19
20
21
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_access_role/personal_access_role_create.rb', line 19

def universe_id
  @universe_id
end