com.tcdng.jacklyn.workflow.data.WfStepDef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jacklyn-workflow Show documentation
Jacklyn Workflow Module
There is a newer version: 2.0.1
/*
 * Copyright 2018-2020 The Code Department.
 * 
 * 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 com.tcdng.jacklyn.workflow.data;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.tcdng.jacklyn.shared.workflow.WorkflowParticipantType;
import com.tcdng.jacklyn.shared.workflow.WorkflowStepType;
import com.tcdng.jacklyn.workflow.constants.WorkflowModuleErrorConstants;
import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.util.DataUtils;
import com.tcdng.unify.core.util.StringUtils;

/**
 * Workflow step definition.
 * 
 * @author Lateef Ojulari
 * @since 1.0
 */
public class WfStepDef extends BaseLabelWfDef {

    private Long wfTemplateId;

    private String templateGlobalName;

    private String templateGlobalLockName;
    
    private String globalName;

    private String originGlobalName;
    
    private String workAssignerName;

    private WorkflowStepType stepType;

    private WorkflowParticipantType participantType;

    private Map splitBranches;

    private List enrichmentList;

    private List routingList;

    private List recordActionList;

    private List userActionList;

    private List formPrivilegeList;

    private List alertList;

    private List policyList;

    private Map userActions;

    private int itemsPerSession;

    private long expiryMilliSec;

    private boolean audit;

    private boolean branchOnly;

    private boolean departmentOnly;

    private boolean includeForwarder;

    private long versionTimestamp;

    public WfStepDef(Long wfTemplateId, String templateGlobalName, String templateGlobalLockName, String globalName, String originGlobalName, String name, String description,
            String label, String workAssignerName, WorkflowStepType stepType, WorkflowParticipantType participantType,
            List branchList, List enrichmentList, List routingList,
            List recordActionList, List userActionList,
            List formPrivilegeList, List alertList, List policyList,
            int itemsPerSession, long expiryMilliSec, boolean audit, boolean branchOnly, boolean departmentOnly,
            boolean includeForwarder, long versionTimestamp) {
        super(name, description, label);
        this.wfTemplateId = wfTemplateId;
        this.templateGlobalName = templateGlobalName;
        this.templateGlobalLockName = templateGlobalLockName;
        this.globalName = globalName;
        this.originGlobalName = originGlobalName;
        this.workAssignerName = workAssignerName;
        this.stepType = stepType;
        this.participantType = participantType;
        this.itemsPerSession = itemsPerSession;
        this.expiryMilliSec = expiryMilliSec;
        this.audit = audit;
        this.branchOnly = branchOnly;
        this.departmentOnly = departmentOnly;
        this.includeForwarder = includeForwarder;
        this.versionTimestamp = versionTimestamp;

        if (!DataUtils.isBlank(branchList)) {
            this.splitBranches = new LinkedHashMap();
            for (WfBranchDef wfBranchDef: branchList) {
                this.splitBranches.put(wfBranchDef.getName(), wfBranchDef);
            }
            
            this.splitBranches = Collections.unmodifiableMap(this.splitBranches);
        } else {
            this.splitBranches = Collections.emptyMap();
        }
        
        this.enrichmentList = DataUtils.unmodifiableList(enrichmentList);
        this.routingList = DataUtils.unmodifiableList(routingList);
        this.recordActionList = DataUtils.unmodifiableList(recordActionList);
        this.userActionList = DataUtils.unmodifiableList(userActionList);
        if (!this.userActionList.isEmpty()) {
            this.userActions = new HashMap();
            for (WfUserActionDef wfUserActionDef : userActionList) {
                this.userActions.put(wfUserActionDef.getName(), wfUserActionDef);
            }
        } else {
            this.userActions = Collections.emptyMap();
        }

        this.formPrivilegeList = DataUtils.unmodifiableList(formPrivilegeList);
        this.alertList = DataUtils.unmodifiableList(alertList);
        this.policyList = DataUtils.unmodifiableList(policyList);
    }

    public WfStepDef(String templateGlobalName) {
        super(null, null, null);
        this.templateGlobalName = templateGlobalName;
    }
    
    public Long getWfTemplateId() {
        return wfTemplateId;
    }

    public String getTemplateGlobalName() {
        return templateGlobalName;
    }

    public String getTemplateGlobalLockName() {
        return templateGlobalLockName;
    }

    public String getGlobalName() {
        return globalName;
    }

    public String getOriginGlobalName() {
        return originGlobalName;
    }

    public String getWorkAssignerName() {
        return workAssignerName;
    }

    public WorkflowStepType getStepType() {
        return stepType;
    }

    public WorkflowParticipantType getParticipantType() {
        return participantType;
    }

    public WfBranchDef getWfBranchDef(String name) throws UnifyException {
        WfBranchDef wfBranchDef = splitBranches.get(name);
        if (wfBranchDef == null) {
            throw new UnifyException(WorkflowModuleErrorConstants.WORKFLOW_STEP_BRANCH_WITH_NAME_UNKNOWN,
                    getDescription(), name);
        }
        
        return wfBranchDef;
    }
    
    public Collection getBranchList() {
        return splitBranches.values();
    }

    public int branchCount() {
        return splitBranches.size();
    }
    
    public List getEnrichmentList() {
        return enrichmentList;
    }

    public List getRoutingList() {
        return routingList;
    }

    public List getRecordActionList() {
        return recordActionList;
    }

    public List getUserActionList() {
        return userActionList;
    }

    public List getFormPrivilegeList() {
        return formPrivilegeList;
    }

    public List getAlertList() {
        return alertList;
    }

    public List getPolicyList() {
        return policyList;
    }

    public int getItemsPerSession() {
        return itemsPerSession;
    }

    public long getExpiryMilliSec() {
        return expiryMilliSec;
    }

    public boolean isExpiry() {
        return expiryMilliSec > 0;
    }

    public boolean isAudit() {
        return audit;
    }

    public boolean isBranchOnly() {
        return branchOnly;
    }

    public boolean isDepartmentOnly() {
        return departmentOnly;
    }

    public boolean isIncludeForwarder() {
        return includeForwarder;
    }

    public long getVersionTimestamp() {
        return versionTimestamp;
    }

    public boolean isStart() {
        return stepType.isStart();
    }

    public boolean isError() {
        return stepType.isError();
    }

    public boolean isManual() {
        return stepType.isManual();
    }

    public boolean isSplit() {
        return stepType.isSplit();
    }

    public boolean isMerge() {
        return stepType.isMerge();
    }

    public boolean isAutomatic() {
        return WorkflowStepType.AUTOMATIC.equals(stepType);
    }

    public boolean isInteractive() {
        return WorkflowStepType.INTERACTIVE.equals(stepType);
    }

    public boolean isUserInteractive() {
        return stepType.isUserInteractive();
    }

    public boolean isEnd() {
        return stepType.isEnd();
    }

    public boolean isWithWorkAssigner() {
        return !StringUtils.isBlank(workAssignerName);
    }
    
    public Set getWfActionNames() {
        return userActions.keySet();
    }

    public WfUserActionDef getWfUserActionDef(String actionName) throws UnifyException {
        WfUserActionDef wfUserActionDef = userActions.get(actionName);
        if (wfUserActionDef == null) {
            throw new UnifyException(WorkflowModuleErrorConstants.WORKFLOW_STEP_ACTION_WITH_NAME_UNKNOWN,
                    getDescription(), actionName);
        }

        return wfUserActionDef;
    }

}