WorkflowSchedulerService (Engine 4.0.4 API)

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

```
@DeclareRoles(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
 @RunAs(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
public class WorkflowSchedulerService
extends Object
```
This EJB implements a TimerService which scans workitems for scheduled activities. The component will be later become part of the imixs workflow engine The configuration of the timer is stored by this ejb through the method saveConfiguration(); The configuration is stored as an entity from the type = 'configuration' and the txtName = '"org.imixs.marty.workflow.scheduler'. The method processSingleWorkitem() is used to process a workitem in an isolated transaction. See: http://blog.imixs.org/?p=155

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`
`static String`	`TYPE_CONFIGURATION`

Constructor Summary

Constructors
Constructor and Description

WorkflowSchedulerService()

Constructors
Constructor and Description
`WorkflowSchedulerService()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Calendar`	`addWorkDays(Calendar baseDate, int days)` This method adds workdays (MONDAY - FRIDAY) to a given calendar object.
`boolean`	`isRunning()` Returns true if the workflowSchedulerService was started
`ItemCollection`	`loadConfiguration()` This method loads the current scheduler configuration.
`void`	`processSingleWorkitem(ItemCollection aWorkitem)` This method process a single workIten in a new transaction.
`ItemCollection`	`saveConfiguration(ItemCollection configItemCollection)` This method saves the timer configuration.
`ItemCollection`	`start()` This Method starts the TimerService.
`ItemCollection`	`stop()` Stops a running timer instance.
`static 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
  - TYPE_CONFIGURATION
```
public static final String TYPE_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - 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
  - WorkflowSchedulerService
```
public WorkflowSchedulerService()
```
- Method Detail
  - loadConfiguration
```
public ItemCollection loadConfiguration()
```
    This method loads the current scheduler configuration. If no configuration entity yet exists the method returns an empty ItemCollection. The method updates the timer details for a running timer.
    
    Returns:
    
    configuration ItemCollection
  - saveConfiguration
```
public ItemCollection saveConfiguration(ItemCollection configItemCollection)
                                 throws AccessDeniedException
```
    This method saves the timer configuration. The method ensures that the following properties are set to default.
    - type
    - txtName
    - $writeAccess
    - $readAccess
    The method also updates the timer details of a running timer.
    Returns:
    
    Throws:
    
    AccessDeniedException
  - start
```
public ItemCollection start()
                     throws AccessDeniedException,
                            ParseException
```
    This Method starts the TimerService. The Timer can be started based on a Calendar setting stored in the property txtConfiguration, or by interval based on the properties datStart, datStop, numIntervall. The method loads the configuration entity and evaluates the timer configuration. THe $UniqueID of the configuration entity is the id of the timer to be controlled. $uniqueid - String - identifier for the Timer Service. txtConfiguration - calendarBasedTimer configuration datstart - Date Object datstop - Date Object numInterval - Integer Object (interval in seconds) The method throws an exception if the configuration entity contains invalid attributes or values. After the timer was started the configuration is updated with the latest statusmessage The method returns the current configuration
    
    Throws:
    
    AccessDeniedException
    
    ParseException
  - stop
```
public ItemCollection stop()
                    throws AccessDeniedException
```
    Stops a running timer instance. After the timer was canceled the configuration will be updated.
    
    Throws:
    
    AccessDeniedException
  - isRunning
```
public boolean isRunning()
```
    Returns true if the workflowSchedulerService was started
  - workItemInDue
```
public static 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 static 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
  - processSingleWorkitem
```
public void processSingleWorkitem(ItemCollection aWorkitem)
                           throws AccessDeniedException,
                                  ProcessingErrorException,
                                  PluginException
```
    This method process a single workIten in a new transaction. The method is called by processWorklist()
    
    Parameters:
    
    aWorkitem -
    
    Throws:
    
    PluginException
    
    ProcessingErrorException
    
    AccessDeniedException

Class WorkflowSchedulerService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_CONFIGURATION

NAME

OFFSET_SECONDS

OFFSET_MINUTES

OFFSET_HOURS

OFFSET_DAYS

OFFSET_WORKDAYS

Constructor Detail

WorkflowSchedulerService

Method Detail

loadConfiguration

saveConfiguration

start

stop

isRunning

workItemInDue

addWorkDays

processSingleWorkitem