org.bonitasoft.engine.scheduler.JobRegister Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bonita-server Show documentation

There is a newer version: 10.2.0

/**
 * Copyright (C) 2015 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library 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 Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.scheduler;

import java.io.Serializable;
import java.util.Map;

import org.bonitasoft.engine.scheduler.trigger.Trigger;

/**
 * @author Baptiste Mesta
 * @author Matthieu Chaffotte
 */
public interface JobRegister {

    /**
     * 
     * Return the name to register the job with
     * 
     */
    String getJobName();

    /**
     * 
     * @return true if the job can be executed concurrently
     */
    boolean canBeExecutedConcurrently();

    /**
     * 
     * @return the trigger to register the job with
     */
    Trigger getTrigger();

    /**
     * 
     * @return the class of the job
     */
    Class getJobClass();

    /**
     * 
     * @return the map of parameters to run the job with or empty if there is none
     */
    Map getJobParameters();

    /**
     * 
     * @return a description of the job and its configuration
     */
    String getJobDescription();
}