com.broadleafcommerce.enterprise.workflow.admin.dao

Class WorkflowEventDaoImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.dao.WorkflowEventDaoImpl

All Implemented Interfaces:

WorkflowEventDao

@Repository(value="blWorkflowEventDao")
public class WorkflowEventDaoImpl
extends Object
implements WorkflowEventDao

Author:

Andre Azzolini (apazzolini)

See Also:

UpdateExecutor, WorkflowEventDao

Field Summary

Fields

Modifier and Type	Field and Description
static String	BC_UPDATE_APPROVAL_STATUS
static String	BC_UPDATE_COMPLETE_EVENTS
static String	BC_UPDATE_EVENT_DEPLOYMENT
static String	BC_UPDATE_EVENT_SETUP_STATUS
static String	BC_UPDATE_EVENT_SETUP_STATUS_AND_ACTION
static String	BC_UPDATE_RESET_EVENTS_APPROVAL
protected javax.persistence.EntityManager	em
protected boolean	enableStatusTiming

Constructor Summary

Constructors

Constructor and Description
WorkflowEventDaoImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addActionRestriction(List<javax.persistence.criteria.Predicate> restrictions, javax.persistence.criteria.Root<WorkflowEventImpl> root, javax.persistence.criteria.CriteriaBuilder builder, boolean isApproved) Add Predicate restrictions based on the SandBoxActionType associated to a WorkflowEvent
protected void	addArchivedRestrictions(List<javax.persistence.criteria.Predicate> restrictions, javax.persistence.criteria.Root<WorkflowEventImpl> root, javax.persistence.criteria.CriteriaBuilder builder) Add Predicate restrictions based on the ArchiveStatus associated to a WorkflowEvent
protected void	addSandboxRestriction(List<javax.persistence.criteria.Predicate> restrictions, javax.persistence.criteria.Root<WorkflowEventImpl> root, javax.persistence.criteria.CriteriaBuilder builder, Long sandboxId) Add Predicate restrictions based on SandBoxDiscriminatorImpl associated to a WorkflowEvent
protected void	addUnscheduledDeploymentRestrictions(List<javax.persistence.criteria.Predicate> restrictions, javax.persistence.criteria.Root<WorkflowEventImpl> root, javax.persistence.criteria.CriteriaBuilder builder) Add Predicate restrictions based on the WorkflowDeployment associated to a WorkflowEvent
int	completeEvents(List<Long> sandBoxItemIds) Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances that have no un-completed WorkflowSandBoxItem instances and set those events to completed status.
void	delete(WorkflowEvent event) Deletes the specified WorkflowEvent from the database
void	detach(WorkflowDeployment deployment) Detaches the given WorkflowDeployment instance from the entity manager.
void	finishDeployment(Long deploymentId) Set the StatusTiming#getDateFinished() on WorkflowDeployment.
protected javax.persistence.criteria.Selection<Long>	getIdSelection(javax.persistence.criteria.Root<?> root) Return a Selection for the id property of the entity.
WorkflowEvent	merge(WorkflowEvent event) Saves the given WorkflowEvent
WorkflowDeployment	persist(WorkflowDeployment deployment) Saves the given WorkflowDeployment
WorkflowEvent	persist(WorkflowEvent event) Saves the given WorkflowEvent
List<Long>	readAllDeployInProgressIdsForSandBox(Long sandBoxId) Reads the ids corresponding to WorkflowEvents that are in the specified sanbox and are in the process of deploying
List<WorkflowEvent>	readAllForSandBox(Long sandBoxId) Reads all WorkflowEvents that are currently associated with the given sandbox
List<WorkflowDeployment>	readAllFutureDeployments() Reads a list of WorkflowDeployments that are set to deploy at a future time.
List<Long>	readAllIdsForSandBox(Long sandBoxId) Reads the ids corresponding to WorkflowEvents that are in the specified sandbox.
List<Long>	readAllNotDeployedIdsForSandBox(Long sandBoxId) Reads the ids corresponding to WorkflowEvents that are in the specified sandbox and are not yet deployed.
WorkflowEvent	readById(Long id) Reads a given WorkflowEvent by its internal id
List<WorkflowEvent>	readByIds(List<Long> ids) Reads several WorkflowEvents by the given internal ids
List<Long>	readBySandBoxItems(List<Long> sandBoxItemIds) Reads the WorkflowEvents ids that are associated with the given WorkflowSandBoxItem ids
WorkflowDeployment	readDeploymentById(Long id) Reads a WorkflowDeployment instance that corresponds to the given id
WorkflowDeployment	readDeploymentByJob(Long jobId) Reads a WorkflowDeployment instance that corresponds to the given job id
List<WorkflowDeployment>	readDeploymentsByEvents(List<Long> events) Reads a list of WorkflowDeployments that are associated to the given list of WorkflowEvent ids.
List<WorkflowEvent>	readEntitiesBySandBoxItems(List<Long> sandBoxItemIds) Reads the WorkflowEvents that are associated with the given WorkflowSandBoxItem ids
List<Long>	readEventIdsByDeployment(Long deploymentId) Based on the id value from a WorkflowDeployment, find all associated WorkflowEvent.getId() values.
List<WorkflowEvent>	readScheduledEventsByAdminUser(org.broadleafcommerce.openadmin.server.security.domain.AdminUser user) Reads a list of WorkflowEvents that are scheduled for deployment & are authored by the provided AdminUser.
List<Long>	readUnscheduledEventIdsByApprovalStatus(Long sandboxId, boolean isApproved) Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and that are not deployed or scheduled for deployment
List<Long>	readUnscheduledEventIdsByCriticalAndApprovalStatus(Long sandboxId, boolean isCritical, boolean isApproved) Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and WorkflowEventImpl.isCritical and that are not deployed or scheduled for deployment
WorkflowEvent	refresh(WorkflowEvent event) Reloads the given WorkflowEvent with the latest version from the database.
void	removeDeployment(WorkflowDeployment deployment) Deletes the specified WorkflowDeployment from the database
int	resetEventsForApproval(List<Long> sandBoxItemIds) Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances and reset the status information for an WorkflowEvent that has already been promoted and is about to be approved.
void	startDeployment(Long deploymentId) Set the StatusTiming#getDateStarted() on WorkflowDeployment.
void	updateApprovalStatus(Long eventId) Marks the given WorkflowEvent id as Approved but not scheduled.
void	updateEventDeployment(Long eventId, WorkflowDeployment deployment) Associates the given WorkflowEvent id to the given WorkflowDeployment.
void	updateEventSetupStatus(List<Long> eventIds, int status) Change the setup status for one or more WorkflowEvent instances.
void	updateEventSetupStatus(List<Long> eventIds, int status, SandBoxActionType actionType, String message)

