Module: UU::OS::ArtifactSearch

Extended by:
ArtifactSearch
Included in:
ArtifactSearch
Defined in:
uu_os-0.29.16/lib/uu/os/artifact_search.rb,
uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_query.rb,
uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_result_item.rb

Defined Under Namespace

Classes: ArtifactSearchQuery, ArtifactSearchResultItem

Constant Summary

PATH =

Service path

'ues/core/artifact/UESArtifactSearch'

Instance Method Summary (collapse)

Instance Method Details

- (UU::OS::REST::ResultList<ArtifactSearch::ArtifactSearchQuery, ArtifactSearch::ArtifactSearchResultItem>) query(location_uri, search_query = nil)

Performs a search for artifacts with specified criteria. The search is performed in the location according to the location_uri, although it can be widened by using include_system_area or include_preferred_area flag in the search query.

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

**Recommended usage**

  • if location_uri is an organizational unit, use deepest organizational unit in the structure, so that the result set is restricted as much as possible. If the OU (its nesting level) is near the top of the territory, it might be better for performance to use the territory instead (if possible) - try measuring times in your case and decide based on that.

are: name, code, uri, organizationalUnitName (cannot use fulltext operator), organizationalUnitUri, metaArtifactUri, metaArtifactCode, stateType: ArtifactStateType and entityTypeUri.

See UESQuery Documentation.

Parameters:

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

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

  • search_query (ArtifactSearchQuery) (defaults to: nil) —

    DTO containing search criteria. Available query parameters

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'uu_os-0.29.16/lib/uu/os/artifact_search.rb', line 42

def query(location_uri, search_query = nil)
  svc = UU::OS::REST::RemoteClient.new(ArtifactSearch)
  dto = UU::OS::ArtifactSearch::ArtifactSearchQuery.new(search_query)
  svc.add_parameter('query', dto.query)
  svc.add_parameter('pageIndex', dto.page_index)
  svc.add_parameter('pageSize', dto.page_size)
  svc.add_parameter('recursive', dto.recursive)
  svc.add_parameter('includeSystemArea', dto.include_system_area)
  svc.add_parameter('includePreferredArea', dto.include_preferred_area)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('query', location_uri)
    return UU::OS::REST::ResultList.new(ArtifactSearch::ArtifactSearchQuery, ArtifactSearch::ArtifactSearchResultItem, res)
  end
end