Package com.commercetools.api.models.review

Class ReviewDraftBuilder

java.lang.Object

com.commercetools.api.models.review.ReviewDraftBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<ReviewDraft>

public class ReviewDraftBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ReviewDraft>

ReviewDraftBuilder Example to create an instance using the builder pattern

     ReviewDraft reviewDraft = ReviewDraft.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ReviewDraftBuilder()

Method Summary

Modifier and Type	Method	Description
ReviewDraftBuilder	authorName(String authorName)	Name of the author.
ReviewDraft	build()	builds ReviewDraft with checking for non-null required values
ReviewDraft	buildUnchecked()	builds ReviewDraft without checking for non-null required values
ReviewDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Review.
ReviewDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Review.
ReviewDraftBuilder	customer(CustomerResourceIdentifier customer)	Customer who created the Review.
ReviewDraftBuilder	customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)	Customer who created the Review.
String	getAuthorName()	Name of the author.
CustomFieldsDraft	getCustom()	Custom Fields for the Review.
CustomerResourceIdentifier	getCustomer()	Customer who created the Review.
String	getKey()	User-defined unique identifier for the Review.
String	getLocale()	Language in which the content of the Review is written.
Integer	getRating()	Rating of the targeted Product or Channel.
StateResourceIdentifier	getState()	State of the Review.
ResourceIdentifier	getTarget()	Draft type to create a Reference or a KeyReference to a resource.
String	getText()	Content of the Review.
String	getTitle()	Title of the Review.
String	getUniquenessValue()	If set, this value must be unique among Reviews.
ReviewDraftBuilder	key(String key)	User-defined unique identifier for the Review.
ReviewDraftBuilder	locale(String locale)	Language in which the content of the Review is written.
static ReviewDraftBuilder	of()	factory method for an instance of ReviewDraftBuilder
static ReviewDraftBuilder	of(ReviewDraft template)	create builder for ReviewDraft instance
ReviewDraftBuilder	rating(Integer rating)	Rating of the targeted Product or Channel.
ReviewDraftBuilder	state(StateResourceIdentifier state)	State of the Review.
ReviewDraftBuilder	state(Function<StateResourceIdentifierBuilder,StateResourceIdentifierBuilder> builder)	State of the Review.
ReviewDraftBuilder	target(ResourceIdentifier target)	Draft type to create a Reference or a KeyReference to a resource.
ReviewDraftBuilder	target(Function<ResourceIdentifierBuilder,io.vrap.rmf.base.client.Builder<? extends ResourceIdentifier>> builder)	Draft type to create a Reference or a KeyReference to a resource.
ReviewDraftBuilder	text(String text)	Content of the Review.
ReviewDraftBuilder	title(String title)	Title of the Review.
ReviewDraftBuilder	uniquenessValue(String uniquenessValue)	If set, this value must be unique among Reviews.
ReviewDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Review.
ReviewDraftBuilder	withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)	Customer who created the Review.
ReviewDraftBuilder	withState(Function<StateResourceIdentifierBuilder,StateResourceIdentifier> builder)	State of the Review.

Methods inherited from class java.lang.Object

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

Constructor Details

ReviewDraftBuilder

public ReviewDraftBuilder()

Method Details

key

public ReviewDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the Review.

Parameters:

key - value to be set

Returns:

Builder

uniquenessValue

public ReviewDraftBuilder uniquenessValue(@Nullable
 String uniquenessValue)

If set, this value must be unique among Reviews. For example, if you want to have only one Review per Customer and per Product, you can set the value to Customer id + Product id.

Parameters:

uniquenessValue - value to be set

Returns:

Builder

locale

public ReviewDraftBuilder locale(@Nullable
 String locale)

Language in which the content of the Review is written.

Parameters:

locale - value to be set

Returns:

Builder

authorName

public ReviewDraftBuilder authorName(@Nullable
 String authorName)

Name of the author.

Parameters:

authorName - value to be set

Returns:

Builder

title

public ReviewDraftBuilder title(@Nullable
 String title)

Title of the Review.

Parameters:

title - value to be set

Returns:

Builder

text

public ReviewDraftBuilder text(@Nullable
 String text)

Content of the Review.

Parameters:

text - value to be set

Returns:

Builder

target

public ReviewDraftBuilder target(@Nullable
 ResourceIdentifier target)

Draft type to create a Reference or a KeyReference to a resource. Provide either the id or (wherever supported) the key of the resource to reference, but depending on the API endpoint the response returns either a Reference or a KeyReference. For example, the field parent of a CategoryDraft takes a ResourceIdentifier for its value while the value of the corresponding field of a Category is a Reference.

