QueueTask (Spikeify Taskqueue 0.2.20 API)

java.lang.Object
- com.spikeify.taskqueue.entities.QueueTask

```
public class QueueTask
extends Object
```
Entity holding a task to be stored/retrieved in/from Aerospike database

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`className` java class name
`protected long`	`createTime` time stamp when task was created/added to the queue
`protected long`	`endTime` time task finished
`protected Long`	`executionTime` Execution time ...
`protected Integer`	`generation`
`protected String`	`job` to JSON string serialized task
`protected Long`	`jobRunTime` Time job took to execute (pure job execution time) from: running to: success/fail is null when not run is != null if run (shows last execution run time)
`protected String`	`lockFilter` Joined values of QueueName + locked state to enable filtering
`protected String`	`queue` queue name
`protected int`	`runCount` count of tasks runs 0 - tasks was never run, 1 - task was run once, 2 - run once / and once retried ...
`protected long`	`startTime` time task was started
`protected TaskState`	`state` internal task state ...
`protected String`	`stateFilter` Joined values of QueueName + TaskState to enable filtering
`protected long`	`updateTime` time stamp when task was last updated

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QueueTask()` For Spikeify only
	`QueueTask(Job newJob, String queueName)` Creates new queue task entity holding a task to be stored into database

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getClassName()`
`Long`	`getCreateTime()`
`long`	`getEndTime()`
`Long`	`getExecutionTime()`
`String`	`getId()`
`Job`	`getJob()` Creates instance of task object from JSON task and className (task class must be serializable/deserializable from to JSON string)
`Long`	`getJobRunTime()`
`static String`	`getLockedFilter(String queueName, boolean locked)` Utility method to get correct filter for equals filtering searching for open/closed tasks
`String`	`getQueue()`
`int`	`getRunCount()`
`long`	`getStartTime()`
`TaskState`	`getState()`
`static String`	`getStateFilter(String queueName, TaskState taskState)` Utility method to get correct filter for equals filtering searching for task state
`Long`	`getUpdateTime()`
`boolean`	`isLocked()`
`boolean`	`isOlderThan(int ageInMinutes)` Compares last update time with current time ...
`boolean`	`isOlderThanSeconds(int ageInSeconds)` Compares last update time with current time ...
`void`	`setState(TaskState newState)` Change the tasks state when started, failed of finished
`String`	`toString()`
`protected void`	`updateFilter()` Filter is composed of queue name and locked state this allows filtering of tasks per queue and state, for instance: - get all queued or failed tasks for default queue - get all running or finished tasks for "my" queue ...

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

- Field Detail
  - generation
```
protected Integer generation
```
  - queue
```
protected String queue
```
    queue name
  - job
```
protected String job
```
    to JSON string serialized task
  - className
```
protected String className
```
    java class name
  - createTime
```
protected long createTime
```
    time stamp when task was created/added to the queue
  - updateTime
```
protected long updateTime
```
    time stamp when task was last updated
  - startTime
```
protected long startTime
```
    time task was started
  - endTime
```
protected long endTime
```
    time task finished
  - executionTime
```
protected Long executionTime
```
    Execution time ... from creation until successful or failed finish is null when not finished jet (also when failed) is != null when finished or failed (locked)
  - jobRunTime
```
protected Long jobRunTime
```
    Time job took to execute (pure job execution time) from: running to: success/fail is null when not run is != null if run (shows last execution run time)
  - state
```
protected TaskState state
```
    internal task state ... execution progress
  - runCount
```
protected int runCount
```
    count of tasks runs 0 - tasks was never run, 1 - task was run once, 2 - run once / and once retried ... use in combination with state to determine general task state
  - stateFilter
```
protected String stateFilter
```
    Joined values of QueueName + TaskState to enable filtering
  - lockFilter
```
protected String lockFilter
```
    Joined values of QueueName + locked state to enable filtering
- Constructor Detail
  - QueueTask
```
protected QueueTask()
```
    For Spikeify only
  - QueueTask
```
public QueueTask(Job newJob,
                 String queueName)
```
    Creates new queue task entity holding a task to be stored into database
    
    Parameters:
    
    newJob - task to be stored
    
    queueName - name of queue to put task into
- Method Detail
  - getJob
```
public Job getJob()
```
    Creates instance of task object from JSON task and className (task class must be serializable/deserializable from to JSON string)
    
    Returns:
    
    Task to be executed ...
  - getId
```
public String getId()
```
    Returns:
    
    unique task id
  - getClassName
```
public String getClassName()
```
    Returns:
    
    class executing the task
  - getStartTime
```
public long getStartTime()
```
    Returns:
    
    time task has been started
  - getEndTime
```
public long getEndTime()
```
    Returns:
    
    time task has ended / succesfully or failed
  - getCreateTime
```
public Long getCreateTime()
```
    Returns:
    
    time stamp task was created
  - getUpdateTime
```
public Long getUpdateTime()
```
    Returns:
    
    last time task was updated (change of state)
  - getJobRunTime
```
public Long getJobRunTime()
```
    Returns:
    
    null or duration in milliseconds job took to execute
  - getExecutionTime
```
public Long getExecutionTime()
```
    Returns:
    
    null or duration in milliseconds task took from being added to the queue till finished
  - getState
```
public TaskState getState()
```
    Returns:
    
    current task state
  - getQueue
```
public String getQueue()
```
    Returns:
    
    name of queue task was put in
  - setState
```
public void setState(TaskState newState)
```
    Change the tasks state when started, failed of finished
    
    Parameters:
    
    newState - to put task into. If transition is not possible set is ignored!
  - getRunCount
```
public int getRunCount()
```
    Returns:
    
    number of task executions
  - isLocked
```
public boolean isLocked()
```
    Returns:
    
    true if task is locked (can not be modified)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - updateFilter
```
protected void updateFilter()
```
    Filter is composed of queue name and locked state this allows filtering of tasks per queue and state, for instance: - get all queued or failed tasks for default queue - get all running or finished tasks for "my" queue ...
  - getLockedFilter
```
public static String getLockedFilter(String queueName,
                                     boolean locked)
```
    Utility method to get correct filter for equals filtering searching for open/closed tasks
    
    Parameters:
    
    queueName - name of queue
    
    locked - state
    
    Returns:
    
    filter expression
  - getStateFilter
```
public static String getStateFilter(String queueName,
                                    TaskState taskState)
```
    Utility method to get correct filter for equals filtering searching for task state
    
    Parameters:
    
    queueName - name of queue
    
    taskState - state
    
    Returns:
    
    filter expression
  - isOlderThan
```
public boolean isOlderThan(int ageInMinutes)
```
    Compares last update time with current time ...
    
    Parameters:
    
    ageInMinutes - number of minutes to pass (age)
    
    Returns:
    
    true if task is older than given minutes, false otherwise
  - isOlderThanSeconds
```
public boolean isOlderThanSeconds(int ageInSeconds)
```
    Compares last update time with current time ...
    
    Parameters:
    
    ageInSeconds - number of seconds to pass (age)
    
    Returns:
    
    true if task is older than given seconds, false otherwise

Class QueueTask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

generation

queue

job

className

createTime

updateTime

startTime

endTime

executionTime

jobRunTime

state

runCount

stateFilter

lockFilter

Constructor Detail

QueueTask

QueueTask

Method Detail

getJob

getId

getClassName

getStartTime

getEndTime

getCreateTime

getUpdateTime

getJobRunTime

getExecutionTime

getState

getQueue

setState

getRunCount

isLocked

toString

updateFilter

getLockedFilter

getStateFilter

isOlderThan

isOlderThanSeconds