com.communote.server.api.core.task

Class TaskTO

java.lang.Object

com.communote.server.api.core.task.TaskTO

public class TaskTO
extends Object

Transfer object for a Task.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
TaskTO() Empty constructor.
TaskTO(Task task, boolean skipHandlerCreation) Creates this TaskTO out of the given Task entity.

Method Summary

Modifier and Type	Method and Description
TaskHandler	getHandler()
Long	getId()
Long	getInterval()
Date	getLastExecution()
Date	getNextExecution()
Map<String,String>	getProperties()
String	getProperty(String key) Returns the value of a stored property.
Date	getRescheduleDate() Returns the reschedule date.
TaskStatus	getStatus()
String	getUniqueName()
boolean	hasProperty(String key) Returns whether the task has a specific property.
boolean	isActive()
void	setHandler(TaskHandler handler)
void	setProperty(String key, String value) Sets a property for the task.
void	setRescheduleDate(Date rescheduleDate)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskTO

public TaskTO()

Empty constructor.

TaskTO

public TaskTO(Task task,
              boolean skipHandlerCreation)
       throws ClassNotFoundException,
              InstantiationException,
              IllegalAccessException

Creates this TaskTO out of the given Task entity.

Parameters:

task - The task.

skipHandlerCreation - If true, the handler wouldn't be created through the constructor.

Throws:

ClassNotFoundException - Thrown, if there is no class for the given handler.

IllegalAccessException - Thrown, if it was not possible to initialize the handler class.

InstantiationException - Thrown, if it was not possible to initialize the handler class.

Method Detail

getHandler

public TaskHandler getHandler()

Returns:

the handler

getId

public Long getId()

Returns:

the id

getInterval

public Long getInterval()

Returns:

the interval

getLastExecution

public Date getLastExecution()

Returns:

the lastExecution

getNextExecution

public Date getNextExecution()

Returns:

the nextExecution

getProperties

public Map<String,String> getProperties()

Returns:

all properties stored with the task

Since:

3.5

getProperty

public String getProperty(String key)

Returns the value of a stored property.

Parameters:

key - the key of the property

Returns:

the value or null

getRescheduleDate

public Date getRescheduleDate()

Returns the reschedule date.

Returns:

null

getStatus

public TaskStatus getStatus()

Returns:

the status

getUniqueName

public String getUniqueName()

Returns:

the uniqueName

hasProperty

public boolean hasProperty(String key)

Returns whether the task has a specific property.

Parameters:

key - the key of the property to check for

Returns:

true if the property is contained

isActive

public boolean isActive()

Returns:

the active

setHandler

public void setHandler(TaskHandler handler)

Parameters:

handler - the handler to set

setProperty

public void setProperty(String key,
                        String value)

Sets a property for the task.

Parameters:

key - the key of the property

value - the value of the property

setRescheduleDate

public void setRescheduleDate(Date rescheduleDate)

Parameters:

rescheduleDate - the rescheduleDate to set

toString

public String toString()

Overrides:

toString in class Object