de.decidr.model.commands.workflowmodel.GetWorkflowInstancesCommand.java Source code

Introduction

Here is the source code for de.decidr.model.commands.workflowmodel.GetWorkflowInstancesCommand.java

Source

/*
 * The DecidR Development Team licenses this file to you 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 de.decidr.model.commands.workflowmodel;

import java.util.List;

import org.hibernate.criterion.CriteriaSpecification;
import org.hibernate.criterion.Restrictions;

import de.decidr.model.acl.roles.Role;
import de.decidr.model.entities.WorkflowInstance;
import de.decidr.model.entities.WorkflowModel;
import de.decidr.model.exceptions.TransactionException;
import de.decidr.model.filters.PaginatingCriteria;
import de.decidr.model.filters.Paginator;
import de.decidr.model.transactions.TransactionStartedEvent;

/**
 * Retrieves the workflow instances that belong to the given workflow model.
 * 
 * @author Daniel Huss
 * @version 0.1
 */
public class GetWorkflowInstancesCommand extends WorkflowModelCommand {

    private List<WorkflowInstance> result;

    private Paginator paginator;

    /**
     * Creates a new GetWorkflowInstancesCommand that retrieves the workflow
     * instances that belong to the given workflow model.
     * 
     * @param role
     *            user / system executing the command
     * @param workflowModelId
     *            ID of workflow model
     * @param paginator
     *            optional paginator to reduce the number of results
     */
    public GetWorkflowInstancesCommand(Role role, Long workflowModelId, Paginator paginator) {
        super(role, workflowModelId);
        requireWorkflowModelId();
        this.paginator = paginator;
    }

    /**
     * @return the result
     */
    public List<WorkflowInstance> getResult() {
        return result;
    }

    @SuppressWarnings("unchecked")
    @Override
    public void transactionAllowed(TransactionStartedEvent evt) throws TransactionException {
        result = null;

        WorkflowModel model = fetchWorkflowModel(evt.getSession());

        PaginatingCriteria crit = new PaginatingCriteria(WorkflowInstance.class, evt.getSession());

        crit.createCriteria("deployedWorkflowModel", "dwm", CriteriaSpecification.LEFT_JOIN)
                .add(Restrictions.eq("dwm.originalWorkflowModel", model));

        if (paginator != null) {
            paginator.apply(crit);
        }

        List<WorkflowInstance> instances = crit.list();
        /*
         * make sure the needed properties are retrieved.
         */
        for (WorkflowInstance instance : instances) {
            instance.getId();
            instance.getCompletedDate();
            instance.getStartedDate();
            instance.getDeployedWorkflowModel().getName();
            instance.getDeployedWorkflowModel().getDescription();
            instance.getDeployedWorkflowModel().getDeployDate();
        }

        result = instances;
    }

}