rapture.common.api.ScriptDecisionApi 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.AppStatus;
import rapture.common.CreateResponse;
import rapture.common.RaptureFolderInfo;
import rapture.common.dp.WorkOrderStatus;
import rapture.common.dp.Workflow;
import rapture.common.dp.Step;
import rapture.common.dp.WorkOrderCancellation;
import rapture.common.LogQueryResponse;
import rapture.common.dp.WorkOrderDebug;
import rapture.common.dp.WorkOrder;
import rapture.common.dp.AppStatusDetails;
import rapture.common.dp.Transition;
import rapture.common.dp.Worker;
import rapture.common.dp.WorkflowHistoricalMetrics;
import rapture.common.ErrorWrapper;


@SuppressWarnings("all")
public interface ScriptDecisionApi {
     /**
     * 
     * 
     */
     List getAllWorkflows();

     /**
     * 
     * 
     */
     List getWorkflowChildren(String workflowURI);

     /**
     * 
     * 
     */
     List getWorkOrderChildren(String parentPath);

     /**
     * 
     * 
     */
     void putWorkflow(Workflow workflow);

     /**
     * 
     * 
     */
     Workflow getWorkflow(String workflowURI);

     /**
     * 
     * 
     */
     Step getWorkflowStep(String stepURI);

     /**
     * 
     * 
     */
     String getStepCategory(String stepURI);

     /**
     * 
     * 
     */
     void addStep(String workflowURI, Step step);

     /**
     * 
     * 
     */
     void removeStep(String workflowURI, String stepName);

     /**
     * 
     * 
     */
     void addTransition(String workflowURI, String stepName, Transition transition);

     /**
     * 
     * 
     */
     void removeTransition(String workflowURI, String stepName, String transitionName);

     /**
     * 
     * 
     */
     void deleteWorkflow(String workflowURI);

     /**
     * 
     * 
     */
     String createWorkOrder(String workflowURI, Map argsMap);

     /**
     * 
     * 
     */
     CreateResponse createWorkOrderP(String workflowURI, Map argsMap, String appStatusUriPattern);

     /**
     * 
     * 
     */
     void releaseWorkOrderLock(String workOrderURI);

     /**
     * 
     * 
     */
     WorkOrderStatus getWorkOrderStatus(String workOrderURI);

     /**
     * 
     * 
     */
     void writeWorkflowAuditEntry(String workOrderURI, String message, Boolean error);

     /**
     * 
     * 
     */
     List getWorkOrdersByDay(Long startTimeInstant);

     /**
     * 
     * 
     */
     List getWorkOrdersByWorkflow(Long startTimeInstant, String workflowUri);

     /**
     * 
     * 
     */
     WorkOrder getWorkOrder(String workOrderURI);

     /**
     * 
     * 
     */
     Worker getWorker(String workOrderURI, String workerId);

     /**
     * 
     * 
     */
     void cancelWorkOrder(String workOrderURI);

     /**
     * 
     * 
     */
     CreateResponse resumeWorkOrder(String workOrderURI, String resumeStepURI);

     /**
     * 
     * 
     */
     Boolean wasCancelCalled(String workOrderURI);

     /**
     * 
     * 
     */
     WorkOrderCancellation getCancellationDetails(String workOrderURI);

     /**
     * 
     * 
     */
     WorkOrderDebug getWorkOrderDebug(String workOrderURI);

     /**
     * 
     * 
     */
     void setWorkOrderIdGenConfig(String config, Boolean force);

     /**
     * 
     * 
     */
     void setContextLiteral(String workerURI, String varAlias, String literalValue);

     /**
     * 
     * 
     */
     void setContextLink(String workerURI, String varAlias, String expressionValue);

     /**
     * 
     * 
     */
     String getContextValue(String workerURI, String varAlias);

     /**
     * 
     * 
     */
     void addErrorToContext(String workerURI, ErrorWrapper errorWrapper);

     /**
     * 
     * 
     */
     List getErrorsFromContext(String workerURI);

     /**
     * 
     * 
     */
     List getExceptionInfo(String workOrderURI);

     /**
     * 
     * 
     */
     void reportStepProgress(String workerURI, Long stepStartTime, String message, Long progress, Long max);

     /**
     * 
     * 
     */
     List getAppStatuses(String prefix);

     /**
     * 
     * 
     */
     List getAppStatusDetails(String prefix, List extraContextValues);

     /**
     * 
     * 
     */
     WorkflowHistoricalMetrics getMonthlyMetrics(String workflowURI, String jobURI, String argsHashValue, String state);

     /**
     * 
     * 
     */
     LogQueryResponse queryLogs(String workOrderURI, Long startTime, Long endTime, Long keepAlive, Long bufferSize, String nextBatchId, String stepName, String stepStartTime);

}