Class: UU::OS::Role::RoleAttributes

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

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

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) artifact_type

Artifact type. Always returns UESArtifactType#ORGANIZATIONAL.



41
42
43
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 41

def artifact_type
  @artifact_type
end

- (Object) code

Code of the role. Never nil.



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

def code
  @code
end

- (Object) company_uri

URI of the company where the role is located.



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

def company_uri
  @company_uri
end

- (Object) competent_role_uri

UESURI of the competent role. Returns roleUri (command main entity) if the role is the root role of a territory.



38
39
40
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 38

def competent_role_uri
  @competent_role_uri
end

- (Object) creation_stamp

Creation stamp of the role.



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

def creation_stamp
  @creation_stamp
end

- (Object) creation_time

Creation time of the role.



50
51
52
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 50

def creation_time
  @creation_time
end

- (Object) description

Description of the role. Never nil.



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

def description
  @description
end

- (Object) entity_type_uri

UESURI of the entity type of the role. Never nil.



92
93
94
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 92

def entity_type_uri
  @entity_type_uri
end

- (Object) grant_all_from_organizational_unit

Specifies if the role is be included among All roles from organizational unit. Never nil.



89
90
91
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 89

def grant_all_from_organizational_unit
  @grant_all_from_organizational_unit
end

- (Object) icon_uri

URI of the role's icon. When nil is set, 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}



For example:

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


85
86
87
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 85

def icon_uri
  @icon_uri
end

- (Object) location_uri

UESURI of the role's container.



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

def location_uri
  @location_uri
end

- (Object) meta_artifact_uri

UESURI of the meta artifact. Never nil.



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

def meta_artifact_uri
  @meta_artifact_uri
end

- (Object) modification_stamp

Modification stamp of the role.



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

def modification_stamp
  @modification_stamp
end

- (Object) modification_time

Modification time of the role.



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

def modification_time
  @modification_time
end

- (Object) name

Name of the role. Never nil.



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

def name
  @name
end

- (Object) organizational_unit_uri

UESURI of the organizational unit in which the role lies.



28
29
30
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 28

def organizational_unit_uri
  @organizational_unit_uri
end

- (Object) original_name

Name of the specified role without the name of primary casted access role.



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

def original_name
  @original_name
end

- (Object) searchable_across_territories

Deprecated.


67
68
69
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 67

def searchable_across_territories
  @searchable_across_territories
end

- (Object) searchable_in_territory

Specifies if it is possible to search the role in its territory.



62
63
64
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 62

def searchable_in_territory
  @searchable_in_territory
end

- (Object) security_level

Security level of the role. Never nil.



44
45
46
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 44

def security_level
  @security_level
end

- (Object) territory_switch_visible

Deprecated.


78
79
80
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 78

def territory_switch_visible
  @territory_switch_visible
end

- (Object) uri

Normalized UESURI of the role. Never nil.



10
11
12
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 10

def uri
  @uri
end

- (Object) version

Version of the role.



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

def version
  @version
end

Instance Method Details

- (Object) revision

Deprecated.

Use #version instead.



246
247
248
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 246

def revision
  attributes[:version]
end

- (Object) revision=(val)

Deprecated.

Use #version= instead.



251
252
253
# File 'uu_os_client-0.10.6/lib/uu/os/role/role_attributes.rb', line 251

def revision=(val)
  attributes[:version] = val
end