com.broadleafcommerce.cartoperation.web.endpoint.domain

Class ShareItemListRequest

java.lang.Object

com.broadleafcommerce.cartoperation.web.endpoint.domain.ShareItemListRequest

All Implemented Interfaces:

Serializable

public class ShareItemListRequest
extends Object
implements Serializable

A request body to share an item list. Describes which item list to share and who it should be shared with with which level of access.

Author:

Jacob Mitash

See Also:

ItemList, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShareItemListRequest.Target

Constructor Summary

Constructors

Constructor and Description
ShareItemListRequest()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getListId() The ID of the item list being shared.
String	getRole() The role that the targets this item list is being shared with will be granted.
Set<ShareItemListRequest.Target>	getTargets() Describes who this list is being shared with.
String	getValueType() The type of values that this list will be shared with (e.g email address, customer ID, etc.).
int	hashCode()
void	setListId(String listId) The ID of the item list being shared.
void	setRole(String role) The role that the targets this item list is being shared with will be granted.
void	setTargets(Set<ShareItemListRequest.Target> targets) Describes who this list is being shared with.
void	setValueType(String valueType) The type of values that this list will be shared with (e.g email address, customer ID, etc.).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShareItemListRequest

public ShareItemListRequest()

Method Detail

getListId

public String getListId()

The ID of the item list being shared. This will be populated from the request path.

Returns:

the ID of the item list being shared

getValueType

public String getValueType()

The type of values that this list will be shared with (e.g email address, customer ID, etc.). This corresponds to ShareItemListRequest.Target.value. See ItemListAccessRule.getType() for how this is used. See DefaultItemListAccessRuleType for the default supported values.

Returns:

the type of value this item list is being shared with

getRole

public String getRole()

The role that the targets this item list is being shared with will be granted. See ItemListAccessRule.getRole() for how this is used. See DefaultItemListAccessRuleRole for the default supported values.

Returns:

the role that the targets this item list is being shared with will be granted

getTargets

public Set<ShareItemListRequest.Target> getTargets()

Describes who this list is being shared with.

setListId

public void setListId(String listId)

The ID of the item list being shared. This will be populated from the request path.

Parameters:

listId - the ID of the item list being shared

setValueType

public void setValueType(String valueType)

The type of values that this list will be shared with (e.g email address, customer ID, etc.). This corresponds to ShareItemListRequest.Target.value. See ItemListAccessRule.getType() for how this is used. See DefaultItemListAccessRuleType for the default supported values.

Parameters:

valueType - the type of value this item list is being shared with

setRole

public void setRole(String role)

The role that the targets this item list is being shared with will be granted. See ItemListAccessRule.getRole() for how this is used. See DefaultItemListAccessRuleRole for the default supported values.

Parameters:

role - the role that the targets this item list is being shared with will be granted

setTargets

public void setTargets(Set<ShareItemListRequest.Target> targets)

Describes who this list is being shared with.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object