Module: UU::OS::RoleSearch

Extended by:
RoleSearch
Included in:
RoleSearch
Defined in:
uu_os_client-0.10.6/lib/uu/os/role_search.rb,
uu_os_client-0.10.6/lib/uu/os/role_search/role_search_query.rb,
uu_os_client-0.10.6/lib/uu/os/role_search/role_search_result_item.rb

Defined Under Namespace

Classes: RoleSearchQuery, RoleSearchResultItem

Constant Summary

PATH =

Service path

'ues/core/role/UESRoleSearch'

Instance Method Summary (collapse)

Instance Method Details

- (UU::OS::REST::ResultList<RoleSearch::RoleSearchQuery, RoleSearch::RoleSearchResultItem>) query(location_uri, criteria)

Performs a search for roles with specified criteria. The search is performedin the location according to the aLocationUri, although it can bewidened by using includeSystemArea flag in the search criteria.<p>

Search criteria contains several search settings - query(what to search, and order settings) and paging settings.

name, code and stateType : ArtifactStateType.

See UESQuery Documentation.

Parameters:

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

    The location to search in. Can be a territory oran organizational unit.

  • criteria (RoleSearchQuery) —

    DTO containing searchcriteria. Available parameters are:

Returns:



33
34
35
36
37
38
39
40
41
42
43
 
# File 'uu_os_client-0.10.6/lib/uu/os/role_search.rb', line 33

def query(location_uri, criteria)
  svc = UU::OS::REST::RemoteClient.new(RoleSearch)
  dto = RoleSearch::RoleSearchQuery.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('query', location_uri)
    return UU::OS::REST::ResultList.new(RoleSearch::RoleSearchQuery, RoleSearch::RoleSearchResultItem, res)
  end
end