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

Introduction

Here is the source code for de.decidr.model.commands.workflowmodel.WorkflowModelCommand.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 org.hibernate.Criteria;
import org.hibernate.Session;
import org.hibernate.criterion.CriteriaSpecification;
import org.hibernate.criterion.Restrictions;

import de.decidr.model.acl.access.WorkflowModelAccess;
import de.decidr.model.acl.permissions.Permission;
import de.decidr.model.acl.roles.Role;
import de.decidr.model.commands.AclAwareCommand;
import de.decidr.model.entities.DeployedWorkflowModel;
import de.decidr.model.entities.WorkflowModel;
import de.decidr.model.exceptions.EntityNotFoundException;

/**
 * Base class for commands that modify workflow models.
 * 
 * @author Daniel Huss
 * @version 0.1
 */
public abstract class WorkflowModelCommand extends AclAwareCommand implements WorkflowModelAccess {

    protected Long workflowModelId = null;

    /**
     * @param role
     *            user / system executing the command
     * @param workflowModelId
     *            the workflow model that is read / modified. A corresponding
     *            permission is automatically created.
     */
    public WorkflowModelCommand(Role role, Long workflowModelId) {
        super(role, (Permission) null);
        this.workflowModelId = workflowModelId;
    }

    /**
     * Fetches the current deployed version of the workflow model.
     * 
     * @param session
     *            current Hibernate Session
     * @return the current deployed version of the workflow model or null if
     *         there is no current deplyoed version.
     */
    public DeployedWorkflowModel fetchCurrentDeployedWorkflowModel(Session session) {
        Criteria crit = session.createCriteria(DeployedWorkflowModel.class, "dwm");

        crit.createCriteria("originalWorkflowModel", "owm")
                .add(Restrictions.eqProperty("owm.version", "dwm.version"));

        crit.add(Restrictions.eq("originalWorkflowModel.id", getWorkflowModelId()));

        return (DeployedWorkflowModel) crit.setResultTransformer(CriteriaSpecification.ROOT_ENTITY).uniqueResult();
    }

    /**
     * Fetches a deployed workflow model from the database, assuming that
     * {@link #workflowModelId} is the ID of a deployed workflow model.
     * 
     * @param session
     *            current Hibernate session.
     * @return the deployed workflow model
     * @throws EntityNotFoundException
     *             if the deployed workflow model does not exist.
     */
    public DeployedWorkflowModel fetchDeployedWorkflowModel(Session session) throws EntityNotFoundException {
        DeployedWorkflowModel result = (DeployedWorkflowModel) session.get(DeployedWorkflowModel.class,
                workflowModelId);

        if (result == null) {
            throw new EntityNotFoundException(DeployedWorkflowModel.class, workflowModelId);
        }

        return result;
    }

    /**
     * Fetches the workflow model from the database using the previously set
     * workflow model id.
     * 
     * @param session
     *            the Hibernate session used to fetch the workflow model.
     * @return the corresponding workflow model entity
     * @throws EntityNotFoundException
     *             if there is no workflow model that corresponds with the
     *             workflow model id that was previously set
     */
    public WorkflowModel fetchWorkflowModel(Session session) throws EntityNotFoundException {

        WorkflowModel workflowModel = (WorkflowModel) session.get(WorkflowModel.class, workflowModelId);

        if (workflowModel == null) {
            throw new EntityNotFoundException(WorkflowModel.class, workflowModelId);
        }

        return workflowModel;
    }

    /**
     * @return the workflowModelId
     */
    public Long getWorkflowModelId() {
        return workflowModelId;
    }

    /**
     * @return the workflowModelIds
     */
    public Long[] getWorkflowModelIds() {
        Long[] result = { workflowModelId };
        return result;
    }

    /**
     * Throws an {@link IllegalArgumentException} if the current workflow model
     * ID is <code>null</code>
     * 
     * @throws IllegalArgumentException
     */
    protected void requireWorkflowModelId() {
        if (workflowModelId == null) {
            throw new IllegalArgumentException("Workflow model ID must not be null.");
        }
    }
}