Each resource type has its corresponding ResourceIdentifier, like ChannelResourceIdentifier.

Parameters:

target - value to be set

Returns:

Builder

target

public ReviewDraftBuilder target(Function<ResourceIdentifierBuilder,io.vrap.rmf.base.client.Builder<? extends ResourceIdentifier>> builder)

Draft type to create a Reference or a KeyReference to a resource. Provide either the id or (wherever supported) the key of the resource to reference, but depending on the API endpoint the response returns either a Reference or a KeyReference. For example, the field parent of a CategoryDraft takes a ResourceIdentifier for its value while the value of the corresponding field of a Category is a Reference.

Each resource type has its corresponding ResourceIdentifier, like ChannelResourceIdentifier.

Parameters:

builder - function to build the target value

Returns:

Builder

state

public ReviewDraftBuilder state(Function<StateResourceIdentifierBuilder,StateResourceIdentifierBuilder> builder)

State of the Review. Used for approval processes, see Review approval process for details.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

public ReviewDraftBuilder withState(Function<StateResourceIdentifierBuilder,StateResourceIdentifier> builder)

State of the Review. Used for approval processes, see Review approval process for details.

Parameters:

builder - function to build the state value

Returns:

Builder

state

public ReviewDraftBuilder state(@Nullable
 StateResourceIdentifier state)

State of the Review. Used for approval processes, see Review approval process for details.

Parameters:

state - value to be set

Returns:

Builder

rating

public ReviewDraftBuilder rating(@Nullable
 Integer rating)

Rating of the targeted Product or Channel. This rating can represent the number of stars, a percentage, or a like (+1)/dislike (-1). A rating is used in the ratings statistics of the targeted object, unless the Review is in a State that does not have the role ReviewIncludedInStatistics.

Parameters:

rating - value to be set

Returns:

Builder

customer

public ReviewDraftBuilder customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)

Customer who created the Review.

Parameters:

builder - function to build the customer value

Returns:

Builder

withCustomer

public ReviewDraftBuilder withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)

Customer who created the Review.

Parameters:

builder - function to build the customer value

Returns:

Builder

customer

public ReviewDraftBuilder customer(@Nullable
 CustomerResourceIdentifier customer)

Customer who created the Review.

Parameters:

customer - value to be set

Returns:

Builder

custom

public ReviewDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Review.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public ReviewDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Review.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public ReviewDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Review.

Parameters:

custom - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier for the Review.

Returns:

key

getUniquenessValue

@Nullable
public String getUniquenessValue()

If set, this value must be unique among Reviews. For example, if you want to have only one Review per Customer and per Product, you can set the value to Customer id + Product id.

Returns:

uniquenessValue

getLocale

@Nullable
public String getLocale()

Language in which the content of the Review is written.

Returns:

locale

getAuthorName

@Nullable
public String getAuthorName()

Name of the author.

Returns:

authorName

getTitle

@Nullable
public String getTitle()

Title of the Review.

Returns:

title

getText

@Nullable
public String getText()

Content of the Review.

Returns:

text

getTarget

@Nullable
public ResourceIdentifier getTarget()

Draft type to create a Reference or a KeyReference to a resource. Provide either the id or (wherever supported) the key of the resource to reference, but depending on the API endpoint the response returns either a Reference or a KeyReference. For example, the field parent of a CategoryDraft takes a ResourceIdentifier for its value while the value of the corresponding field of a Category is a Reference.

Each resource type has its corresponding ResourceIdentifier, like ChannelResourceIdentifier.

Returns:

target

getState

@Nullable
public StateResourceIdentifier getState()

State of the Review. Used for approval processes, see Review approval process for details.

Returns:

state

getRating

@Nullable
public Integer getRating()

Rating of the targeted Product or Channel. This rating can represent the number of stars, a percentage, or a like (+1)/dislike (-1). A rating is used in the ratings statistics of the targeted object, unless the Review is in a State that does not have the role ReviewIncludedInStatistics.

Returns:

rating

getCustomer

@Nullable
public CustomerResourceIdentifier getCustomer()

Customer who created the Review.

Returns:

customer

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Review.

Returns:

custom

build

public ReviewDraft build()

builds ReviewDraft with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<ReviewDraft>

Returns:

ReviewDraft

buildUnchecked

public ReviewDraft buildUnchecked()

builds ReviewDraft without checking for non-null required values

Returns:

ReviewDraft

of

public static ReviewDraftBuilder of()

factory method for an instance of ReviewDraftBuilder

Returns:

builder

of

public static ReviewDraftBuilder of(ReviewDraft template)

create builder for ReviewDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder