Package com.broadleafcommerce.sandbox.domain

Class ChangeSummaryGroups

java.lang.Object

com.broadleafcommerce.sandbox.domain.ChangeSummaryGroups

All Implemented Interfaces:

Serializable

public class ChangeSummaryGroups
extends Object
implements Serializable

Request construct that details a list of ChangeSummaryGroup.getId() values to operate on. Alternatively, this construct can define "all change summary groups" via the allChangeSummaryGroups property.

Author:

Jeff Fischer

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ChangeSummaryGroups()
ChangeSummaryGroups(List<String> changeSummaryGroupIds, boolean allChangeSummaryGroups, String message, String name)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<String>	getChangeSummaryGroupIds()	The list of id values for ChangeSummaryGroup instances that should be targeted for the API request.
String	getMessage()	Message detailing the reason why the changes were transitioned.
String	getName()	Name that can be used to identify the groups as a unit.
String	getReceiver()	Sandbox owner to target as the recipient of the reject.
int	hashCode()
boolean	isAllChangeSummaryGroups()	Whether or not all valid ChangeSummaryGroups for the current request context (e.g.
void	setAllChangeSummaryGroups(boolean allChangeSummaryGroups)	Whether or not all valid ChangeSummaryGroups for the current request context (e.g.
void	setChangeSummaryGroupIds(List<String> changeSummaryGroupIds)	The list of id values for ChangeSummaryGroup instances that should be targeted for the API request.
void	setMessage(String message)	Message detailing the reason why the changes were transitioned.
void	setName(String name)	Name that can be used to identify the groups as a unit.
void	setReceiver(String receiver)	Sandbox owner to target as the recipient of the reject.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChangeSummaryGroups

public ChangeSummaryGroups(List<String> changeSummaryGroupIds,
 boolean allChangeSummaryGroups,
 String message,
 String name)

ChangeSummaryGroups

public ChangeSummaryGroups()

Method Details

getChangeSummaryGroupIds

public List<String> getChangeSummaryGroupIds()

The list of id values for ChangeSummaryGroup instances that should be targeted for the API request.

Returns:

The list of id values for ChangeSummaryGroup instances that should be targeted

isAllChangeSummaryGroups

public boolean isAllChangeSummaryGroups()

Whether or not all valid ChangeSummaryGroups for the current request context (e.g. all ChangeSummaryGroup instances belonging to a sandbox) should be included. If true, changeSummaryGroupIds is ignored. The default value is false.

Returns:

Whether or not all valid ChangeSummaryGroups for the current request context should be included

getMessage

public String getMessage()

Message detailing the reason why the changes were transitioned. For example, this is used for rejection and deployment messages.

getName

public String getName()

Name that can be used to identify the groups as a unit. Typically only used in relation to scheduling groups for deployment.

getReceiver

public String getReceiver()

Sandbox owner to target as the recipient of the reject. Reject are usually automatically sent to the author of the most recent promote sandbox state. However, occasionally, it is necessary to override this behavior, especially when the author of the current promote sandbox state is ambiguous.

setChangeSummaryGroupIds

public void setChangeSummaryGroupIds(List<String> changeSummaryGroupIds)

The list of id values for ChangeSummaryGroup instances that should be targeted for the API request.

Parameters:

changeSummaryGroupIds - The list of id values for ChangeSummaryGroup instances that should be targeted

setAllChangeSummaryGroups

public void setAllChangeSummaryGroups(boolean allChangeSummaryGroups)

Whether or not all valid ChangeSummaryGroups for the current request context (e.g. all ChangeSummaryGroup instances belonging to a sandbox) should be included. If true, changeSummaryGroupIds is ignored. The default value is false.

Parameters:

allChangeSummaryGroups - Whether or not all valid ChangeSummaryGroups for the current request context should be included

setMessage

public void setMessage(String message)

Message detailing the reason why the changes were transitioned. For example, this is used for rejection and deployment messages.

setName

public void setName(String name)

Name that can be used to identify the groups as a unit. Typically only used in relation to scheduling groups for deployment.

setReceiver

public void setReceiver(String receiver)

Sandbox owner to target as the recipient of the reject. Reject are usually automatically sent to the author of the most recent promote sandbox state. However, occasionally, it is necessary to override this behavior, especially when the author of the current promote sandbox state is ambiguous.

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