Module: UU::OS::ArtifactSearch

Extended by:
ArtifactSearch
Included in:
ArtifactSearch
Defined in:
uu_os_client-0.10.6/lib/uu/os/artifact_search.rb,
uu_os_client-0.10.6/lib/uu/os/artifact_search/artifact_search_query.rb,
uu_os_client-0.10.6/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 aLocationUri, although it can be widened 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. </p>

are: name, code, metaArtifactCode and stateType : ArtifactStateType.

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 parameters

Returns:



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

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) if !dto.page_index.nil?
  svc.add_parameter('pageSize', dto.page_size) if !dto.page_size.nil?
  svc.add_parameter('recursive', dto.recursive) if !dto.recursive.nil?
  svc.add_parameter('includeSystemArea', dto.include_system_area) if !dto.include_system_area.nil?
  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