Class: UU::OS::ArtifactSearch::ArtifactSearchQuery

Inherits:
REST::PagingCriteria show all
Defined in:
uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_query.rb

Instance Attribute Summary (collapse)

Attributes inherited from REST::PagingCriteria

#page_index, #page_size

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) include_preferred_area

Whether to include preferred territory in the search. Default is false.



27
28
29
 
# File 'uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_query.rb', line 27

def include_preferred_area
  @include_preferred_area
end

- (Object) include_system_area

Whether to include system area (system territory) in the search. Default is false.



24
25
26
 
# File 'uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_query.rb', line 24

def include_system_area
  @include_system_area
end

- (Object) query

The UES query string. It has to conform to the ues query syntax (see documentation for more info). Filtering and order of the result list can be specified there. When null is set, no filtering is applied and entries are ordered by name of referenced artifact (and code and type as the second and the third criteria).



12
13
14
 
# File 'uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_query.rb', line 12

def query
  @query
end

- (Object) recursive

Whether to search recursively (including subordinate organizational units), the root of the search being the main entity of the command. Default is true.

There's one special case - if this flag is set to false and the query contains restriction on organizationalUnitUri attribute then the recursive applies to that organizatinalUnitUri. That means that the searched entity must be located anywhere in main entity (deep) and somewhere in specified organizationalUnitUri (shallow).



21
22
23
 
# File 'uu_os-0.29.16/lib/uu/os/artifact_search/artifact_search_query.rb', line 21

def recursive
  @recursive
end