com.broadleafcommerce.enterprise.workflow.admin.dao

Interface WorkflowEventDao

All Known Implementing Classes:

WorkflowEventDaoImpl

public interface WorkflowEventDao

Repository access for WorkflowEvents and WorkflowDeployments.

Author:

Andre Azzolini (apazzolini), Jeff Fischer

Method Summary

Modifier and Type	Method and Description
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.
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<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)

Method Detail

persist

WorkflowEvent persist(WorkflowEvent event)

Saves the given WorkflowEvent

Parameters:

event -

Returns:

the persisted WorkflowEvent

readById

WorkflowEvent readById(Long id)

Reads a given WorkflowEvent by its internal id

Parameters:

id -

Returns:

the WorkflowEvent

readByIds

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

Reads several WorkflowEvents by the given internal ids

Parameters:

ids -

Returns:

the list of WorkflowEvents

readAllForSandBox

List<WorkflowEvent> readAllForSandBox(Long sandBoxId)

Reads all WorkflowEvents that are currently associated with the given sandbox

Parameters:

sandBoxId -

Returns:

the list of WorkflowEvents

delete

void delete(WorkflowEvent event)

Deletes the specified WorkflowEvent from the database

Parameters:

event -

readBySandBoxItems

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

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

Parameters:

sandBoxItemIds -

Returns:

the list of WorkflowEvents

readEntitiesBySandBoxItems

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

Reads the WorkflowEvents that are associated with the given WorkflowSandBoxItem ids

Parameters:

sandBoxItemIds -

Returns:

readAllIdsForSandBox

List<Long> readAllIdsForSandBox(Long sandBoxId)

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

Parameters:

sandBoxId -

Returns:

a list of WorkflowEvent ids

refresh

WorkflowEvent refresh(WorkflowEvent event)

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

Parameters:

event -

Returns:

the refreshed WorkflowEvent

readAllNotDeployedIdsForSandBox

List<Long> readAllNotDeployedIdsForSandBox(Long sandBoxId)

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

Parameters:

sandBoxId -

Returns:

a list of WorkflowEvent ids

readAllDeployInProgressIdsForSandBox

List<Long> readAllDeployInProgressIdsForSandBox(Long sandBoxId)

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

Parameters:

sandBoxId -

Returns:

persist

WorkflowDeployment persist(WorkflowDeployment deployment)

Saves the given WorkflowDeployment

Parameters:

deployment -

Returns:

the persisted WorkflowDeployment

updateApprovalStatus

void updateApprovalStatus(Long eventId)

Marks the given WorkflowEvent id as Approved but not scheduled.

Parameters:

eventId -

updateEventDeployment

void updateEventDeployment(Long eventId,
                           WorkflowDeployment deployment)

Associates the given WorkflowEvent id to the given WorkflowDeployment.

Parameters:

eventId -

deployment -

updateEventSetupStatus

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

Change the setup status for one or more WorkflowEvent instances.

Parameters:

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

status - arbitrary status - known values defined in WorkflowEventSetupStatus

updateEventSetupStatus

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

readDeploymentByJob

WorkflowDeployment readDeploymentByJob(Long jobId)

Reads a WorkflowDeployment instance that corresponds to the given job id

Parameters:

jobId -

Returns:

the WorkflowDeployment

readDeploymentById

WorkflowDeployment readDeploymentById(Long id)

Reads a WorkflowDeployment instance that corresponds to the given id

Parameters:

id -

Returns:

the WorkflowDeployment

startDeployment

void startDeployment(Long deploymentId)

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.

Parameters:

deploymentId -

finishDeployment

void finishDeployment(Long deploymentId)

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.

Parameters:

deploymentId -

readDeploymentsByEvents

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

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

Parameters:

events -

Returns:

the list of WorkflowDeployments

detach

void detach(WorkflowDeployment deployment)

Detaches the given WorkflowDeployment instance from the entity manager.

Parameters:

deployment -

merge

WorkflowEvent merge(WorkflowEvent event)

Saves the given WorkflowEvent

Parameters:

event -

Returns:

the merged WorkflowEvent

completeEvents

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.

Parameters:

sandBoxItemIds -

Returns:

resetEventsForApproval

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.

Parameters:

sandBoxItemIds -

Returns:

readEventIdsByDeployment

List<Long> readEventIdsByDeployment(Long deploymentId)

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

Parameters:

deploymentId -

Returns:

readAllFutureDeployments

List<WorkflowDeployment> readAllFutureDeployments()

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

Returns:

the list of WorkflowDeployments

removeDeployment

void removeDeployment(WorkflowDeployment deployment)

Deletes the specified WorkflowDeployment from the database

Parameters:

deployment -

readUnscheduledEventIdsByCriticalAndApprovalStatus

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

Parameters:

sandboxId -

isCritical -

isApproved -

Returns:

readUnscheduledEventIdsByApprovalStatus

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

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

Parameters:

sandboxId -

isApproved -

Returns: