WorkflowScheduler (Engine 5.0.0 API)

java.lang.Object
- org.imixs.workflow.engine.WorkflowScheduler

All Implemented Interfaces:

Scheduler
```
public class WorkflowScheduler
extends Object
implements Scheduler
```
This EJB implements a Imixs Scheduler Interface and scans workitems for scheduled activities.
The configuration of the scheduler is based on the Imixs Scheduler API.

Version:

1.0

Author:

rsoika

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NAME`
`static int`	`OFFSET_DAYS`
`static int`	`OFFSET_HOURS`
`static int`	`OFFSET_MINUTES`
`static int`	`OFFSET_SECONDS`
`static int`	`OFFSET_WORKDAYS`

Fields inherited from interface org.imixs.workflow.engine.scheduler.Scheduler
ITEM_ERRORMESSAGE, ITEM_LOGMESSAGE, ITEM_SCHEDULER_CLASS, ITEM_SCHEDULER_DEFINITION, ITEM_SCHEDULER_ENABLED, ITEM_SCHEDULER_NAME, ITEM_SCHEDULER_STATUS

Constructor Summary

Constructors
Constructor and Description

WorkflowScheduler()

Constructors
Constructor and Description
`WorkflowScheduler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Calendar`	`addWorkDays(Calendar baseDate, int days)` This method adds workdays (MONDAY - FRIDAY) to a given calendar object.
`ItemCollection`	`run(ItemCollection configItemCollection)` This method process scheduled workitems.
`boolean`	`workItemInDue(ItemCollection doc, ItemCollection docActivity)` This method checks if a workitem (doc) is in due.

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

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - OFFSET_SECONDS
```
public static final int OFFSET_SECONDS
```
    See Also:
    
    Constant Field Values
  - OFFSET_MINUTES
```
public static final int OFFSET_MINUTES
```
    See Also:
    
    Constant Field Values
  - OFFSET_HOURS
```
public static final int OFFSET_HOURS
```
    See Also:
    
    Constant Field Values
  - OFFSET_DAYS
```
public static final int OFFSET_DAYS
```
    See Also:
    
    Constant Field Values
  - OFFSET_WORKDAYS
```
public static final int OFFSET_WORKDAYS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WorkflowScheduler
```
public WorkflowScheduler()
```
- Method Detail
  - workItemInDue
```
public boolean workItemInDue(ItemCollection doc,
                             ItemCollection docActivity)
```
    This method checks if a workitem (doc) is in due. There are 4 different cases which will be compared: The case is determined by the keyScheduledBaseObject of the activity entity Basis : keyScheduledBaseObject "last process"=1, "last Modification"=2 "Creation"=3 "Field"=4 The logic is not the best one but it works. So we are open for any kind of improvements
    
    Returns:
    
    true if workitem is is due
  - addWorkDays
```
public Calendar addWorkDays(Calendar baseDate,
                            int days)
```
    This method adds workdays (MONDAY - FRIDAY) to a given calendar object. If the number of days is negative than this method subtracts the working days from the calendar object.
    
    Parameters:
    
    cal -
    
    days -
    
    Returns:
    
    new calendar instance
  - run
```
public ItemCollection run(ItemCollection configItemCollection)
                   throws SchedulerException
```
    This method process scheduled workitems. The method updates the property 'datLastRun' Because of bug: https://java.net/jira/browse/GLASSFISH-20673 we check the imixsDayOfWeek
    
    Specified by:
    
    run in interface Scheduler
    
    Parameters:
    
    timer -
    
    Returns:
    
    updated scheduler configuration
    
    Throws:
    
    AccessDeniedException
    
    SchedulerException

Class WorkflowScheduler

Field Summary

Fields inherited from interface org.imixs.workflow.engine.scheduler.Scheduler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

OFFSET_SECONDS

OFFSET_MINUTES

OFFSET_HOURS

OFFSET_DAYS

OFFSET_WORKDAYS

Constructor Detail

WorkflowScheduler

Method Detail

workItemInDue

addWorkDays

run