TaskDefinition (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsMetadata
  - - org.openmrs.scheduler.TaskDefinition

All Implemented Interfaces:

Auditable, OpenmrsMetadata, OpenmrsObject, Retireable
```
public class TaskDefinition
extends BaseOpenmrsMetadata
```
Represents the metadata for a task that can be scheduled.

Constructor Summary

Constructors
Constructor and Description
`TaskDefinition()` Default no-arg public constructor
`TaskDefinition(Integer id, String name, String description, String taskClass)` Public constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`getCreatedBy()` Deprecated. use `BaseOpenmrsMetadata.getCreator()`
`Integer`	`getId()` Get the task identifier.
`Date`	`getLastExecutionTime()` Get the time the task was last executed.
`Date`	`getNextExecutionTime()` Convenience method that asks SchedulerUtil for it's next execution time.
`Map<String,String>`	`getProperties()` Get the data map used to provide the task with runtime data.
`String`	`getProperty(String key)` Get task configuration property.
`Long`	`getRepeatInterval()` Gets the number of seconds until task is executed again.
`long`	`getSecondsUntilNextExecutionTime()` Convenience method to calculate the seconds until the next execution time.
`Boolean`	`getStarted()` Gets the flag that indicates whether the task has been started.
`Boolean`	`getStartOnStartup()` Gets the flag that indicates whether the task should startup as soon as the scheduler starts.
`Date`	`getStartTime()` Get the start time for when the task should be executed.
`String`	`getStartTimePattern()` Get the date format used to set the start time.
`String`	`getTaskClass()` Get the schedulable object to be executed.
`Task`	`getTaskInstance()` Gets the runnable task instance associated with this definition.
`int`	`hashCode()`
`void`	`setCreatedBy(User authenticatedUser)` Deprecated. use `BaseOpenmrsMetadata.setCreator(User)`
`void`	`setId(Integer id)` Set the task identifier.
`void`	`setLastExecutionTime(Date lastExecutionTime)` Set the time the task was last executed
`void`	`setProperties(Map<String,String> properties)` Set the properties of the task.
`void`	`setProperty(String key, String value)` Set task configuration property.
`void`	`setRepeatInterval(Long repeatInterval)` Sets the number of seconds until task is executed again.
`void`	`setStarted(Boolean started)` Sets the flag that indicates whether the task has been started.
`void`	`setStartOnStartup(Boolean startOnStartup)` Sets the flag that indicates whether the task should startup as soon as the scheduler starts.
`void`	`setStartTime(Date startTime)` Set the start time for when the task should be executed.
`void`	`setStartTimePattern(String pattern)` Sets the date format used to set the start time.
`void`	`setTaskClass(String taskClass)` Set the schedulable object to be executed.
`void`	`setTaskInstance(Task taskInstance)` Sets the runnable task instance associated with this definition.
`String`	`toString()`

Methods inherited from class org.openmrs.BaseOpenmrsMetadata
getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

Methods inherited from class org.openmrs.BaseOpenmrsObject
getUuid, setUuid

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

Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid

- Constructor Detail
  - TaskDefinition
```
public TaskDefinition()
```
    Default no-arg public constructor
  - TaskDefinition
```
public TaskDefinition(Integer id,
                      String name,
                      String description,
                      String taskClass)
```
    Public constructor
- Method Detail
  - getId
```
public Integer getId()
```
    Get the task identifier.
    
    Returns:
    
    Integer identifier of the task
  - setId
```
public void setId(Integer id)
```
    Set the task identifier.
    
    Parameters:
    
    id -
  - getProperties
```
public Map<String,String> getProperties()
```
    Get the data map used to provide the task with runtime data.
    
    Returns:
    
    the data map
  - setProperties
```
public void setProperties(Map<String,String> properties)
```
    Set the properties of the task. This overrides any properties previously set with the setProperty(String, String) method.
    
    Parameters:
    
    properties - Map of the properties to set
  - getTaskClass
```
public String getTaskClass()
```
    Get the schedulable object to be executed.
    
    Returns:
    
    the schedulable object
  - setTaskClass
```
public void setTaskClass(String taskClass)
```
    Set the schedulable object to be executed.
    
    Parameters:
    
    taskClass - String taskClass of a schedulable object
  - getStartTime
```
public Date getStartTime()
```
    Get the start time for when the task should be executed.
    
    Returns:
    
    long start time
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Set the start time for when the task should be executed. For instance, use "new Date()", if you want it to start now.
    
    Parameters:
    
    startTime - start time for the task
  - getLastExecutionTime
```
public Date getLastExecutionTime()
```
    Get the time the task was last executed.
    
    Returns:
    
    long last execution time
  - setLastExecutionTime
```
public void setLastExecutionTime(Date lastExecutionTime)
```
    Set the time the task was last executed
    
    Parameters:
    
    lastExecutionTime - last execution time
  - getRepeatInterval
```
public Long getRepeatInterval()
```
    Gets the number of seconds until task is executed again.
    
    Returns:
    
    long number of seconds.
  - setRepeatInterval
```
public void setRepeatInterval(Long repeatInterval)
```
    Sets the number of seconds until task is executed again.
    
    Parameters:
    
    repeatInterval - number of seconds, or 0 to indicate to repetition
  - getStartTimePattern
```
public String getStartTimePattern()
```
    Get the date format used to set the start time.
  - setStartTimePattern
```
public void setStartTimePattern(String pattern)
```
    Sets the date format used to set the start time.
  - getStartOnStartup
```
public Boolean getStartOnStartup()
```
    Gets the flag that indicates whether the task should startup as soon as the scheduler starts.
  - setStartOnStartup
```
public void setStartOnStartup(Boolean startOnStartup)
```
    Sets the flag that indicates whether the task should startup as soon as the scheduler starts.
  - getStarted
```
public Boolean getStarted()
```
    Gets the flag that indicates whether the task has been started.
  - setStarted
```
public void setStarted(Boolean started)
```
    Sets the flag that indicates whether the task has been started.
  - getProperty
```
public String getProperty(String key)
```
    Get task configuration property.
    
    Parameters:
    
    key - the String key of the property to get
    
    Returns:
    
    the String value for the given key
  - setProperty
```
public void setProperty(String key,
                        String value)
```
    Set task configuration property. Only supports strings at the moment.
    
    Parameters:
    
    key - the String key of the property to set
    
    value - the String value of the property to set
  - getNextExecutionTime
```
public Date getNextExecutionTime()
```
    Convenience method that asks SchedulerUtil for it's next execution time.
    
    Returns:
    
    the Date of the next execution
  - getSecondsUntilNextExecutionTime
```
public long getSecondsUntilNextExecutionTime()
```
    Convenience method to calculate the seconds until the next execution time.
    
    Returns:
    
    the number of seconds until the next execution
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - getTaskInstance
```
public Task getTaskInstance()
```
    Gets the runnable task instance associated with this definition.
    
    Returns:
    
    related task, or null if none instantiated (definition hasn't been scheduled)
  - setTaskInstance
```
public void setTaskInstance(Task taskInstance)
```
    Sets the runnable task instance associated with this definition. This should be set by the scheduler which instantiates the task.
    
    Parameters:
    
    taskInstance -
  - getCreatedBy
```
public Object getCreatedBy()
```
    Deprecated. use BaseOpenmrsMetadata.getCreator()
  - setCreatedBy
```
public void setCreatedBy(User authenticatedUser)
```
    Deprecated. use BaseOpenmrsMetadata.setCreator(User)

Class TaskDefinition

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Constructor Detail

TaskDefinition

TaskDefinition

Method Detail

getId

setId

getProperties

setProperties

getTaskClass

setTaskClass

getStartTime

setStartTime

getLastExecutionTime

setLastExecutionTime

getRepeatInterval

setRepeatInterval

getStartTimePattern

setStartTimePattern

getStartOnStartup

setStartOnStartup

getStarted

setStarted

getProperty

setProperty

getNextExecutionTime

getSecondsUntilNextExecutionTime

equals

hashCode

toString

getTaskInstance

setTaskInstance

getCreatedBy

setCreatedBy