org.jbpm.workflow.instance.NodeInstance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbpm-flow Show documentation

jBPM Flow

The newest version!

/*
 * Copyright 2017 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jbpm.workflow.instance;

import java.util.Date;
import java.util.Map;

import org.jbpm.process.instance.ContextInstance;
import org.kie.api.definition.process.Node;

/**
 * Represents a node instance in a RuleFlow. This is the runtime counterpart
 * of a node, containing all runtime state.  Node instance classes also
 * contain the logic on what to do when it is being triggered (start
 * executing) or completed (end of execution).
 * 
 */
public interface NodeInstance extends org.kie.api.runtime.process.NodeInstance {

    enum CancelType {
        OBSOLETE,
        ABORTED,
        SKIPPED,
        ERROR
    }

    public static final String METADATA_WRAP_ASYNC_NODE = "WRAP_ASYNC_NODE";

    void trigger(org.kie.api.runtime.process.NodeInstance from, String type);

    void cancel();

    void cancel(CancelType type);

    Node getNode();
    
    ContextInstance resolveContextInstance(String contextId, Object param);
    
    int getLevel();
    
    void setDynamicParameters(Map dynamicParameters);
    
    int getSlaCompliance();
    
    Date getSlaDueDate();
    
    Long getSlaTimerId();

    Date getTriggerTime();
    
}