QuartzJob (Bropen Framework 4.8.1 API)

bropen.framework.plugins.quartz.QuartzJob

All Implemented Interfaces and Traits:

DomainTrait
```
class QuartzJob
extends Object
```
定时任务：通过 Job 类自动生成、或在 Web 端创建的脚本任务
下列属性直接取自 Job 类的属性：
- domain: 当 job.scope = SCOPE_DOM 时，自动计算当前域
- application: 当 job.scope = SCOPE_APP 或默认情况，自动计算当前应用
- lock: 等于 job.lock，默认为 LOCK_NONE
- lockTimeout: 等于 job.lockTimeout，默认为 DEFAULT_LOCK_TIMEOUT，默认 2 小时
- lockRelease: 等于 job.lockRelease，默认为 true
- group: 等于 job.group，默认为 GrailsJobClassConstants.DEFAULT_GROUP
- name: 等于 job.name，默认等于类全名的 i18n

Field Summary

Fields
Modifiers	Name	Description
`static Object`	`CLAZZ_SCRIPTJOB`
`static Integer`	`DEFAULT_LOCK_TIMEOUT`
`static List<String>`	`LIST_LOCKS`	锁策略可选列表
`static String`	`LOCK_ALL`	锁策略：只允许运行一个实例
`static String`	`LOCK_ALL_GROUP`	锁策略：同一个组中，只允许运行一个实例
`static String`	`LOCK_APP`	锁策略：同一个应用中，只允许运行一个实例
`static String`	`LOCK_APP_GROUP`	锁策略：同一个应用的同一个组中，只允许运行一个实例
`static String`	`LOCK_DOM`	锁策略：同一个域中，只允许运行一个实例
`static String`	`LOCK_DOM_GROUP`	锁策略：同一个域的同一个组中，只允许运行一个实例
`static String`	`LOCK_NONE`	锁策略：不加锁
`static String`	`SCOPE_APP`
`static String`	`SCOPE_DOM`
`static String`	`SCOPE_GLOBAL`

Properties Summary

Properties
Type	Name and description
`DomainApplication`	`application` 所属应用
`String`	`clazz` 任务类
`static Object`	`constraints`
`String`	`createdBy`
`Date`	`dateCreated` 时间戳...
`Boolean`	`disabled` 是否禁用
`Domain`	`domain` 所属域
`String`	`groovyScript` 脚本：直接通过UI自建的任务，此时 clazz 固定为 #CLAZZ_SCRIPTJOB
`String`	`group` 任务组
`static Object`	`hasMany`
`Date`	`lastUpdated`
`static Map`	`listFields`
`String`	`lock` 锁策略
`String`	`lockOrig` 备份自Job类的锁策略
`Boolean`	`lockRelease` 执行完毕后是否释放锁：不释放的话，可避免由于各节点所在服务器时间不一致导致的重复执行
`Integer`	`lockTimeout` 锁有效期（默认为2h）
`static Object`	`mapping`
`String`	`name` 任务显示名
`String`	`notes`
`static Object`	`transients`
`Set<QuartzJobTrigger>`	`triggers` 触发器
`String`	`updatedBy`

Methods Summary

Methods
Type	Name and description
`Class`	`getJobClass()`
`static Class`	`getJobClass(Long id, String clazz)`
`String`	`getJobClassName()`
`static String`	`getJobClassName(Long id, String clazz)`
`String`	`getJobGroup()`
`String`	`getJobName()`
`static String`	`getJobName(Long id, String clazz)`
`static Long`	`getScriptJobId(String jobClassName)`
`static Boolean`	`isScriptJob(String jobClassName)`
`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`Object#wait(long, int), Object#wait(long), Object#wait(), Object#equals(Object), Object#toString(), Object#hashCode(), Object#getClass(), Object#notify(), Object#notifyAll()`

