com.bazaarvoice.bvandroidsdk

Class ReviewDisplayRequestBuilder<BuilderType,RequestType>

java.lang.Object

com.bazaarvoice.bvandroidsdk.ReviewDisplayRequestBuilder<BuilderType,RequestType>

Direct Known Subclasses:

ReviewsRequest.Builder, StoreReviewsRequest.Builder

public abstract class ReviewDisplayRequestBuilder<BuilderType,RequestType>
extends java.lang.Object

Common options for building a Review Display Request.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	limit
protected int	offset
protected java.lang.String	productId
protected java.util.List<ReviewIncludeType>	reviewIncludeTypes
protected java.lang.String	searchPhrase
protected java.util.List<com.bazaarvoice.bvandroidsdk.Sort>	sorts

Constructor Summary

Constructors

Constructor and Description
ReviewDisplayRequestBuilder(java.lang.String productId, int limit, int offset)

Method Summary

Modifier and Type	Method and Description
BuilderType	addAdditionalField(java.lang.String key, java.lang.String value) Deprecated. In order to avoid confusion with the unrelated Review Submission specific BaseReviewBuilder.addAdditionalField(String, String), use addCustomDisplayParameter(String, String) instead. This method adds extra user provided query parameters to a display request, and will be urlencoded.
BuilderType	addCustomDisplayParameter(java.lang.String key, java.lang.String value) This method adds extra user provided query parameters to a display request, and will be urlencoded.
protected void	addFilter(com.bazaarvoice.bvandroidsdk.Filter filter)
BuilderType	addFilter(ReviewOptions.Filter filter, EqualityOperator equalityOperator, java.util.List<java.lang.String> values)
BuilderType	addFilter(ReviewOptions.Filter filter, EqualityOperator equalityOperator, java.lang.String value)
BuilderType	addIncludeContent(ReviewIncludeType reviewIncludeType)
BuilderType	addSort(ReviewOptions.Sort sort, SortOrder sortOrder)
abstract RequestType	build()
BuilderType	includeSearchPhrase(java.lang.String search)

Methods inherited from class java.lang.Object

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

Field Detail

productId

protected final java.lang.String productId

sorts

protected final java.util.List<com.bazaarvoice.bvandroidsdk.Sort> sorts

limit

protected final int limit

offset

protected final int offset

searchPhrase

protected java.lang.String searchPhrase

reviewIncludeTypes

protected java.util.List<ReviewIncludeType> reviewIncludeTypes

Constructor Detail

ReviewDisplayRequestBuilder

public ReviewDisplayRequestBuilder(java.lang.String productId,
                                   int limit,
                                   int offset)

Method Detail

addIncludeContent

public BuilderType addIncludeContent(ReviewIncludeType reviewIncludeType)

addSort

public BuilderType addSort(ReviewOptions.Sort sort,
                           SortOrder sortOrder)

addFilter

public BuilderType addFilter(ReviewOptions.Filter filter,
                             EqualityOperator equalityOperator,
                             java.lang.String value)

addFilter

public BuilderType addFilter(ReviewOptions.Filter filter,
                             EqualityOperator equalityOperator,
                             java.util.List<java.lang.String> values)

includeSearchPhrase

public BuilderType includeSearchPhrase(java.lang.String search)

build

public abstract RequestType build()

addFilter

protected void addFilter(com.bazaarvoice.bvandroidsdk.Filter filter)

addAdditionalField

public BuilderType addAdditionalField(java.lang.String key,
                                      java.lang.String value)

Deprecated. In order to avoid confusion with the unrelated Review Submission specific BaseReviewBuilder.addAdditionalField(String, String), use addCustomDisplayParameter(String, String) instead.

This method adds extra user provided query parameters to a display request, and will be urlencoded.

Parameters:

key - Custom non-encoded url query param key

value - Custom non-encoded url query param value

Returns:

The Builder

addCustomDisplayParameter

public BuilderType addCustomDisplayParameter(java.lang.String key,
                                             java.lang.String value)

This method adds extra user provided query parameters to a display request, and will be urlencoded.

Parameters:

key - Custom non-encoded url query param key

value - Custom non-encoded url query param value

Returns:

The Builder