org.kie.api.task.TaskService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kie-api Show documentation
The Drools and jBPM public API which is backwards compatible between releases.
There is a newer version: 7.9.0.Final
/*
 * Copyright 2013 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.
 * 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 org.kie.api.task;

import java.util.Date;
import java.util.List;
import java.util.Map;

import org.kie.api.runtime.CommandExecutor;
import org.kie.api.task.model.Attachment;
import org.kie.api.task.model.Comment;
import org.kie.api.task.model.Content;
import org.kie.api.task.model.OrganizationalEntity;
import org.kie.api.task.model.Status;
import org.kie.api.task.model.Task;
import org.kie.api.task.model.TaskSummary;

/**
 * The Task Service Entry Point serves as 
 *  facade of all the other services, providing a single entry point
 *  to access to all the services
 */
public interface TaskService extends CommandExecutor {
    
    void activate(long taskId, String userId);

    void claim(long taskId, String userId);

    void claimNextAvailable(String userId, String language);

    void complete(long taskId, String userId, Map data);

    void delegate(long taskId, String userId, String targetUserId);

    void exit(long taskId, String userId);

    void fail(long taskId, String userId, Map faultData);

    void forward(long taskId, String userId, String targetEntityId);

    Task getTaskByWorkItemId(long workItemId);

    Task getTaskById(long taskId);

    List getTasksAssignedAsBusinessAdministrator(String userId, String language);

    List getTasksAssignedAsPotentialOwner(String userId, String language);

    @Deprecated
    List getTasksAssignedAsPotentialOwner(String userId, List groupIds, String language, int firstResult, int maxResults);

    List getTasksAssignedAsPotentialOwnerByStatus(String userId, List status, String language);

    List getTasksOwned(String userId, String language);

    List getTasksOwnedByStatus(String userId, List status, String language);

    List getTasksByStatusByProcessInstanceId(long processInstanceId, List status, String language);
    
    List getTasksAssignedAsPotentialOwnerByProcessId(String userId, String processId);

    List getTasksByProcessInstanceId(long processInstanceId);
    
    long addTask(Task task, Map params);

    void release(long taskId, String userId);

    void resume(long taskId, String userId);

    void skip(long taskId, String userId);

    void start(long taskId, String userId);

    void stop(long taskId, String userId);

    void suspend(long taskId, String userId);

    void nominate(long taskId, String userId, List potentialOwners);

    Content getContentById(long contentId);

    Attachment getAttachmentById(long attachId);

    Map getTaskContent(long taskId);
    
    /**
     * This method will be removed in jBPM 7.x because of new methods that better implement this functionality.
     * 
     * This method queries using the given arguments.
     *  
     * @param userId Optional parameter: the task user id
     * @param workItemIds Optional parameter: a list of work item ids
     * @param taskIds Optional parameter: a list of task ids
     * @param procInstIds Optional parameter: a list of task ids
     * @param busAdmins Optional parameter: a list of business administrator ids
     * @param potOwners Optional parameter: a list of potential owners
     * @param taskOwners Optional parameter: a list of task owners
     * @param status Optional parameter: a list of status's
     * @param union Required: whether the query should be a union or intersection of the criteria
     * @return a List of {@link TaskSummary} instances that fit the critieria given
     */
    @Deprecated
    List getTasksByVariousFields( String userId, List workItemIds, List taskIds, List procInstIds, 
            List busAdmins, List potOwners, List taskOwners, 
            List status, List language, boolean union);
    
    /**
     * This method will be removed in jBPM 7.x because of new methods that better implement this functionality.
     * 
     * Using this method is not recommended. 
     * 
     * @see #getTasksByVariousFields(String, List, List, List, List, List, List, List, List, boolean)
     */
    @Deprecated
    List getTasksByVariousFields( String userId, Map > parameters, boolean union);
    
    Long addComment(long taskId, Comment comment);
    
    Long addComment(long taskId, String addedByUserId, String commentText);

    void deleteComment(long taskId, long commentId);

    List getAllCommentsByTaskId(long taskId);

    Comment getCommentById(long commentId);        
    
    void setExpirationDate(long taskId, Date date);
}