com.tcdng.jacklyn.workflow.business.WfItemAssignmentPolicy 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.business;

import java.util.List;

import com.tcdng.jacklyn.workflow.data.FlowingWfItem.Reader;
import com.tcdng.jacklyn.workflow.data.WfItemAssigneeInfo;
import com.tcdng.unify.core.UnifyException;

/**
 * Workflow item assignment policy.
 * 
 * @author Lateef Ojulari
 * @since 1.0
 */
public interface WfItemAssignmentPolicy extends WfItemPolicy {

    /**
     * Executes workflow item user assignment policy using data from workflow item.
     * 
     * @param wfItemAssigneeInfoList
     *            the assignee list
     * @param flowingWfItemReader
     *            the workflow item reader
     * @return the login ID of user to assign workflow item to otherwise null
     * @throws UnifyException
     *             if an error occurs
     */
    String assignWorkItem(List wfItemAssigneeInfoList, Reader flowingWfItemReader)
            throws UnifyException;
}