ca.sqlpower.wabit.enterprise.client
Class ReportTask

java.lang.Object
  ca.sqlpower.wabit.AbstractWabitObject
      ca.sqlpower.wabit.enterprise.client.ReportTask

All Implemented Interfaces:

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 :

• report
• email
• triggerType

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

Constructor Summary

ReportTask()

ReportTask(Report report)

ReportTask(ReportTask task)

Method Summary

boolean	allowsChildren() Returns true if this object may contain children.
int	childPositionOffset(java.lang.Class<? extends WabitObject> childType) Returns the position in the list that would be returned by getChildren() that the first object of type childClass is, or where it would be if there were any children of that type.
java.util.List<? extends WabitObject>	getChildren() Returns an unmodifiable list of the children in this WabitObject.
java.util.List<WabitObject>	getDependencies() Returns a list of all WabitObjects that this Wabit object is dependent on.
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(WabitObject child) This is the object specific implementation of removeChild.
void	removeDependency(WabitObject dependency) Removes the given object as a dependency of this object.
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

addChild, addChildImpl, addWabitListener, begin, beginTransaction, cleanup, commit, commitTransaction, equals, fireChildAdded, fireChildRemoved, firePropertyChange, firePropertyChange, firePropertyChange, fireTransactionEnded, fireTransactionRollback, fireTransactionStarted, generateNewUUID, getChildren, getName, getParent, getSession, getUUID, isForegroundThread, removeChild, removeWabitListener, rollback, rollbackTransaction, runInBackground, runInForeground, setName, setParent, setUUID

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportTask

public ReportTask()

ReportTask

public ReportTask(Report report)

ReportTask

public ReportTask(ReportTask task)

Method Detail

removeChildImpl

protected boolean removeChildImpl(WabitObject child)

Description copied from class: AbstractWabitObject

This is the object specific implementation of removeChild. There are checks in the removeChild method to ensure the child being removed has no dependencies and is a child of this object.

Specified by:

removeChildImpl in class AbstractWabitObject

See Also:

AbstractWabitObject.removeChild(WabitObject)

allowsChildren

public boolean allowsChildren()

Description copied from interface: WabitObject

Returns true if this object may contain children. Not all types of WabitObjects can be a child to any WabitObject.

See Also:

WabitObject.childPositionOffset(Class)

childPositionOffset

public int childPositionOffset(java.lang.Class<? extends WabitObject> childType)

Description copied from interface: WabitObject

Returns the position in the list that would be returned by getChildren() that the first object of type childClass is, or where it would be if there were any children of that type.

getChildren

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

Description copied from interface: WabitObject

Returns an unmodifiable list of the children in this WabitObject. If there are no children in this WabitObject an empty list should be returned.

getDependencies

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

Description copied from interface: WabitObject

Returns a list of all WabitObjects that this Wabit object is dependent on. Children of a WabitObject are not dependencies and will not be returned in this list. If there are no objects this Wabit object is dependent on an empty list should be returned. These are only the immediate dependencies of this object. If you want to find the dependencies of this object's dependencies as well it may be useful to look at WorkspaceGraphModel to make a full graph of all of the dependencies.

removeDependency

public void removeDependency(WabitObject dependency)

Description copied from interface: WabitObject

Removes the given object as a dependency of this object. For this object to no longer be dependent on the given dependency all of its children must also not be dependent on the given dependency when this method returns. This may remove this object from its parent if necessary.

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)