Serialized Form

Package com.broadleafcommerce.scheduledjob.domain

Class com.broadleafcommerce.scheduledjob.domain.ScheduledJob

class ScheduledJob extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

The admin user who created this job

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

cron

String cron

A cron expression used to drive the schedule for the job execution.

details

List<ScheduledJobDetail> details

Collection of detailed information for the job

enabled

boolean enabled

Whether this scheduled job is enabled, thus allowing it to run.

executed

boolean executed

Whether this scheduled job has been executed.

id

String id

The context ID of the scheduled job.

lastExecuted

Instant lastExecuted

The date on which the job last executed.

manageInAdmin

boolean manageInAdmin

Whether or not the job can be managed through the Admin interface.

name

String name

Display name for this scheduled job.

previousLastExecuted

Instant previousLastExecuted

The previous date on which the job last executed. This is useful for jobs that need to communicate the previous date they executed on to external listeners since ScheduledJob.lastExecuted will already have been updated to the current execution date (i.e., now) by the time they receive the message.

Some jobs will use the date the job last executed in order to limit queries to entities that have been modified since then, such as checking which Product Tags have gone expired since the last time they were checked.

targetDate

Instant targetDate

The date on which a single use job should execute.

timingType

String timingType

The timing type of this scheduled job. Can be either based on a target date or recurring based on a cron expression.

trackExecutionDetails

boolean trackExecutionDetails

A flag to indicate whether the execution details of this scheduled-job should be tracked.

Set as false by default

type

String type

The type of this scheduled job, used to help identify and organize jobs that share a common origin.

updated

Instant updated

The date on which the job was last updated by a user.

Class com.broadleafcommerce.scheduledjob.domain.ScheduledJobExecutionDetail

class ScheduledJobExecutionDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

A map to hold additional information on the execution detail

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

endTime

Instant endTime

The time at which the scheduled job finishes execution

errorMessage

String errorMessage

The error message if any to set on the execution detail. In case of an unsuccessful execution, it will be set with error information about the job execution

executionId

String executionId

The context ID of the execution detail

jobId

String jobId

The ID of the scheduled job for which this execution detail is created

lastUpdatedTime

Instant lastUpdatedTime

The time at which the scheduled job is last updated

noteMessage

String noteMessage

The execution note/message to be set on the execution detail. In case of a successful execution, it will be set with information about the job execution

startTime

Instant startTime

The time at which the scheduled job starts execution

status

String status

The execution status of the scheduled job

See Also:

• ScheduledJobExecutionStatus

triggerTime

Instant triggerTime

The time at which the scheduled job is triggered

Package com.broadleafcommerce.scheduledjob.provider.jpa.domain

Class com.broadleafcommerce.scheduledjob.provider.jpa.domain.JpaScheduledJob

class JpaScheduledJob extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

See Also:

• ScheduledJob.getAuthor()

contextId

String contextId

cron

String cron

See Also:

• ScheduledJob.getCron()

details

List<JpaScheduledJobDetail> details

See Also:

• ScheduledJob.getDetails()

enabled

boolean enabled

See Also:

• ScheduledJob.isEnabled()

executed

boolean executed

See Also:

• ScheduledJob.isExecuted()

lastExecuted

Instant lastExecuted

See Also:

• ScheduledJob.getLastExecuted()

manageInAdmin

boolean manageInAdmin

See Also:

• ScheduledJob.isManageInAdmin()

name

String name

See Also:

• ScheduledJob.getName()

previousLastExecuted

Instant previousLastExecuted

See Also:

• ScheduledJob.getPreviousLastExecuted()

targetDate

Instant targetDate

See Also:

• ScheduledJob.getTargetDate()

timingType

String timingType

See Also:

• ScheduledJob.getTimingType()

trackExecutionDetails

boolean trackExecutionDetails

See Also:

• ScheduledJob.isTrackExecutionDetails()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

See Also:

• TenantJpaTracking

type

String type

See Also:

• ScheduledJob.getType()

updated

Instant updated

See Also:

• ScheduledJob.getUpdated()

Class com.broadleafcommerce.scheduledjob.provider.jpa.domain.JpaScheduledJobDetail

class JpaScheduledJobDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

job

JpaScheduledJob job

name

String name

See Also:

• ScheduledJobDetail.getName()

value

String value

Stores the scheduled job detail value serialized as a JSON string in the data store.

Generally speaking, callers should use JpaScheduledJobDetail.getValue() and JpaScheduledJobDetail.setValue(String) and not directly deal with this field. In rare circumstances (like a custom CriteriaQuery), it may make sense to directly access this value.

Rather than simply annotating the column with the @Convert annotation, we have different methods that manually invoke the ScheduledJobDetailValueConverter. This is because automatic conversion sometimes has problems with CriteriaQuery and CriteriaUpdate.

See Also:

• ScheduledJobDetail.getRawValue()

valueSha

String valueSha

Class com.broadleafcommerce.scheduledjob.provider.jpa.domain.JpaScheduledJobDetailId

class JpaScheduledJobDetailId extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

job

String job

See Also:

• JpaScheduledJobDetail.job

name

String name

See Also:

• JpaScheduledJobDetail.name

valueSha

String valueSha

See Also:

• JpaScheduledJobDetail.valueSha

Class com.broadleafcommerce.scheduledjob.provider.jpa.domain.JpaScheduledJobExecutionDetail

class JpaScheduledJobExecutionDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

See Also:

• ScheduledJobExecutionDetail.getAttributes()

contextId

String contextId

See Also:

• ScheduledJobExecutionDetail.getExecutionId()

endTime

Instant endTime

See Also:

• ScheduledJobExecutionDetail.getEndTime()

errorMessage

String errorMessage

See Also:

• ScheduledJobExecutionDetail.getErrorMessage()

jobId

String jobId

See Also:

• ScheduledJobExecutionDetail.getJobId()

lastUpdatedTime

Instant lastUpdatedTime

See Also:

• ScheduledJobExecutionDetail.getLastUpdatedTime()

noteMessage

String noteMessage

See Also:

• ScheduledJobExecutionDetail.getNoteMessage()

startTime

Instant startTime

See Also:

• ScheduledJobExecutionDetail.getStartTime()

status

String status

See Also:

• ScheduledJobExecutionDetail.getStatus()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

the TenantJpaTracking information

triggerTime

Instant triggerTime

See Also:

• ScheduledJobExecutionDetail.getTriggerTime()

Package com.broadleafcommerce.scheduledjob.web.endpoint.exception

Exception com.broadleafcommerce.scheduledjob.web.endpoint.exception.DeleteScheduledJobException

class DeleteScheduledJobException extends RuntimeException implements Serializable