CmmnManagementService (Flowable - CMMN API 6.4.2 API)

```
public interface CmmnManagementService
```
Author:

Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DeadLetterJobQuery`	`createDeadLetterJobQuery()` Returns a new DeadLetterJobQuery implementation, that can be used to query the dead letter jobs.
`HistoryJobQuery`	`createHistoryJobQuery()` Returns a new HistoryJobQuery implementation, that can be used to dynamically query the history jobs.
`JobQuery`	`createJobQuery()` Returns a new JobQuery implementation, that can be used to query the jobs.
`SuspendedJobQuery`	`createSuspendedJobQuery()` Returns a new SuspendedJobQuery implementation, that can be used to query the suspended jobs.
`TimerJobQuery`	`createTimerJobQuery()` Returns a new TimerJobQuery implementation, that can be used to query the timer jobs.
`void`	`deleteDeadLetterJob(String jobId)` Delete the dead letter job with the provided id.
`void`	`deleteJob(String jobId)` Delete the job with the provided id.
`void`	`deleteSuspendedJob(String jobId)` Delete the suspended job with the provided id.
`void`	`deleteTimerJob(String jobId)` Delete the timer job with the provided id.
`void`	`executeHistoryJob(String historyJobId)` Forced synchronous execution of a historyJob (eg.
`void`	`executeJob(String jobId)` Forced synchronous execution of a job (eg.
`String`	`getDeadLetterJobExceptionStacktrace(String jobId)` Returns the full stacktrace of the exception that occurs when the deadletter job with the given id was last executed.
`String`	`getJobExceptionStacktrace(String jobId)` Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.
`String`	`getSuspendedJobExceptionStacktrace(String jobId)` Returns the full stacktrace of the exception that occurs when the suspended with the given id was last executed.
`Map<String,Long>`	`getTableCounts()` Returns a map containing {tableName, rowCount} values.
`Collection<String>`	`getTableNames()` Returns all relational database tables of the engine.
`String`	`getTimerJobExceptionStacktrace(String jobId)` Returns the full stacktrace of the exception that occurs when the timer job with the given id was last executed.
`Job`	`moveDeadLetterJobToExecutableJob(String jobId, int retries)` Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries were probably 0 when it was put into the dead letter job table).
`Job`	`moveJobToDeadLetterJob(String jobId)` Moves a job to the dead letter job table (eg.
`Job`	`moveTimerToExecutableJob(String jobId)` Moves a timer job to the executable job table (eg.
`void`	`setJobRetries(String jobId, int retries)` Sets the number of retries that a job has left.
`void`	`setTimerJobRetries(String jobId, int retries)` Sets the number of retries that a timer job has left.

- Method Detail
  - getTableCounts
```
Map<String,Long> getTableCounts()
```
    Returns a map containing {tableName, rowCount} values.
  - getTableNames
```
Collection<String> getTableNames()
```
    Returns all relational database tables of the engine.
  - createJobQuery
```
JobQuery createJobQuery()
```
    Returns a new JobQuery implementation, that can be used to query the jobs.
  - createTimerJobQuery
```
TimerJobQuery createTimerJobQuery()
```
    Returns a new TimerJobQuery implementation, that can be used to query the timer jobs.
  - createSuspendedJobQuery
```
SuspendedJobQuery createSuspendedJobQuery()
```
    Returns a new SuspendedJobQuery implementation, that can be used to query the suspended jobs.
  - createDeadLetterJobQuery
```
DeadLetterJobQuery createDeadLetterJobQuery()
```
    Returns a new DeadLetterJobQuery implementation, that can be used to query the dead letter jobs.
  - executeJob
```
void executeJob(String jobId)
```
    Forced synchronous execution of a job (eg. for administration or testing). The job will be executed, even if the case instance is suspended.
    
    Parameters:
    
    jobId - id of the job to execute, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - moveTimerToExecutableJob
```
Job moveTimerToExecutableJob(String jobId)
```
    Moves a timer job to the executable job table (eg. for administration or testing). The timer job will be moved, even if the case instance is suspended.
    
    Parameters:
    
    jobId - id of the timer job to move, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - moveJobToDeadLetterJob
```
Job moveJobToDeadLetterJob(String jobId)
```
    Moves a job to the dead letter job table (eg. for administration or testing). The job will be moved, even if the case instance is suspended or there are retries left.
    
    Parameters:
    
    jobId - id of the job to move, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - moveDeadLetterJobToExecutableJob
```
Job moveDeadLetterJobToExecutableJob(String jobId,
                                     int retries)
