de.hybris.platform.servicelayer.cronjob

Class AbstractJobPerformable<T extends CronJobModel>

java.lang.Object

de.hybris.platform.servicelayer.cronjob.AbstractJobPerformable<T>

All Implemented Interfaces:

JobPerformable<T>

Direct Known Subclasses:

AbstractChangeProcessorJobPerformable, AbstractIndexerJob, BtgResultCleaningJob, CartToOrderJob, ChangeDetectionJobPerformable, DataLoaderJob, DataLoaderStopJob, DataSupplierJobPerformable, GeocodingJob, LDIFGroupImportJobPerformable, LDIFImportJobPerformable, OrderScheduleJob, OrderTemplateToOrderJob, SessionEventsRemovalJob, SolrExtIndexerJob, SolrQueryStatisticsCollectorJob, UpdateSynonymsJob, Y2YSyncMasterJobPerformable

public abstract class AbstractJobPerformable<T extends CronJobModel>
extends Object
implements JobPerformable<T>

Abstract implementation of JobPerformable interface providing ModelService and SessionService as a member.

Field Summary

Fields

Modifier and Type	Field and Description
protected FlexibleSearchService	flexibleSearchService
protected ModelService	modelService
protected SessionService	sessionService

Constructor Summary

Constructors

Constructor and Description
AbstractJobPerformable()

Method Summary

Modifier and Type	Method and Description
protected boolean	clearAbortRequestedIfNeeded(T myCronJob) Checks if given CronJobModel has a CronJobModel.REQUESTABORT flag set true -abort request was send for this cron job.
boolean	isAbortable() Checks whether the execution is implemented abortable.
boolean	isPerformable() Checks whether the execution can be performed at the moment.
abstract PerformResult	perform(T cronJob) The execution body for a ServicelayerJob.
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setModelService(ModelService modelService)
void	setSessionService(SessionService sessionService)

Methods inherited from class java.lang.Object

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

Field Detail

modelService

protected ModelService modelService

sessionService

protected SessionService sessionService

flexibleSearchService

protected FlexibleSearchService flexibleSearchService

Constructor Detail

AbstractJobPerformable

public AbstractJobPerformable()

Method Detail

perform

public abstract PerformResult perform(T cronJob)

Description copied from interface: JobPerformable

The execution body for a ServicelayerJob. Implement here your execution logic. It can be called synchronous or asynchronous. So be aware of thread-safety. Method will return a result object saying if the execution has reached end and if it was successful.

Specified by:

perform in interface JobPerformable<T extends CronJobModel>

Parameters:

cronJob - the related CronJob in whose context the execution will be performed.

Returns:

a PerformResult that indicates whether the execution was successfully executed or not and has finished or not.

isAbortable

public boolean isAbortable()

Description copied from interface: JobPerformable

Checks whether the execution is implemented abortable.

Specified by:

isAbortable in interface JobPerformable<T extends CronJobModel>

Returns:

true if the execution can be aborted

isPerformable

public boolean isPerformable()

Description copied from interface: JobPerformable

Checks whether the execution can be performed at the moment.

Specified by:

isPerformable in interface JobPerformable<T extends CronJobModel>

Returns:

true if the execution is ready

setModelService

public void setModelService(ModelService modelService)

setSessionService

public void setSessionService(SessionService sessionService)

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

clearAbortRequestedIfNeeded

protected final boolean clearAbortRequestedIfNeeded(T myCronJob)

Checks if given CronJobModel has a CronJobModel.REQUESTABORT flag set true -abort request was send for this cron job. If so then resets this flag to null and returns true. If no abort request abort was send returns false.