atom.kie.AbstractTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atom-kie Show documentation
All KIE services that provided by Atom platform.
The newest version!
/*
 * Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.kie;

import org.jbpm.process.workitem.AbstractWorkItemHandler;
import org.jbpm.ruleflow.instance.RuleFlowProcessInstance;
import org.jbpm.workflow.core.node.DataAssociation;
import org.jbpm.workflow.core.node.WorkItemNode;
import org.kie.api.definition.process.Node;
import org.kie.api.runtime.process.NodeInstance;
import org.kie.api.runtime.process.NodeInstanceContainer;
import org.kie.api.runtime.process.WorkItem;
import org.kie.api.runtime.process.WorkflowProcessInstance;
import org.kie.internal.runtime.StatefulKnowledgeSession;

import java.util.Collections;
import java.util.List;

/**
 * Abstract work item handler with KIE session.
 *
 * @author Alex Voloshyn
 * @version 1.5 3/10/15
 */
public abstract class AbstractTask extends AbstractWorkItemHandler {
    /**
     * Default constructor with KIE session.
     *
     * @param ksession KIE session to use
     */
    public AbstractTask(final StatefulKnowledgeSession ksession) {
        super(ksession);
    }

    /**
     * Retrieve a variable value.
     *
     * @param name variable name
     * @param item work item instance
     * @return a variable value
     */
    protected Object getVariable(final WorkItem item,
                                 final String name) {
        final WorkflowProcessInstance variables =
                ((WorkflowProcessInstance) getSession().getProcessInstance(
                        item.getProcessInstanceId()));
        return variables.getVariable(name);
    }

    /**
     * Sets a variable value.
     *
     * @param name  variable name
     * @param item  work item instance
     * @param value a variable value
     */
    protected void setVariable(final WorkItem item,
                               final String name,
                               final Object value) {
        final WorkflowProcessInstance variables =
                ((WorkflowProcessInstance) getSession().getProcessInstance(
                        item.getProcessInstanceId()));
        variables.setVariable(name, value);
    }

    /**
     * Retrieve work item node definition.
     *
     * @param item work item instance
     * @return retrieve work item node definition
     */
    private WorkItemNode getWorkItemNode(final WorkItem item) {
        final NodeInstance instance = getNodeInstance(item);
        final NodeInstanceContainer container =
                instance.getNodeInstanceContainer();
        if (container instanceof RuleFlowProcessInstance) {
            final Node node = ((RuleFlowProcessInstance) container)
                    .getRuleFlowProcess().internalGetNode(instance.getNodeId());
            if (node instanceof WorkItemNode) {
                return ((WorkItemNode) node);
            }
        }
        return null;
    }

    /**
     * Retrieve work item input data associations.
     *
     * @param item work item instance
     * @return list of the work item input data associations
     */
    protected List getInAssociations(final WorkItem item) {
        final WorkItemNode node = getWorkItemNode(item);
        if (node == null) {
            return Collections.emptyList();
        }
        return node.getInAssociations();
    }

    /**
     * Retrieve work item output data associations.
     *
     * @param item work item instance
     * @return list of the work item output data associations
     */
    protected List getOutAssociations(final WorkItem item) {
        final WorkItemNode node = getWorkItemNode(item);
        if (node == null) {
            return Collections.emptyList();
        }
        return node.getOutAssociations();
    }
}