cz.ues.core.artifact

Interface UESArtifactSearch

@UESService
public interface UESArtifactSearch

UES Artifact Search is a service that provides search operations over artifacts.

Method Summary

Methods

Modifier and Type	Method and Description
UESResultList<UESArtifactSearchResultItem,UESArtifactSearchQuery>	query(UESURI aLocationUri, UESArtifactSearchQuery aSearchQuery) Performs a search for artifacts with specified criteria.

Method Detail

query

UESResultList<UESArtifactSearchResultItem,UESArtifactSearchQuery> query(UESURI aLocationUri,
UESArtifactSearchQuery aSearchQuery)
throws UESArtifactSearchRTException

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.

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

Parameters:

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

aSearchQuery - DTO containing search criteria. Available query parameters are: name, code, uri, organizationalUnitName (cannot use fulltext operator), organizationalUnitUri, metaArtifactUri, metaArtifactCode and stateType: UESArtifactStateType.

Returns:

The list of found artifacts.

Throws:

UESArtifactSearchRTException - Thrown when search settings are invalid or when searching fails for other reason.

Since:

UES6-06

See Also:

UESQuery Documentation