Package com.broadleafcommerce.scheduledjob.service

Interface ScheduledJobExecutionDetailService<T extends ScheduledJobExecutionDetail>

All Superinterfaces:

com.broadleafcommerce.data.tracking.core.service.CrudEntityService<T>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<T>

All Known Implementing Classes:

DefaultScheduledJobExecutionDetailService

public interface ScheduledJobExecutionDetailService<T extends ScheduledJobExecutionDetail>
extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<T>

Service responsible for functionality related to ScheduledJobExecutionDetail

Since:

Scheduled Job Service 2.1.4, Release Train 2.1.4, Scheduled Job Service 2.2.0, Release Train 2.2.0

Author:

karanjariwala

Method Summary

Modifier and Type	Method	Description
org.springframework.data.domain.Page<T>	readAllByScheduledJobId(String scheduledJobId, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads a paged list of ScheduledJobExecutionDetail by its scheduledJobId
T	readLastExecutedScheduledJobExecutionDetailByJobIdAndStatus(String jobId, String executionStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Finds the most recent ScheduledJobExecutionDetail with the given scheduledJobId and executionStatus
T	updateScheduledJobExecutionDetailStatusAndTime(String contextId, ScheduledJobExecutionStatus status, ScheduledJobExecutionDetailTimingType scheduledJobExecutionDetailTimingType, Instant time, ScheduledJobExecutionDetailMessageType messageType, String message, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Updates the ScheduledJobExecutionDetail with the supplied values of status, time and message

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

readAll, readAll, readAll, readAll

Method Details

readAllByScheduledJobId

org.springframework.data.domain.Page<T> readAllByScheduledJobId(String scheduledJobId,
 @Nullable
 org.springframework.data.domain.Pageable page,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Reads a paged list of ScheduledJobExecutionDetail by its scheduledJobId

Parameters:

scheduledJobId - the scheduledJobId by which the executionDetails are to be fetched

page - the requested page of results from the database

contextInfo - the context info

Returns:

a paged list of ScheduledJobExecutionDetail by its scheduledJobId

readLastExecutedScheduledJobExecutionDetailByJobIdAndStatus

T readLastExecutedScheduledJobExecutionDetailByJobIdAndStatus(String jobId,
 String executionStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Finds the most recent ScheduledJobExecutionDetail with the given scheduledJobId and executionStatus

Parameters:

jobId - the ID of the scheduledJob by which the executionDetail is to be fetched

executionStatus - the status of the scheduledJob by which the executionDetail is to be fetched

contextInfo - the context info

Returns:

the ScheduledJobExecutionDetail

updateScheduledJobExecutionDetailStatusAndTime

T updateScheduledJobExecutionDetailStatusAndTime(String contextId,
 ScheduledJobExecutionStatus status,
 ScheduledJobExecutionDetailTimingType scheduledJobExecutionDetailTimingType,
 Instant time,
 @Nullable
 ScheduledJobExecutionDetailMessageType messageType,
 @Nullable
 String message,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Updates the ScheduledJobExecutionDetail with the supplied values of status, time and message

Parameters:

contextId - the ID of the ScheduledJobExecutionDetail to update

status - the status to update the detail to

scheduledJobExecutionDetailTimingType - the time field to update

time - the value of time to update to

messageType - the message field to update

message - the value of the message to update to

contextInfo - the context info

Returns:

the updated JpaScheduledJobExecutionDetail