org.jbpm.api.job
Interface Job

All Known Subinterfaces:
Message, Timer

public interface Job

base class for timers and messages.

Author:
Tom Baeyens

Method Summary
 java.util.Date getDuedate()
          Deprecated. call getDueDate() instead
 java.util.Date getDueDate()
          in case this is a timer, it is the time that the timer should fire, in case this is a message, it is null.
 java.lang.String getException()
          exception that occurred during the last execution of this job.
 Execution getExecution()
          the related execution
 java.lang.String getId()
          unique id for this job that is used as a reference in the service methods
 java.util.Date getLockExpirationTime()
           
 java.lang.String getLockOwner()
          job executor identification that has acquired this job and is going to execute it
 Execution getProcessInstance()
          the related process instance
 int getRetries()
          number of retries left.
 boolean isExclusive()
          indicates if this job should be executed separate from any other job in the same process instance
 

Method Detail

getId

java.lang.String getId()
unique id for this job that is used as a reference in the service methods


getLockOwner

java.lang.String getLockOwner()
job executor identification that has acquired this job and is going to execute it


getDueDate

java.util.Date getDueDate()
in case this is a timer, it is the time that the timer should fire, in case this is a message, it is null.


getDuedate

@Deprecated
java.util.Date getDuedate()
Deprecated. call getDueDate() instead

in case this is a timer, it is the time that the timer should fire, in case this is a message, it is null.


getException

java.lang.String getException()
exception that occurred during the last execution of this job. The transaction of the job execution is rolled back. A synchronization is used to create a separate transaction to update the exception and decrement the retries.


getRetries

int getRetries()
number of retries left. This is only decremented when an exception occurs during job execution. The transaction of the job execution is rolled back. A synchronization is used to create a separate transaction to update the exception and decrement the retries.


isExclusive

boolean isExclusive()
indicates if this job should be executed separate from any other job in the same process instance


getExecution

Execution getExecution()
the related execution


getProcessInstance

Execution getProcessInstance()
the related process instance


getLockExpirationTime

java.util.Date getLockExpirationTime()


Copyright © 2010 JBoss Community. All Rights Reserved.