Class: UU::OS::Friend::FriendSetAttributes

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/friend/friend_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 friend. When null is set, the code is not modified. The code must be unique in a given territory, otherwise the setAttributes command fails.



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

def code
  @code
end

- (Object) description

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



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

def description
  @description
end

- (Object) first_name

The new first name of the friend. When null is set, the first name is not modified.



12
13
14
 
# File 'uu_os_client-0.10.6/lib/uu/os/friend/friend_set_attributes.rb', line 12

def first_name
  @first_name
end

- (Object) icon_uri

URI of the friend's icon. When null is set, the friend is not modified. If 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}


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

def icon_uri
  @icon_uri
end

- (Object) security_level

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



27
28
29
 
# File 'uu_os_client-0.10.6/lib/uu/os/friend/friend_set_attributes.rb', line 27

def security_level
  @security_level
end

- (Object) surname

The new surname of the friend. When null is set, the surname is not modified.



15
16
17
 
# File 'uu_os_client-0.10.6/lib/uu/os/friend/friend_set_attributes.rb', line 15

def surname
  @surname
end