ca.sqlpower.wabit.enterprise.client
Class ReportTask

java.lang.Object
  extended by ca.sqlpower.object.AbstractSPObject
      extended by ca.sqlpower.wabit.AbstractWabitObject
          extended by ca.sqlpower.wabit.enterprise.client.ReportTask
All Implemented Interfaces:
ca.sqlpower.object.SPObject, WabitObject

public class ReportTask
extends AbstractWabitObject

ReportTask objects are used to parameter a server side report production and distribution via email. The mandatory parameters are :

The triggerType has to be one of the following values.

minute
Launches a job every minute.
hour
Launches a job every hour.
day
Launches a job every day.
week
Launches a job every week
month
Launches a job every month

For a minute triggerType, you need to define those parameters

triggerIntervalParam
Defines how many minutes between each execution. Default 1.

For a hour triggerType, you need to define those parameters

triggerIntervalParam
Defines how many hours between each execution. Default 1.

For a day triggerType, you need to define those parameters

triggerHourParam
Defines at which hour of the day to launch the execution. Default 0 (midnight).
triggerMinuteParam
Defines at which minute of the hour to launch the execution. Default 0.

For a week triggerType, you need to define those parameters

triggerDayOfWeekParam
Defines at which day of the week to launch the execution. Default 1.
triggerHourParam
Defines at which hour of the day to launch the execution. Default 0 (midnight).
triggerMinuteParam
Defines at which minute of the hour to launch the execution. Default 0.

For a month triggerType, you need to define those parameters

triggerDayOfMonthParam
Defines at which day of the month to launch the execution. Default 1
triggerHourParam
Defines at which hour of the day to launch the execution. Default 0 (midnight).
triggerMinuteParam
Defines at which minute of the hour to launch the execution. Default 0.

Author:
luc

Field Summary
 
Fields inherited from class ca.sqlpower.object.AbstractSPObject
uuid
 
Constructor Summary
ReportTask()
           
ReportTask(Report report)
           
ReportTask(ReportTask task)
           
 
Method Summary
 boolean allowsChildren()
           
 int childPositionOffset(java.lang.Class<? extends ca.sqlpower.object.SPObject> childType)
           
 java.util.List<java.lang.Class<? extends ca.sqlpower.object.SPObject>> getAllowedChildTypes()
           
 java.util.List<? extends WabitObject> getChildren()
           
 java.util.List<WabitObject> getDependencies()
           
 java.lang.String getEmail()
           
 Report getReport()
           
 int getTriggerDayOfMonthParam()
           
 int getTriggerDayOfWeekParam()
           
 int getTriggerHourParam()
           
 int getTriggerIntervalParam()
           
 int getTriggerMinuteParam()
           
 java.lang.String getTriggerType()
           
 boolean isNoob()
           
protected  boolean removeChildImpl(ca.sqlpower.object.SPObject child)
           
 void removeDependency(ca.sqlpower.object.SPObject dependency)
           
 void setEmail(java.lang.String email)
           
 void setNoob(boolean noob)
           
 void setReport(Report report)
           
 void setTriggerDayOfMonthParam(int triggerDayOfMonthParam)
           
 void setTriggerDayOfWeekParam(int triggerDayOfWeekParam)
           
 void setTriggerHourParam(int triggerHourParam)
           
 void setTriggerIntervalParam(int triggerIntervalParam)
           
 void setTriggerMinuteParam(int triggerMinuteParam)
           
 void setTriggerType(java.lang.String triggerType)
           
 java.lang.String toString()
           
 
Methods inherited from class ca.sqlpower.wabit.AbstractWabitObject
cleanup, commit, equals, generateNewUUID, getParent, getSession, isForegroundThread, removeChild, rollback, runInBackground, runInForeground
 
Methods inherited from class ca.sqlpower.object.AbstractSPObject
addChild, addChildImpl, addSPListener, begin, fireChildAdded, fireChildRemoved, firePropertyChange, firePropertyChange, firePropertyChange, fireTransactionEnded, fireTransactionRollback, fireTransactionStarted, getChildren, getName, getUUID, removeSPListener, setName, setParent, setUUID
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ca.sqlpower.object.SPObject
addChild, addSPListener, begin, getChildren, getName, getUUID, removeSPListener, setName, setParent, setUUID
 

Constructor Detail

ReportTask

public ReportTask()

ReportTask

public ReportTask(Report report)

ReportTask

public ReportTask(ReportTask task)
Method Detail

removeChildImpl

protected boolean removeChildImpl(ca.sqlpower.object.SPObject child)
Specified by:
removeChildImpl in class ca.sqlpower.object.AbstractSPObject

allowsChildren

public boolean allowsChildren()

childPositionOffset

public int childPositionOffset(java.lang.Class<? extends ca.sqlpower.object.SPObject> childType)

getChildren

public java.util.List<? extends WabitObject> getChildren()

getDependencies

public java.util.List<WabitObject> getDependencies()

removeDependency

public void removeDependency(ca.sqlpower.object.SPObject dependency)

getReport

public Report getReport()

setReport

public void setReport(Report report)

getEmail

public java.lang.String getEmail()

setEmail

public void setEmail(java.lang.String email)

getTriggerType

public java.lang.String getTriggerType()

setTriggerType

public void setTriggerType(java.lang.String triggerType)

getTriggerHourParam

public int getTriggerHourParam()

setTriggerHourParam

public void setTriggerHourParam(int triggerHourParam)

getTriggerMinuteParam

public int getTriggerMinuteParam()

setTriggerMinuteParam

public void setTriggerMinuteParam(int triggerMinuteParam)

getTriggerDayOfWeekParam

public int getTriggerDayOfWeekParam()

setTriggerDayOfWeekParam

public void setTriggerDayOfWeekParam(int triggerDayOfWeekParam)

getTriggerDayOfMonthParam

public int getTriggerDayOfMonthParam()

setTriggerDayOfMonthParam

public void setTriggerDayOfMonthParam(int triggerDayOfMonthParam)

getTriggerIntervalParam

public int getTriggerIntervalParam()

setTriggerIntervalParam

public void setTriggerIntervalParam(int triggerIntervalParam)

toString

public java.lang.String toString()
Overrides:
toString in class AbstractWabitObject

isNoob

public boolean isNoob()

setNoob

public void setNoob(boolean noob)

getAllowedChildTypes

public java.util.List<java.lang.Class<? extends ca.sqlpower.object.SPObject>> getAllowedChildTypes()


Copyright © 2009. All Rights Reserved.