```
    Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries were probably 0 when it was put into the dead letter job table).
    
    Parameters:
    
    jobId - id of the job to move, cannot be null.
    
    retries - the number of retries (value greater than 0) which will be set on the job.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - deleteJob
```
void deleteJob(String jobId)
```
    Delete the job with the provided id.
    
    Parameters:
    
    jobId - id of the job to delete, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - deleteTimerJob
```
void deleteTimerJob(String jobId)
```
    Delete the timer job with the provided id.
    
    Parameters:
    
    jobId - id of the timer job to delete, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - deleteSuspendedJob
```
void deleteSuspendedJob(String jobId)
```
    Delete the suspended job with the provided id.
    
    Parameters:
    
    jobId - id of the suspended job to delete, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - deleteDeadLetterJob
```
void deleteDeadLetterJob(String jobId)
```
    Delete the dead letter job with the provided id.
    
    Parameters:
    
    jobId - id of the dead letter job to delete, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no job with the given id.
  - setJobRetries
```
void setJobRetries(String jobId,
                   int retries)
```
    Sets the number of retries that a job has left. Whenever the JobExecutor fails to execute a job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again. In that case, this method can be used to increase the number of retries.
    
    Parameters:
    
    jobId - id of the job to modify, cannot be null.
    
    retries - number of retries.
  - setTimerJobRetries
```
void setTimerJobRetries(String jobId,
                        int retries)
```
    Sets the number of retries that a timer job has left. Whenever the JobExecutor fails to execute a timer job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again. In that case, this method can be used to increase the number of retries.
    
    Parameters:
    
    jobId - id of the timer job to modify, cannot be null.
    
    retries - number of retries.
  - getJobExceptionStacktrace
```
String getJobExceptionStacktrace(String jobId)
```
    Returns the full stacktrace of the exception that occurs when the job with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Parameters:
    
    jobId - id of the job, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when no job exists with the given id.
  - getTimerJobExceptionStacktrace
```
String getTimerJobExceptionStacktrace(String jobId)
```
    Returns the full stacktrace of the exception that occurs when the timer job with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Parameters:
    
    jobId - id of the job, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when no job exists with the given id.
  - getSuspendedJobExceptionStacktrace
```
String getSuspendedJobExceptionStacktrace(String jobId)
```
    Returns the full stacktrace of the exception that occurs when the suspended with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Parameters:
    
    jobId - id of the job, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when no job exists with the given id.
  - getDeadLetterJobExceptionStacktrace
```
String getDeadLetterJobExceptionStacktrace(String jobId)
```
    Returns the full stacktrace of the exception that occurs when the deadletter job with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Parameters:
    
    jobId - id of the job, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when no job exists with the given id.
  - createHistoryJobQuery
```
HistoryJobQuery createHistoryJobQuery()
```
    Returns a new HistoryJobQuery implementation, that can be used to dynamically query the history jobs.
  - executeHistoryJob
```
void executeHistoryJob(String historyJobId)
```
    Forced synchronous execution of a historyJob (eg. for administration or testing).
    
    Parameters:
    
    historyJobId - id of the historyjob to execute, cannot be null.
    
    Throws:
    
    FlowableObjectNotFoundException - when there is no historyJob with the given id.

Interface CmmnManagementService

Method Summary

Method Detail

getTableCounts

getTableNames

createJobQuery

createTimerJobQuery

createSuspendedJobQuery

createDeadLetterJobQuery

executeJob

moveTimerToExecutableJob

moveJobToDeadLetterJob

moveDeadLetterJobToExecutableJob

deleteJob

deleteTimerJob

deleteSuspendedJob

deleteDeadLetterJob

setJobRetries

setTimerJobRetries

getJobExceptionStacktrace

getTimerJobExceptionStacktrace

getSuspendedJobExceptionStacktrace

getDeadLetterJobExceptionStacktrace

createHistoryJobQuery

executeHistoryJob