atg.repository.search.refinement
Class FacetSearchResponse

java.lang.Object
  atg.repository.search.refinement.FacetSearchResponse

Direct Known Subclasses:

CommerceFacetSearchResponse

Deprecated. As of release 9.0 - refer to FacetSearchTools

public class FacetSearchResponse
extends java.lang.Object

Class that represents an ES response that has been converted to a list of available facets and a list of matching products.

Field Summary

static java.lang.String

CLASS_VERSION Deprecated. Class version string

Constructor Summary

FacetSearchResponse()
Deprecated. Basic constructor

FacetSearchResponse(atg.repository.search.refinement.FacetSearchRequest pFacetSearchRequest, Results pResults)
Deprecated. Constructor

Method Summary

FacetHolder[]	getAvailableFacets() Deprecated.
ClientRequest	getClientRequest() Deprecated.
atg.repository.search.refinement.FacetSearchRequest	getFacetSearchRequest() Deprecated.
Response[]	getMatchingItems() Deprecated.
int	getNumResultsReturned() Deprecated. Gets the number of results (matching items) returned in a the search response
int	getPageNum() Deprecated.
java.lang.String	getRequestXml() Deprecated. Gets the client request XML
java.lang.String	getResponseXml() Deprecated. Utility method to retrieve the response XML
Results	getSearchResults() Deprecated. Gets the actual Results object returned by ES.
int	getTotalPages() Deprecated.
int	getTotalResults() Deprecated. Gets the total number of results for a search request
void	setAvailableFacets(FacetHolder[] pAvailableFacets) Deprecated.
void	setClientRequest(ClientRequest pClientRequest) Deprecated.
void	setFacetSearchRequest(atg.repository.search.refinement.FacetSearchRequest pFacetSearchRequest) Deprecated.
void	setMatchingItems(Response[] pMatchingItems) Deprecated.
void	setNumResultsReturned(int pNumResultsReturned) Deprecated. Sets the number of results returned in a search response
void	setPageNum(int pPageNum) Deprecated.
void	setRequestXml(java.lang.String pRequestXml) Deprecated. Sets the client request XML
void	setSearchResults(Results pSearchResults) Deprecated.
void	setTotalPages(int pTotalPages) Deprecated.
void	setTotalResults(int pTotalResults) Deprecated. Sets the total number of results for a search request
java.lang.String	toString() Deprecated. String reperesentation for diagnostics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Deprecated.

Class version string

See Also:

Constant Field Values

Constructor Detail

FacetSearchResponse

public FacetSearchResponse()

Deprecated.

Basic constructor

FacetSearchResponse

public FacetSearchResponse(atg.repository.search.refinement.FacetSearchRequest pFacetSearchRequest,
                           Results pResults)

Deprecated.

Constructor

Parameters:

pFacetSearchRequest - The facet search request that resulted in this response object

pResults - The results obtained from ES.

Method Detail

getAvailableFacets

public FacetHolder[] getAvailableFacets()

Deprecated.

Returns:

Returns the mAvailableFacets.

setAvailableFacets

public void setAvailableFacets(FacetHolder[] pAvailableFacets)

Deprecated.

Parameters:

availableFacets - The mAvailableFacets to set.

getMatchingItems

public Response[] getMatchingItems()

Deprecated.

Returns:

An array of matching items

setMatchingItems

public void setMatchingItems(Response[] pMatchingItems)

Deprecated.

Parameters:

matchingProducts - The matching items to set.

getPageNum

public int getPageNum()

Deprecated.

Returns:

The current page number

setPageNum

public void setPageNum(int pPageNum)

Deprecated.

Parameters:

pPageNum - The current page number to set.

getTotalPages

public int getTotalPages()

Deprecated.

Returns:

The total number of results pages.

setTotalPages

public void setTotalPages(int pTotalPages)

Deprecated.

Parameters:

pTotalPages - The total number of results pages to set.

getNumResultsReturned

public int getNumResultsReturned()

Deprecated.

Gets the number of results (matching items) returned in a the search response

Returns:

The number of results returned

setNumResultsReturned

public void setNumResultsReturned(int pNumResultsReturned)

Deprecated.

Sets the number of results returned in a search response

Parameters:

pNumResultsReturned - The number of results to set.

getTotalResults

public int getTotalResults()

Deprecated.

Gets the total number of results for a search request

Returns:

The total number of results.

setTotalResults

public void setTotalResults(int pTotalResults)

Deprecated.

Sets the total number of results for a search request

Parameters:

pTotalResults - The total number of results to set.

getSearchResults

public Results getSearchResults()

Deprecated.

Gets the actual Results object returned by ES. Typically used to provide additional information that may be needed.

Returns:

The Results object returned by the ES request

setSearchResults

public void setSearchResults(Results pSearchResults)

Deprecated.

Parameters:

pSearchResults - The Results object to set.

getFacetSearchRequest

public atg.repository.search.refinement.FacetSearchRequest getFacetSearchRequest()

Deprecated.

Returns:

The original facet search request object used to generate this response

setFacetSearchRequest

public void setFacetSearchRequest(atg.repository.search.refinement.FacetSearchRequest pFacetSearchRequest)

Deprecated.

Parameters:

pFacetSearchRequest - The face search request to set.

getClientRequest

public ClientRequest getClientRequest()

Deprecated.

Returns:

The ClientRequest object generated for the search

setClientRequest

public void setClientRequest(ClientRequest pClientRequest)

Deprecated.

Parameters:

pClientRequest - ClientRequest object generated for the seaarch

getRequestXml

public java.lang.String getRequestXml()

Deprecated.

Gets the client request XML

Returns:

The client request XML

setRequestXml

public void setRequestXml(java.lang.String pRequestXml)

Deprecated.

Sets the client request XML

Parameters:

pRequestXml - The client request XML to be set

getResponseXml

public java.lang.String getResponseXml()

Deprecated.

Utility method to retrieve the response XML

Returns:

The response XML.

toString

public java.lang.String toString()

Deprecated.

String reperesentation for diagnostics.

Overrides:

toString in class java.lang.Object