org.kie.api.runtime.process.HumanTaskWorkItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kogito-api

The Kogito public API which is backwards compatible between releases.

There is a newer version: 10.0.0

/*
 * Copyright 2019 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 *
 *      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 org.kie.api.runtime.process;

import java.util.Set;

/**
 * Dedicated extension to WorkItem to cover needs of human tasks
 *
 */
public interface HumanTaskWorkItem extends WorkItem {

    /**
     * Returns name of the task
     * @return task name
     */
    String getTaskName();
    
    /**
     * Returns optional description of the task
     * @return task description if present
     */
    String getTaskDescription();
    
    /**
     * Returns optional priority of the task
     * @return task priority if present
     */
    String getTaskPriority();
    
    /**
     * Returns reference name of the task
     * @return task reference
     */
    String getReferenceName();
    
    /**
     * Returns actual owner assigned to the task
     * @return task actual owner
     */
    String getActualOwner();
    
    /**
     * Returns potential users that can work on this task
     * @return potential users
     */
    Set getPotentialUsers();
    
    /**
     * Returns potential groups that can work on this task
     * @return potential groups
     */
    Set getPotentialGroups();
    
    /**
     * Returns admin users that can administer this task
     * @return admin users
     */
    Set getAdminUsers();
    
    /**
     * Returns admin groups that can administer this task
     * @return admin groups
     */
    Set getAdminGroups();
    
    /**
     * Returns excluded users that cannot work on this task
     * @return excluded users
     */
    Set getExcludedUsers();
}