/*
This file is part of Cyclos (www.cyclos.org).
A project of the Social Trade Organisation (www.socialtrade.org).
Cyclos is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Cyclos is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Cyclos; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package nl.strohalm.cyclos.scheduling.tasks;
import java.util.Calendar;
/**
* A Cyclos scheduled task.
* @author luis
*/
public interface ScheduledTask {
/**
* Returns the name of this task
*/
String getName();
/**
* Returns if this task runs every hour (true) or just once per day (false)
*/
boolean isEveryHour();
/**
* Run this task as if it were fired at the exact given instant
*/
void run(Calendar time);
/**
* Returns whether this scheduled task should be executed within a transaction
*/
boolean shouldRunInTransaction();
}