cz.ues.core.role

Interface UESRoleSearch

@UESService
public interface UESRoleSearch

UES Role Search is a service that provides search operations over roles.

See Also:

UESRoleSearch.query(UESURI, UESRoleSearchQuery)

Method Summary

Methods

Modifier and Type	Method and Description
UESResultList<UESRoleSearchResultItem,UESRoleSearchQuery>	query(UESURI aLocationUri, UESRoleSearchQuery aSearchQuery) Performs a search for roles with specified criteria.

Method Detail

query

UESResultList<UESRoleSearchResultItem,UESRoleSearchQuery> query(UESURI aLocationUri,
UESRoleSearchQuery aSearchQuery)
throws UESRoleSearchRTException

Performs a search for roles 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 parameters are: name, code and stateType : UESArtifactStateType.

Returns:

The list of found roles.

Throws:

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

Since:

UES6-06

See Also:

UESQuery Documentation