Module: UU::OS::PersonalRole

Extended by:
PersonalRole
Included in:
PersonalRole
Defined in:
uu_os_client-0.10.6/lib/uu/os/personal_role.rb,
uu_os_client-0.10.6/lib/uu/os/personal_role/territory_type.rb,
uu_os_client-0.10.6/lib/uu/os/personal_role/profile_attributes.rb,
uu_os_client-0.10.6/lib/uu/os/personal_role/territory_attributes.rb,
uu_os_client-0.10.6/lib/uu/os/personal_role/personal_role_get_territory_list.rb,
uu_os_client-0.10.6/lib/uu/os/personal_role/personal_role_artifact_presentation_attributes.rb,
uu_os_client-0.10.6/lib/uu/os/personal_role/personal_role_set_artifact_presentation_attributes.rb

Overview

Personal Role service.

Defined Under Namespace

Classes: PersonalRoleArtifactPresentationAttributes, PersonalRoleGetTerritoryList, PersonalRoleSetArtifactPresentationAttributes, ProfileAttributes, TerritoryAttributes, TerritoryType

Constant Summary

PATH =

Service path

'ues/core/personalrole/UESPersonalRole'

Instance Method Summary (collapse)

Instance Method Details

- (PersonalRoleSetArtifactPresentationAttributes) get_artifact_presentation_attributes(personal_role_uri)

Returns DTO containing user settings of artifact presentation

Examples:

# Get user presentation attributes of an artifact
UU::OS::PersonalRole.get_artifact_presentation_attributes('ues:PERSONAL_TERRITORY:PERSONAL_ROLE')

Parameters:

  • personal_role_uri (String, UU::OS::UESURI) —

    UESURI of the personal role whose profile attributes are to be retrieved.

Returns:



97
98
99
100
101
102
103
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_role.rb', line 97

def get_artifact_presentation_attributes(personal_role_uri)
  svc = UU::OS::REST::RemoteClient.new(PersonalRole)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('getArtifactPresentationAttributes', personal_role_uri)
    return PersonalRole::PersonalRoleArtifactPresentationAttributes.new(res)
  end
end

- (PersonalRole::ProfileAttributes) get_profile_attributes(personal_role_uri)

Returns profile information of the user.

Parameters:

  • personal_role_uri (String, UU::OS::UESURI) —

    UESURI of the personal role whose profile attributes are returned.

Returns:



47
48
49
50
51
52
53
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_role.rb', line 47

def get_profile_attributes(personal_role_uri)
  svc = UU::OS::REST::RemoteClient.new(PersonalRole)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('getProfileAttributes', personal_role_uri)
    return PersonalRole::ProfileAttributes.new(res)
  end
end

- (UU::OS::REST::ResultList<PersonalRole::PersonalRoleGetTerritoryList, PersonalRole::TerritoryAttributes>) get_territory_list(personal_role_uri, criteria = nil)

Returns a list of territories the personal role has access to. The command does not return all territories, only a sublist. The list of returned territories can be filtered by the name, code or type of an territory. The list is sorted by names (and codes in case two names are equal) by default, or it can be sorted arbitrarily.

Parameters:

Returns:



30
31
32
33
34
35
36
37
38
39
40
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_role.rb', line 30

def get_territory_list(personal_role_uri, criteria = nil)
  svc = UU::OS::REST::RemoteClient.new(PersonalRole)
  dto = UU::OS::PersonalRole::PersonalRoleGetTerritoryList.new(criteria)
  svc.add_parameter('pageIndex', dto.page_index) 
  svc.add_parameter('pageSize', dto.page_size)
  svc.add_parameter('query', dto.query)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('getTerritoryList', personal_role_uri)
    return UU::OS::REST::ResultList.new(PersonalRole::PersonalRoleGetTerritoryList, PersonalRole::TerritoryAttributes, res)
  end
end

- (UU::OS::UESURI) set_artifact_presentation_attributes(personal_role_uri, presentation_attributes = nil)

Configures user settings of artifact presentation. User will see artifacts according to this configuration. Presentation of artifact can be affected by these attributes: artifact width, header mode (two lines, one line, none), control bar visibility, artifact header sticking, context menu mode (advanced, simple). When viewing an artifact, presentation settings are looked up in the following order: User settings, artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise. #

Examples:

# Set user presentation attributes of an artifact
UU::OS::PersonalRole.set_artifact_presentation_attributes('ues:PERSONAL_TERRITORY:PERSONAL_ROLE',
:artifact_width => UU::OS::Artifact::ArtifactWidthType::DEFAULT,
:header_display_mode => UU::OS::Artifact::ArtifactHeaderDisplayMode::HIDDEN,
:pin_artifact_header => true,
:context_menu_display_mode => UU::OS::Artifact::ArtifactContextMenuDisplayMode::ADVANCED)

Parameters:

Returns:



73
74
75
76
77
78
79
80
81
 
# File 'uu_os_client-0.10.6/lib/uu/os/personal_role.rb', line 73

def set_artifact_presentation_attributes(personal_role_uri, presentation_attributes = nil)
  svc = UU::OS::REST::RemoteClient.new(PersonalRole)
  payload = UU::OS::PersonalRole::PersonalRoleSetArtifactPresentationAttributes.new(presentation_attributes).to_json

  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.post('setArtifactPresentationAttributes', personal_role_uri, payload)
    return UU::OS::UESURI.new(res)
  end
end