com.endeca.mobile.services.query.impl
Class UICLMobileQueryService

java.lang.Object
  com.endeca.b2creference.services.query.impl.UICLContentQueryService
      com.endeca.mobile.services.query.impl.UICLMobileQueryService

All Implemented Interfaces:

ContentQueryService

public class UICLMobileQueryService
extends UICLContentQueryService

Creates and submits content queries to the MDEX engine and processes query results.

Constructor Summary

UICLMobileQueryService()

Method Summary

java.util.List<QueryProcessor>	getDetailQueryProcessors()
java.lang.String	getPageZone()
PageResult	parseResults(javax.servlet.http.HttpServletRequest request, com.endeca.content.ene.ENEContentQuery query, com.endeca.content.ene.ENEContentResults contentResults, com.endeca.soleng.urlformatter.UrlState urlState) Parses the content results, and sets the following request attributes: Submitted ENEQuery object (REQUEST_ATTR_ENE_QUERY) Returned ENEContentResults object (REQUEST_ATTR_CONTENT_RESULTS) Current UrlState object (REQUEST_ATTR_URL_STATE) The UrlFormatter object that should be used for generating links (REQUEST_ATTR_URL_FORMATTER) Redirect URL string (REQUEST_ATTR_REDIRECT_URL), if one was specified by a merch rule Response type (REQUEST_ATTR_RESPONSE_TYPE) - e.g.
PageResult	processRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.endeca.soleng.urlformatter.UrlState urlState) Called by the Controller to process the request.
void	setDetailQueryProcessors(java.util.List<QueryProcessor> detailQueryProcessors)
void	setLocalizedUrlFormatter(LocalizedUrlFormatter localizedUrlFormatter)
void	setPageZone(java.lang.String pageZone)

Methods inherited from class com.endeca.b2creference.services.query.impl.UICLContentQueryService

getApplicationConfig, getContentManager, getMaxRequeryCount, getMdexHost, getMdexPort, getQueryBuilder, getQueryProcessors, getUrlConfig, setApplicationConfig, setContentManager, setMaxRequeryCount, setQueryBuilder, setQueryProcessors, setUrlConfig, submitContentQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

UICLMobileQueryService

public UICLMobileQueryService()

Method Detail

processRequest

public PageResult processRequest(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 com.endeca.soleng.urlformatter.UrlState urlState)
                          throws java.net.MalformedURLException,
                                 com.endeca.soleng.urlformatter.UrlFormatException,
                                 com.endeca.soleng.urlformatter.QueryBuildException,
                                 com.endeca.content.ContentException,
                                 DataRetrievalException

Description copied from interface: ContentQueryService

Called by the Controller to process the request. This method creates the ENEContentQuery, submits it, and processes the results.

Specified by:

processRequest in interface ContentQueryService

Overrides:

processRequest in class UICLContentQueryService

Parameters:

request - HttpServletRequest

response - HttpServletResponse

urlState - UrlState

Throws:

java.net.MalformedURLException - On error during a redirect.

com.endeca.soleng.urlformatter.UrlFormatException - On error when parsing a request into an UrlState.

com.endeca.soleng.urlformatter.QueryBuildException - On error when marshaling an UrlState into an ENEQuery object.

com.endeca.content.ContentException - On exception when interacting with the Content Assembler API.

DataRetrievalException

parseResults

public PageResult parseResults(javax.servlet.http.HttpServletRequest request,
                               com.endeca.content.ene.ENEContentQuery query,
                               com.endeca.content.ene.ENEContentResults contentResults,
                               com.endeca.soleng.urlformatter.UrlState urlState)

Description copied from class: UICLContentQueryService

Parses the content results, and sets the following request attributes:

• Submitted ENEQuery object (REQUEST_ATTR_ENE_QUERY)
• Returned ENEContentResults object (REQUEST_ATTR_CONTENT_RESULTS)
• Current UrlState object (REQUEST_ATTR_URL_STATE)
• The UrlFormatter object that should be used for generating links (REQUEST_ATTR_URL_FORMATTER)
• Redirect URL string (REQUEST_ATTR_REDIRECT_URL), if one was specified by a merch rule
• Response type (REQUEST_ATTR_RESPONSE_TYPE) - e.g. search / navigation or record detail.

Overrides:

parseResults in class UICLContentQueryService

Parameters:

request - HttpServletRequest

query - ENEQuery

contentResults - ENEContentResults

urlFormatter - UrlFormatter

urlState - base UrlState for this request

getPageZone

public java.lang.String getPageZone()

setPageZone

public void setPageZone(java.lang.String pageZone)

setLocalizedUrlFormatter

public void setLocalizedUrlFormatter(LocalizedUrlFormatter localizedUrlFormatter)

Overrides:

setLocalizedUrlFormatter in class UICLContentQueryService

setDetailQueryProcessors

public void setDetailQueryProcessors(java.util.List<QueryProcessor> detailQueryProcessors)

getDetailQueryProcessors

public java.util.List<QueryProcessor> getDetailQueryProcessors()