net.incongru.taskman.def
Interface TaskDef

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
TaskDefImpl

public interface TaskDef
extends java.io.Serializable

A TaskDef is a task definition: once deployed, it can tell TaskMan what TaskAction to take upon given events.

Version:
$Revision: $
Author:
greg, $Author: $ (last edit)

Method Summary
 org.joda.time.DateTime getDeploymentDateTime()
           
 java.lang.String getDescription()
           
 org.joda.time.Period getDueDateTimeout()
          How much time before no more reminders are sent and the task is automatically cancelled.
 org.joda.time.Period getDuePeriod()
          How much time is allowed before the assigne is reminded.
 java.lang.Class<? extends TaskAction> getEventActionClass(TaskEvent event)
           
 java.lang.Long getId()
           
 java.lang.String getName()
          A generic name for this task definition, thus shared by all instances of this definition.
 org.joda.time.Period getReminderPeriod()
          How much time between each reminder.
 java.lang.Long getVersionId()
           
 boolean isSameAs(TaskDef other)
          Returns true if all attributes are equals to the given TaskDef, except for id, versionId and deploymentDateTime.
 void setDeploymentDateTime(org.joda.time.DateTime dateTime)
           
 void setVersionId(java.lang.Long versionId)
           
 

Method Detail

getId

java.lang.Long getId()

getVersionId

java.lang.Long getVersionId()

setVersionId

void setVersionId(java.lang.Long versionId)

getDeploymentDateTime

org.joda.time.DateTime getDeploymentDateTime()

setDeploymentDateTime

void setDeploymentDateTime(org.joda.time.DateTime dateTime)

getName

java.lang.String getName()
A generic name for this task definition, thus shared by all instances of this definition. This is what determines if the version should be incremented (i.e. if a TaskDef with this name already exists)


getDescription

java.lang.String getDescription()

getDuePeriod

org.joda.time.Period getDuePeriod()
How much time is allowed before the assigne is reminded.


getReminderPeriod

org.joda.time.Period getReminderPeriod()
How much time between each reminder.


getDueDateTimeout

org.joda.time.Period getDueDateTimeout()
How much time before no more reminders are sent and the task is automatically cancelled.


getEventActionClass

java.lang.Class<? extends TaskAction> getEventActionClass(TaskEvent event)

isSameAs

boolean isSameAs(TaskDef other)
Returns true if all attributes are equals to the given TaskDef, except for id, versionId and deploymentDateTime.



Copyright © 2004-2007. All Rights Reserved.