Package ch.tocco.nice2.netui.api.bind.entity

Interface InternalSearchService

All Known Implementing Classes:

InternalSearchServiceImpl

public interface InternalSearchService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InternalSearchService.OrderItem
static class	InternalSearchService.Paging

Method Summary

Modifier and Type	Method	Description
void	applyDefaultOrdering(Query qu, @Nullable InternalSearchService.OrderItem[] order, String entityName, @Nullable FormIdentifier formIdentifier)	Applies the given order if any (using applyOrderItems(Query, OrderItem[], String, FormIdentifier) , otherwise sorts by last mod if the entity supports it, otherwise by default entity sorting rule.
void	applyOrderItems(Query query, @Nullable InternalSearchService.OrderItem[] order, String entityName, @Nullable FormIdentifier formIdentifier)	For convenience, if order is null this method just returns.
Query	createSearchQuery(SearchRequest request)
String	createSearchQueryString(SearchRequest request)
EntityListResult	getEntityList(String entityName, String[] pks, @Nullable InternalSearchService.OrderItem[] order, SearchService.SearchParameters searchParameters)	Loads an EntityList based on a list of PKs.
RelationQuery	queryForRelation(String entityName, RelatedToInfo relatedTo, @Nullable InternalSearchService.OrderItem[] order)

Method Details

applyOrderItems

void applyOrderItems(Query query,
 @Nullable
 @Nullable InternalSearchService.OrderItem[] order,
 String entityName,
 @Nullable
 @Nullable FormIdentifier formIdentifier)
              throws PersistException

For convenience, if order is null this method just returns. If not, the order items are applied to the query.

Throws:

PersistException

createSearchQueryString

String createSearchQueryString(SearchRequest request)
                        throws RpcExecutionException,
PersistException

Throws:

RpcExecutionException

PersistException

createSearchQuery

Query createSearchQuery(SearchRequest request)
                 throws RpcExecutionException,
PersistException

Throws:

RpcExecutionException

PersistException

applyDefaultOrdering

void applyDefaultOrdering(Query qu,
 @Nullable
 @Nullable InternalSearchService.OrderItem[] order,
 String entityName,
 @Nullable
 @Nullable FormIdentifier formIdentifier)
                   throws PersistException

Applies the given order if any (using applyOrderItems(Query, OrderItem[], String, FormIdentifier) , otherwise sorts by last mod if the entity supports it, otherwise by default entity sorting rule.

Throws:

PersistException

getEntityList

EntityListResult getEntityList(String entityName,
 String[] pks,
 @Nullable
 @Nullable InternalSearchService.OrderItem[] order,
 SearchService.SearchParameters searchParameters)

Loads an EntityList based on a list of PKs.

Parameters:

pks - May be empty.

Returns:

The entities are ordered the same way as the pks.

queryForRelation

RelationQuery queryForRelation(String entityName,
 RelatedToInfo relatedTo,
 @Nullable
 @Nullable InternalSearchService.OrderItem[] order)
                        throws PersistException

Throws:

PersistException