rapture.common.api.ScriptScheduleApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.CallingContext;
import rapture.common.exception.RaptureException;
import java.util.List;
import java.util.Map;
import rapture.common.JobErrorAck;
import rapture.common.TimedEventRecord;
import rapture.common.RaptureJobExec;
import rapture.common.RaptureJob;
import rapture.common.WorkflowExecsStatus;


@SuppressWarnings("all")
public interface ScriptScheduleApi {
     /**
     * 
     * 
     */
     RaptureJob createJob(String jobURI, String description, String scriptURI, String cronExpression, String timeZone, Map jobParams, Boolean autoActivate);

     /**
     * 
     * 
     */
     RaptureJob createWorkflowJob(String jobURI, String description, String workflowURI, String cronExpression, String timeZone, Map jobParams, Boolean autoActivate, int maxRuntimeMinutes, String appStatusNamePattern);

     /**
     * 
     * 
     */
     void activateJob(String jobURI, Map extraParams);

     /**
     * 
     * 
     */
     void deactivateJob(String jobURI);

     /**
     * 
     * 
     */
     RaptureJob retrieveJob(String jobURI);

     /**
     * 
     * 
     */
     List retrieveJobs(String uriPrefix);

     /**
     * 
     * 
     */
     void runJobNow(String jobURI, Map extraParams);

     /**
     * 
     * 
     */
     void resetJob(String jobURI);

     /**
     * 
     * 
     */
     RaptureJobExec retrieveJobExec(String jobURI, Long execTime);

     /**
     * 
     * 
     */
     void deleteJob(String jobURI);

     /**
     * 
     * 
     */
     List getJobs();

     /**
     * 
     * 
     */
     List getUpcomingJobs();

     /**
     * 
     * 
     */
     WorkflowExecsStatus getWorkflowExecsStatus();

     /**
     * 
     * 
     */
     JobErrorAck ackJobError(String jobURI, Long execTime, String jobErrorType);

     /**
     * 
     * 
     */
     RaptureJobExec getNextExec(String jobURI);

     /**
     * 
     * 
     */
     List getJobExecs(String jobURI, int start, int count, Boolean reversed);

     /**
     * 
     * 
     */
     List batchGetJobExecs(List jobURI, int start, int count, Boolean reversed);

     /**
     * 
     * 
     */
     Boolean isJobReadyToRun(String toJobURI);

     /**
     * 
     * 
     */
     List getCurrentWeekTimeRecords(int weekOffsetfromNow);

     /**
     * 
     * 
     */
     List getCurrentDayJobs();

}