- Field Detail
  - public static final Object CLAZZ_SCRIPTJOB
  - public static final Integer DEFAULT_LOCK_TIMEOUT
  - public static final List<String> LIST_LOCKS
    
    锁策略可选列表
  - public static final String LOCK_ALL
    
    锁策略：只允许运行一个实例
  - public static final String LOCK_ALL_GROUP
    
    锁策略：同一个组中，只允许运行一个实例
  - public static final String LOCK_APP
    
    锁策略：同一个应用中，只允许运行一个实例
  - public static final String LOCK_APP_GROUP
    
    锁策略：同一个应用的同一个组中，只允许运行一个实例
  - public static final String LOCK_DOM
    
    锁策略：同一个域中，只允许运行一个实例
  - public static final String LOCK_DOM_GROUP
    
    锁策略：同一个域的同一个组中，只允许运行一个实例
  - public static final String LOCK_NONE
    
    锁策略：不加锁
  - public static final String SCOPE_APP
  - public static final String SCOPE_DOM
  - public static final String SCOPE_GLOBAL
- Property Detail
  - DomainApplication application
    
    所属应用
  - String clazz
    
    任务类
  - static Object constraints
  - String createdBy
  - Date dateCreated
    
    时间戳...
  - Boolean disabled
    
    是否禁用
  - Domain domain
    
    所属域
  - String groovyScript
    
    脚本：直接通过UI自建的任务，此时 clazz 固定为 #CLAZZ_SCRIPTJOB
  - String group
    
    任务组
  - static Object hasMany
  - Date lastUpdated
  - static Map listFields
  - String lock
    
    锁策略
  - String lockOrig
    
    备份自Job类的锁策略
  - Boolean lockRelease
    
    执行完毕后是否释放锁：不释放的话，可避免由于各节点所在服务器时间不一致导致的重复执行
  - Integer lockTimeout
    
    锁有效期（默认为2h）
  - static Object mapping
  - String name
    
    任务显示名
  - String notes
  - static Object transients
  - Set<QuartzJobTrigger> triggers
    
    触发器
  - String updatedBy
- Method Detail
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic Class getJobClass()
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Class getJobClass(Long id, String clazz)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic String getJobClassName()
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static String getJobClassName(Long id, String clazz)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic String getJobGroup()
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic String getJobName()
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static String getJobName(Long id, String clazz)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic @Internal@bropen.toolkit.annotation.Internal static Long getScriptJobId(String jobClassName)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic @Internal@bropen.toolkit.annotation.Internal static Boolean isScriptJob(String jobClassName)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic String toString()

| Detail:
Field
Property
Constructor
Method

BROPEN Documentation, 2020-04-21 11:00

[Groovy] Class QuartzJob

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final Object CLAZZ_SCRIPTJOB

public static final Integer DEFAULT_LOCK_TIMEOUT

public static final List<String> LIST_LOCKS

public static final String LOCK_ALL

public static final String LOCK_ALL_GROUP

public static final String LOCK_APP

public static final String LOCK_APP_GROUP

public static final String LOCK_DOM

public static final String LOCK_DOM_GROUP

public static final String LOCK_NONE

public static final String SCOPE_APP

public static final String SCOPE_DOM

public static final String SCOPE_GLOBAL

Property Detail

DomainApplication application

String clazz

static Object constraints

String createdBy

Date dateCreated

Boolean disabled

Domain domain

String groovyScript

String group

static Object hasMany

Date lastUpdated

static Map listFields

String lock

String lockOrig

Boolean lockRelease

Integer lockTimeout

static Object mapping

String name

String notes

static Object transients

Set<QuartzJobTrigger> triggers

String updatedBy

Method Detail

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic Class getJobClass()

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Class getJobClass(Long id, String clazz)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic String getJobClassName()

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static String getJobClassName(Long id, String clazz)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic String getJobGroup()

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic String getJobName()

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static String getJobName(Long id, String clazz)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic @Internal@bropen.toolkit.annotation.Internal static Long getScriptJobId(String jobClassName)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic @Internal@bropen.toolkit.annotation.Internal static Boolean isScriptJob(String jobClassName)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic String toString()