Ruler.java

/*********************************************************************************
 * The contents of this file are subject to the Common Public Attribution
 * License Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.openemm.org/cpal1.html. The License is based on the Mozilla
 * Public License Version 1.1 but Sections 14 and 15 have been added to cover
 * use of software over a computer network and provide for limited attribution
 * for the Original Developer. In addition, Exhibit A has been modified to be
 * consistent with Exhibit B.
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The Original Code is OpenEMM.
 * The Original Developer is the Initial Developer.
 * The Initial Developer of the Original Code is AGNITAS AG. All portions of
 * the code written by AGNITAS AG are Copyright (c) 2007 AGNITAS AG. All Rights
 * Reserved.
 *
 * Contributor(s): AGNITAS AG.
 ********************************************************************************/
/*
 * Ruler.java
 *
 * Created on 23. Mai 2006, 14:41
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 */

package org.agnitas.backend;

/**
 *
 * @author mhe
 */
public interface Ruler {
    /**
     * Cleanup
     */
    void done() throws Exception;

    /** Wrapper for kickOff to be used in Quartz scheduler
     */
    void kickOffSimple();

    /**
     * Loop over all entries for today and start the
     * mailings, which are ready to run
     */
    String kickOff() throws Exception;

    /**
     * Setter for hour
     * @param nhour the new hour to send mailings for
     */
    void setHour(int nhour);

    /**
     * Start delayed mail generation
     */
    public void kickOffDelayed();
}