com.adobe.cq.social.ugc.api

Interface UgcSearch

public interface UgcSearch

Interface for UGC search.

Method Summary

Modifier and Type	Method and Description
SearchResults<Resource>	find(java.lang.String scName, ResourceResolver resolver, UgcFilter filter, int offset, int limit, boolean requiresTotal) Perform a search with a component filter returning resources.
SearchResults<Resource>	find(java.lang.String scName, ResourceResolver resolver, UgcFilter filter, int offset, int limit, boolean requiresTotal, java.lang.String fieldLanguage) Perform a search with a component filter returning resources.
SearchResults<Node>	find(java.lang.String scName, Session session, UgcFilter filter, int offset, int limit) Deprecated. use find(String, ResourceResolver, UgcFilter, int, int, boolean)
int	getIndex(java.lang.String scName, Session session, UgcFilter listing, java.lang.String targetPath, long added) Return the index of the target in the search result.

Method Detail

find

@Deprecated
SearchResults<Node> find(java.lang.String scName,
                                     Session session,
                                     UgcFilter filter,
                                     int offset,
                                     int limit)
                              throws RepositoryException

Deprecated. use find(String, ResourceResolver, UgcFilter, int, int, boolean)

Perform a basic search.

Parameters:

scName - the name of the search collection.

session - the user session.

filter - the query filters.

offset - the result offset.

limit - the result limit.

Returns:

the search results as Nodes.

Throws:

RepositoryException - thrown when there are issues with repository.

find

SearchResults<Resource> find(java.lang.String scName,
                             ResourceResolver resolver,
                             UgcFilter filter,
                             int offset,
                             int limit,
                             boolean requiresTotal)
                      throws RepositoryException

Perform a search with a component filter returning resources. Caution: When doing a search for resources managed by a SRP, you cannot use a parent/descendant constraint that is outside the SRP. This behavior will change in subsequent releases.

Parameters:

scName - the name of the search collection.

resolver - the user session.

filter - the query filters.

offset - the result offset.

limit - the result limit.

requiresTotal - true iff the total number of matches needs to be returned in the search results

Returns:

the search results.

Throws:

RepositoryException - thrown when there are issues with repository.

find

SearchResults<Resource> find(java.lang.String scName,
                             ResourceResolver resolver,
                             UgcFilter filter,
                             int offset,
                             int limit,
                             boolean requiresTotal,
                             java.lang.String fieldLanguage)
                      throws RepositoryException

Perform a search with a component filter returning resources. Caution: When doing a search for resources managed by a SRP, you cannot use a parent/descendant constraint that is outside the SRP. This behavior will change in subsequent releases.

Parameters:

scName - the name of the search collection.

resolver - the user session.

filter - the query filters.

offset - the result offset.

limit - the result limit.

requiresTotal - true iff the total number of matches needs to be returned in the search results

fieldLanguage - search will be queried against verbatim_fieldLanguage. This can be changed in the SOLR request handler.

Returns:

the search results.

Throws:

RepositoryException - thrown when there are issues with repository.

getIndex

int getIndex(java.lang.String scName,
             Session session,
             UgcFilter listing,
             java.lang.String targetPath,
             long added)
      throws RepositoryException

Return the index of the target in the search result.

Parameters:

scName - the name of the search collection.

session - the user session.

listing - the query filters.

targetPath - the path of the target.

added - the date that the target was added.

Returns:

the index of the target in the search result.

Throws:

RepositoryException - thrown when there are issues with repository.