Package com.adobe.forms.foundation.service.handlers

Class FormsAbstractSavedSearchHandler

java.lang.Object

com.adobe.forms.foundation.service.handlers.FormsAbstractSavedSearchHandler

All Implemented Interfaces:

SavedSearchHandler

public abstract class FormsAbstractSavedSearchHandler
extends java.lang.Object
implements SavedSearchHandler

Abstract saved search handler for forms consoles.

Constructor Summary

Constructors

Constructor	Description
FormsAbstractSavedSearchHandler()

Method Summary

Modifier and Type	Method	Description
Resource	createOrUpdateSavedSearch(ResourceResolver resourceResolver, java.util.Map<java.lang.String,java.lang.String> requestParameters)	This function creates a new saved search or updates a existing saved search based on the parameters provided in predicateMap parameter.
boolean	deleteSavedSearch(ResourceResolver resourceResolver, java.lang.String path)	This function delete the saved search node existing on the provided path
abstract QueryBuilder	getQueryBuilder()
java.util.Iterator<Resource>	getSavedSearches(ResourceResolver resourceResolver, long limit, long offset)	This function returns list of all saved search for the module i.e.
java.util.Map<java.lang.String,java.lang.String>	getSavedSearchParameters(ResourceResolver resourceResolver, java.lang.String path)	This function provide the detail of saved query from the saved search node of the provided path

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.granite.omnisearch.spi.core.SavedSearchHandler

getID

Constructor Detail

FormsAbstractSavedSearchHandler

public FormsAbstractSavedSearchHandler()

Method Detail

deleteSavedSearch

public boolean deleteSavedSearch(ResourceResolver resourceResolver,
                                 java.lang.String path)

Description copied from interface: SavedSearchHandler

This function delete the saved search node existing on the provided path

Specified by:

deleteSavedSearch in interface SavedSearchHandler

Parameters:

resourceResolver - ResourceResolver instance

path - path of saved search node that needed to be deleted.

Returns:

true if node deleted successfully , false otherwise

getSavedSearches

public java.util.Iterator<Resource> getSavedSearches(ResourceResolver resourceResolver,
                                                     long limit,
                                                     long offset)

Description copied from interface: SavedSearchHandler

This function returns list of all saved search for the module i.e. sites, Asset with specified limit and offset.

Specified by:

getSavedSearches in interface SavedSearchHandler

Parameters:

resourceResolver - ResourceResolver instance

limit - number of result on a page

offset - offset/start of result

Returns:

Iterator of Resource of nodes of saved search for the module.

getSavedSearchParameters

public java.util.Map<java.lang.String,java.lang.String> getSavedSearchParameters(ResourceResolver resourceResolver,
                                                                                       java.lang.String path)

Description copied from interface: SavedSearchHandler

This function provide the detail of saved query from the saved search node of the provided path

Specified by:

getSavedSearchParameters in interface SavedSearchHandler

Parameters:

resourceResolver - ResourceResolver instance

path - path of the node of saved search, from which parameters of saved search Query required

Returns:

Map containing parameters of the Query

createOrUpdateSavedSearch

public Resource createOrUpdateSavedSearch(ResourceResolver resourceResolver,
                                          java.util.Map<java.lang.String,java.lang.String> requestParameters)
                                   throws OmniSearchException

Description copied from interface: SavedSearchHandler

This function creates a new saved search or updates a existing saved search based on the parameters provided in predicateMap parameter.

Specified by:

createOrUpdateSavedSearch in interface SavedSearchHandler

Parameters:

resourceResolver - ResourceResolver instance

requestParameters - Map of type <String, String> containing all the parameters that needed to be saved in query parameters of saved search node.

Returns:

Resource that is created or updated for saved search

Throws:

OmniSearchException - instance of OmniSearchException which provide error from the module

getQueryBuilder

public abstract QueryBuilder getQueryBuilder()