Methods inherited from class java.lang.Object

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

Field Detail

BC_UPDATE_COMPLETE_EVENTS

public static final String BC_UPDATE_COMPLETE_EVENTS

See Also:

Constant Field Values

BC_UPDATE_RESET_EVENTS_APPROVAL

public static final String BC_UPDATE_RESET_EVENTS_APPROVAL

See Also:

Constant Field Values

BC_UPDATE_EVENT_SETUP_STATUS

public static final String BC_UPDATE_EVENT_SETUP_STATUS

See Also:

Constant Field Values

BC_UPDATE_EVENT_SETUP_STATUS_AND_ACTION

public static final String BC_UPDATE_EVENT_SETUP_STATUS_AND_ACTION

See Also:

Constant Field Values

BC_UPDATE_EVENT_DEPLOYMENT

public static final String BC_UPDATE_EVENT_DEPLOYMENT

See Also:

Constant Field Values

BC_UPDATE_APPROVAL_STATUS

public static final String BC_UPDATE_APPROVAL_STATUS

See Also:

Constant Field Values

em

protected javax.persistence.EntityManager em

enableStatusTiming

@Value(value="${enable.enterprise.status.timing:false}")
protected boolean enableStatusTiming

Constructor Detail

WorkflowEventDaoImpl

public WorkflowEventDaoImpl()

