com.broadleafcommerce.enterprise.workflow.admin.service.behavior.simple

Class SimpleStateManager.EventGroup

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.service.behavior.simple.SimpleStateManager.EventGroup

Enclosing interface:

SimpleStateManager

public static class SimpleStateManager.EventGroup
extends Object

A higher level grouping of SimpleStateManager.DetailGroup. One or more DetailGroups can be combined into a single EventGroup concept. EventGroups are roughly analogous to a WorkflowEvent, which is expressed in the approval view in the admin.

Constructor Summary

Constructors

Constructor and Description
EventGroup(List<SimpleStateManager.DetailGroup> detailGroups, String name, String message, boolean isComplete, String correlationId) Provide multiple SimpleStateManager.DetailGroup instances to be grouped into this EventGroup.
EventGroup(SimpleStateManager.DetailGroup detailGroup, String name, String message) Construct a single event group for a single detail group.

Method Summary

Modifier and Type	Method and Description
String	getCorrelationId()
List<SimpleStateManager.DetailGroup>	getDetailGroups()
String	getMessage()
String	getName()
boolean	isComplete()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventGroup

public EventGroup(SimpleStateManager.DetailGroup detailGroup,
                  String name,
                  String message)

Construct a single event group for a single detail group.

Parameters:

detailGroup - The SimpleStateManager.DetailGroup

name - The identifying name that will appear in the admin approval view

message - Optional descriptive message

EventGroup

public EventGroup(List<SimpleStateManager.DetailGroup> detailGroups,
                  String name,
                  String message,
                  boolean isComplete,
                  String correlationId)

Provide multiple SimpleStateManager.DetailGroup instances to be grouped into this EventGroup.

Parameters:

detailGroups - The list of DetailGroups

name - The identifying name that will appear in the admin approval view

message - Optional descriptive message

isComplete - Whether or not this list represents all the detail groups, or if more detail groups will be coming in a different batch

correlationId - A simple string value to identify this EventGroup during this process. This correlation id facilitates matching additional detail groups across multiple batch calls to this method.

Method Detail

getDetailGroups

public List<SimpleStateManager.DetailGroup> getDetailGroups()

getName

public String getName()

isComplete

public boolean isComplete()

getCorrelationId

public String getCorrelationId()

getMessage

public String getMessage()