RunScheduledBackgroundTask (Cyclos 4.15.15 Scripting API Documentation)

java.lang.Object
- org.cyclos.impl.AbstractServerComponent
- - org.cyclos.impl.AbstractGlobalServerComponent
  - - org.cyclos.impl.utils.tasks.AbstractTask
    - - org.cyclos.impl.utils.tasks.AbstractBackgroundTask
      - org.cyclos.impl.system.RunScheduledBackgroundTask

All Implemented Interfaces:

BackgroundTask, HasMessageKey
```
@Component
public class RunScheduledBackgroundTask
extends AbstractBackgroundTask
```
A BackgroundTask which executes a CustomScheduledTask

Field Summary
- Fields inherited from class org.cyclos.impl.utils.tasks.AbstractTask
  clusterHandler, errorLogService, invokerHandler, loggingHandler
- Fields inherited from class org.cyclos.impl.AbstractGlobalServerComponent
  rawEntityManagerHandler
- Fields inherited from class org.cyclos.impl.AbstractServerComponent
  accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors
Constructor Description

RunScheduledBackgroundTask()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected long`	`doExecute(String context)`	Must be implemented to actually execute the task logic, returning the number of affected records
`MessageKey`	`getMessageKey()`
`static BackgroundTaskScheduling`	`scheduling(CustomScheduledTask task)`

Methods inherited from class org.cyclos.impl.utils.tasks.AbstractBackgroundTask
execute, isVerbose, logName, runInEntityNetwork, runInNetwork

Methods inherited from class org.cyclos.impl.utils.tasks.AbstractTask
getLogConfiguration, getName, logTaskError, logTaskSuccess, resolveName, shouldGenerateErrorLog

Methods inherited from class org.cyclos.impl.AbstractGlobalServerComponent
getBaseEntityManagerHandler, getEntityManager

Methods inherited from class org.cyclos.impl.AbstractServerComponent
dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cyclos.impl.utils.tasks.BackgroundTask
getName

- Constructor Detail
  - RunScheduledBackgroundTask
```
public RunScheduledBackgroundTask()
```
- Method Detail
  - scheduling
```
public static BackgroundTaskScheduling scheduling(CustomScheduledTask task)
```
  - getMessageKey
```
public MessageKey getMessageKey()
```
  - doExecute
```
protected long doExecute(String context)
```
    Description copied from class: AbstractBackgroundTask
    
    Must be implemented to actually execute the task logic, returning the number of affected records
    
    Specified by:
    
    doExecute in class AbstractBackgroundTask