Method Detail

persist

public WorkflowEvent persist(WorkflowEvent event)

Description copied from interface: WorkflowEventDao

Saves the given WorkflowEvent

Specified by:

persist in interface WorkflowEventDao

Returns:

the persisted WorkflowEvent

readById

@Transactional
public WorkflowEvent readById(Long id)

Description copied from interface: WorkflowEventDao

Reads a given WorkflowEvent by its internal id

Specified by:

readById in interface WorkflowEventDao

Returns:

the WorkflowEvent

readByIds

public List<WorkflowEvent> readByIds(List<Long> ids)

Description copied from interface: WorkflowEventDao

Reads several WorkflowEvents by the given internal ids

Specified by:

readByIds in interface WorkflowEventDao

Returns:

the list of WorkflowEvents

readAllForSandBox

public List<WorkflowEvent> readAllForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventDao

Reads all WorkflowEvents that are currently associated with the given sandbox

Specified by:

readAllForSandBox in interface WorkflowEventDao

Returns:

the list of WorkflowEvents

readAllNotDeployedIdsForSandBox

public List<Long> readAllNotDeployedIdsForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventDao

Reads the ids corresponding to WorkflowEvents that are in the specified sandbox and are not yet deployed.

Specified by:

readAllNotDeployedIdsForSandBox in interface WorkflowEventDao

Returns:

a list of WorkflowEvent ids

readAllDeployInProgressIdsForSandBox

public List<Long> readAllDeployInProgressIdsForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventDao

Reads the ids corresponding to WorkflowEvents that are in the specified sanbox and are in the process of deploying

Specified by:

readAllDeployInProgressIdsForSandBox in interface WorkflowEventDao

Returns:

readAllIdsForSandBox

public List<Long> readAllIdsForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventDao

Reads the ids corresponding to WorkflowEvents that are in the specified sandbox.

Specified by:

readAllIdsForSandBox in interface WorkflowEventDao

Returns:

a list of WorkflowEvent ids

readBySandBoxItems

