com.day.cq.searchpromote

Interface SearchPromoteService

public interface SearchPromoteService

Method Summary

Modifier and Type	Method and Description
String	callRemoteIndex(String accountNumber, String remotePassword, boolean fullIndex) Calls the remote indexer
String	getBannerAreaList(String memberid, String accountnumber) Returns a JSON string representation of available BannerAreas.
String	getFacetList(String memberid, String accountnumber) Returns a JSON string representation of available Facets.
String	getSearchForm(String memberid, String accountnumber) Returns an XML string representation for search form from the stage environment of Search&Promote.
String	getSearchForm(String memberId, String accountNumber, SearchPromoteEnvironment environment) Returns an XML string representation for search form.
URI	getServerURI() Returns configured Search&Promote server where configurations are fetched from.

Method Detail

getServerURI

URI getServerURI()

Returns configured Search&Promote server where configurations are fetched from.

Returns:

URI for Search&Promote server

getSearchForm

String getSearchForm(String memberid,
                     String accountnumber)
              throws SearchPromoteException

Returns an XML string representation for search form from the stage environment of Search&Promote.

Parameters:

memberid - Member ID

accountnumber - Account number

Returns:

String representation of the search form XML

Throws:

SearchPromoteException - SearchPromoteException if XML could not be fetched or response is invalid.

getSearchForm

String getSearchForm(String memberId,
                     String accountNumber,
                     SearchPromoteEnvironment environment)
              throws SearchPromoteException

Returns an XML string representation for search form. The search form is retrieved from the specified environment

Parameters:

memberId - Member ID

accountNumber - Account number

environment - The Search&Promote environment (stage / live)

Returns:

String representation of the search form XML

Throws:

SearchPromoteException - SearchPromoteException

getFacetList

String getFacetList(String memberid,
                    String accountnumber)
             throws SearchPromoteException

Returns a JSON string representation of available Facets.

Parameters:

memberid - Member ID

accountnumber - Account number

Returns:

JSON string representation of the available Facets

Throws:

SearchPromoteException - SearchPromoteException if JSON could not be feteched or response is invalid.

getBannerAreaList

String getBannerAreaList(String memberid,
                         String accountnumber)
                  throws SearchPromoteException

Returns a JSON string representation of available BannerAreas.

Parameters:

memberid - Member ID

accountnumber - Account number

Returns:

JSON string representation of the available BannerAreas

Throws:

SearchPromoteException - SearchPromoteException if JSON could not be feteched or response is invalid.

callRemoteIndex

String callRemoteIndex(String accountNumber,
                       String remotePassword,
                       boolean fullIndex)
                throws SearchPromoteException

Calls the remote indexer

Parameters:

accountNumber - Account number

remotePassword - The remote indexer password

fullIndex - signals that a full feed index is requested

Returns:

a String representing the request's outcome. Possible values are OK if the request was sent successfully, Error otherwise.

Throws:

SearchPromoteException - SearchPromoteException