public List<Long> readBySandBoxItems(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventDao

Reads the WorkflowEvents ids that are associated with the given WorkflowSandBoxItem ids

Specified by:

readBySandBoxItems in interface WorkflowEventDao

Returns:

the list of WorkflowEvents

readEntitiesBySandBoxItems

public List<WorkflowEvent> readEntitiesBySandBoxItems(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventDao

Reads the WorkflowEvents that are associated with the given WorkflowSandBoxItem ids

Specified by:

readEntitiesBySandBoxItems in interface WorkflowEventDao

Returns:

completeEvents

public int completeEvents(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventDao

Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances that have no un-completed WorkflowSandBoxItem instances and set those events to completed status.

Specified by:

completeEvents in interface WorkflowEventDao

Returns:

resetEventsForApproval

public int resetEventsForApproval(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventDao

Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances and reset the status information for an WorkflowEvent that has already been promoted and is about to be approved.

Specified by:

resetEventsForApproval in interface WorkflowEventDao

Returns:

delete

public void delete(WorkflowEvent event)

Description copied from interface: WorkflowEventDao

Deletes the specified WorkflowEvent from the database

Specified by:

delete in interface WorkflowEventDao

refresh

public WorkflowEvent refresh(WorkflowEvent event)

Description copied from interface: WorkflowEventDao

Reloads the given WorkflowEvent with the latest version from the database.

Specified by:

refresh in interface WorkflowEventDao

Returns:

the refreshed WorkflowEvent

persist

public WorkflowDeployment persist(WorkflowDeployment deployment)

Description copied from interface: WorkflowEventDao

Saves the given WorkflowDeployment

Specified by:

persist in interface WorkflowEventDao

Returns:

the persisted WorkflowDeployment

detach

public void detach(WorkflowDeployment deployment)

Description copied from interface: WorkflowEventDao

Detaches the given WorkflowDeployment instance from the entity manager.

Specified by:

detach in interface WorkflowEventDao

merge

public WorkflowEvent merge(WorkflowEvent event)

Description copied from interface: WorkflowEventDao

Saves the given WorkflowEvent

Specified by:

merge in interface WorkflowEventDao

Returns:

the merged WorkflowEvent

updateApprovalStatus

public void updateApprovalStatus(Long eventId)

Description copied from interface: WorkflowEventDao

Marks the given WorkflowEvent id as Approved but not scheduled.

Specified by:

updateApprovalStatus in interface WorkflowEventDao

updateEventDeployment

public void updateEventDeployment(Long eventId,
                                  WorkflowDeployment deployment)

Description copied from interface: WorkflowEventDao

Associates the given WorkflowEvent id to the given WorkflowDeployment.

Specified by:

updateEventDeployment in interface WorkflowEventDao

updateEventSetupStatus

public void updateEventSetupStatus(List<Long> eventIds,
                                   int status)

Description copied from interface: WorkflowEventDao

Change the setup status for one or more WorkflowEvent instances.

Specified by:

updateEventSetupStatus in interface WorkflowEventDao

Parameters:

eventIds - the primary key values for the WorkflowEvent instances to update

status - arbitrary status - known values defined in WorkflowEventSetupStatus

updateEventSetupStatus

public void updateEventSetupStatus(List<Long> eventIds,
                                   int status,
                                   SandBoxActionType actionType,
                                   String message)

Specified by:

updateEventSetupStatus in interface WorkflowEventDao

readDeploymentByJob

public WorkflowDeployment readDeploymentByJob(Long jobId)

Description copied from interface: WorkflowEventDao

Reads a WorkflowDeployment instance that corresponds to the given job id

Specified by:

readDeploymentByJob in interface WorkflowEventDao

Returns:

the WorkflowDeployment

readDeploymentsByEvents

public List<WorkflowDeployment> readDeploymentsByEvents(List<Long> events)

Description copied from interface: WorkflowEventDao

Reads a list of WorkflowDeployments that are associated to the given list of WorkflowEvent ids.

Specified by:

readDeploymentsByEvents in interface WorkflowEventDao

Returns:

the list of WorkflowDeployments

readEventIdsByDeployment

public List<Long> readEventIdsByDeployment(Long deploymentId)

Description copied from interface: WorkflowEventDao

Based on the id value from a WorkflowDeployment, find all associated WorkflowEvent.getId() values.

Specified by:

readEventIdsByDeployment in interface WorkflowEventDao

Returns:

readScheduledEventsByAdminUser

public List<WorkflowEvent> readScheduledEventsByAdminUser(org.broadleafcommerce.openadmin.server.security.domain.AdminUser user)

Description copied from interface: WorkflowEventDao

Reads a list of WorkflowEvents that are scheduled for deployment & are authored by the provided AdminUser.

Specified by:

readScheduledEventsByAdminUser in interface WorkflowEventDao

Returns:

readDeploymentById

public WorkflowDeployment readDeploymentById(Long id)

Description copied from interface: WorkflowEventDao

Reads a WorkflowDeployment instance that corresponds to the given id

Specified by:

readDeploymentById in interface WorkflowEventDao

Returns:

the WorkflowDeployment

startDeployment

public void startDeployment(Long deploymentId)

Description copied from interface: WorkflowEventDao

Set the StatusTiming#getDateStarted() on WorkflowDeployment. Currently, this requires the 'enable.status.timing' property be set to 'true', as the StatusTiming fields are conditionally weaved into the domain. Additionally, the 'DATE_STARTED' column must be setup on the BLC_SNDBX_WRKFLW_DEPLOY table. See StatusTimingImpl for more info on the field.

Specified by:

startDeployment in interface WorkflowEventDao

finishDeployment

public void finishDeployment(Long deploymentId)

Description copied from interface: WorkflowEventDao

Set the StatusTiming#getDateFinished() on WorkflowDeployment. Currently, this requires the 'enable.status.timing' property be set to 'true', as the StatusTiming fields are conditionally weaved into the domain. Additionally, the 'DATE_FINISHED' column must be setup on the BLC_SNDBX_WRKFLW_DEPLOY table. See StatusTimingImpl for more info on the field.

Specified by:

finishDeployment in interface WorkflowEventDao

readAllFutureDeployments

public List<WorkflowDeployment> readAllFutureDeployments()

Description copied from interface: WorkflowEventDao

Reads a list of WorkflowDeployments that are set to deploy at a future time.

Specified by:

readAllFutureDeployments in interface WorkflowEventDao

Returns:

the list of WorkflowDeployments

removeDeployment

public void removeDeployment(WorkflowDeployment deployment)

Description copied from interface: WorkflowEventDao

Deletes the specified WorkflowDeployment from the database

Specified by:

removeDeployment in interface WorkflowEventDao

readUnscheduledEventIdsByCriticalAndApprovalStatus

public List<Long> readUnscheduledEventIdsByCriticalAndApprovalStatus(Long sandboxId,
                                                                     boolean isCritical,
                                                                     boolean isApproved)

Description copied from interface: WorkflowEventDao

Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and WorkflowEventImpl.isCritical and that are not deployed or scheduled for deployment

Specified by:

readUnscheduledEventIdsByCriticalAndApprovalStatus in interface WorkflowEventDao

Returns:

readUnscheduledEventIdsByApprovalStatus

public List<Long> readUnscheduledEventIdsByApprovalStatus(Long sandboxId,
                                                          boolean isApproved)

Description copied from interface: WorkflowEventDao

Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and that are not deployed or scheduled for deployment

Specified by:

readUnscheduledEventIdsByApprovalStatus in interface WorkflowEventDao

Returns:

getIdSelection

protected javax.persistence.criteria.Selection<Long> getIdSelection(javax.persistence.criteria.Root<?> root)

Return a Selection for the id property of the entity.

Parameters:

root -

Returns:

addSandboxRestriction

protected void addSandboxRestriction(List<javax.persistence.criteria.Predicate> restrictions,
                                     javax.persistence.criteria.Root<WorkflowEventImpl> root,
                                     javax.persistence.criteria.CriteriaBuilder builder,
                                     Long sandboxId)

Add Predicate restrictions based on SandBoxDiscriminatorImpl associated to a WorkflowEvent

Parameters:

restrictions -

root -

builder -

sandboxId -

addArchivedRestrictions

protected void addArchivedRestrictions(List<javax.persistence.criteria.Predicate> restrictions,
                                       javax.persistence.criteria.Root<WorkflowEventImpl> root,
                                       javax.persistence.criteria.CriteriaBuilder builder)

Add Predicate restrictions based on the ArchiveStatus associated to a WorkflowEvent

Parameters:

restrictions -

root -

builder -

addUnscheduledDeploymentRestrictions

protected void addUnscheduledDeploymentRestrictions(List<javax.persistence.criteria.Predicate> restrictions,
                                                    javax.persistence.criteria.Root<WorkflowEventImpl> root,
                                                    javax.persistence.criteria.CriteriaBuilder builder)

Add Predicate restrictions based on the WorkflowDeployment associated to a WorkflowEvent

Parameters:

restrictions -

root -

builder -

addActionRestriction

protected void addActionRestriction(List<javax.persistence.criteria.Predicate> restrictions,
                                    javax.persistence.criteria.Root<WorkflowEventImpl> root,
                                    javax.persistence.criteria.CriteriaBuilder builder,
                                    boolean isApproved)

Add Predicate restrictions based on the SandBoxActionType associated to a WorkflowEvent

Parameters:

restrictions -

root -

builder -

isApproved -