org.kie.internal.task.api.InternalTaskService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kie-internal Show documentation
The Drools and jBPM internal API which is NOT backwards compatible between releases.
There is a newer version: 9.44.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.internal.task.api;

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

import org.kie.api.task.TaskService;
import org.kie.api.task.model.Attachment;
import org.kie.api.task.model.Content;
import org.kie.api.task.model.Group;
import org.kie.api.task.model.I18NText;
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;
import org.kie.api.task.model.User;
import org.kie.internal.query.QueryFilter;
import org.kie.internal.task.api.model.ContentData;
import org.kie.internal.task.api.model.FaultData;
import org.kie.internal.task.api.model.SubTasksStrategy;
import org.kie.internal.task.api.model.TaskDef;
import org.kie.internal.task.api.model.TaskEvent;
import org.kie.internal.task.query.TaskSummaryQueryBuilder;

/**
 * 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 InternalTaskService extends TaskService {

    List getTasksOwned(String userId, List status, QueryFilter filter);

    List getTasksAssignedAsPotentialOwner(String userId, List groupIds, List status, QueryFilter filter);

    void addGroup(Group group);

    void addUser(User user);

    int archiveTasks(List tasks);

    void deleteFault(long taskId, String userId);

    void deleteOutput(long taskId, String userId);

    void deployTaskDef(TaskDef def);

    List getActiveTasks();

    List getActiveTasks(Date since);

    List getAllTaskDef(String filter);

    List getArchivedTasks();

    List getCompletedTasks();

    List getCompletedTasks(Date since);

    List getCompletedTasksByProcessId(Long processId);

    Group getGroupById(String groupId);

    List getGroups();

    List getSubTasksAssignedAsPotentialOwner(long parentId, String userId);

    List getSubTasksByParent(long parentId);

    int getPendingSubTasksByParent(long parentId);

    TaskDef getTaskDefById(String id);

    List getTasksAssignedAsPotentialOwnerByExpirationDate(String userId, List statuses, Date expirationDate);

    List getTasksAssignedAsPotentialOwnerByExpirationDateOptional(String userId, List statuses, Date expirationDate);

    List getTasksOwnedByExpirationDate(String userId, List statuses, Date expirationDate);

    List getTasksOwnedByExpirationDateOptional(String userId, List statuses, Date expirationDate);

    List getTasksAssignedAsExcludedOwner(String userId);

    List getTasksAssignedAsPotentialOwner(String userId, List groupIds);

    List getTasksAssignedAsPotentialOwnerByStatusByGroup(String userId, List groupIds, List status);

    List getTasksAssignedAsRecipient(String userId);

    List getTasksAssignedAsTaskInitiator(String userId);

    List getTasksAssignedAsTaskStakeholder(String userId);

    List getTasksOwnedByExpirationDateBeforeSpecifiedDate(String userId, List status, Date date);

    List getTasksByStatusByProcessInstanceIdByTaskName(String processInstanceId, List status, String taskName);

    Map> getPotentialOwnersForTaskIds(List taskIds);

    User getUserById(String userId);

    List getUsers();

    long addTask(Task task, ContentData data);

    void remove(long taskId, String userId);

    void removeGroup(String groupId);

    int removeTasks(List tasks);

    void removeUser(String userId);

    void setFault(long taskId, String userId, FaultData fault);

    void setOutput(long taskId, String userId, Object outputContentData);

    void setPriority(long taskId, int priority);

    void setTaskNames(long taskId, List taskNames);

    void undeployTaskDef(String id);

    List getTaskEventsById(long taskId);

    UserInfo getUserInfo();

    void setUserInfo(UserInfo userInfo);

    void addUsersAndGroups(Map users, Map groups);

    int removeAllTasks();

    long addContent(long taskId, Content content);

    long setDocumentContentFromUser(long taskId, String userId, byte [] byteContent);

    long addContent(long taskId, Map params);

    long addOutputContentFromUser(long taskId, String userId, Map params);

    Content getContentByIdForUser(long contentId, String userId );

    Map getOutputContentMapForUser(long taskId, String userId);

    void deleteContent(long taskId, long contentId);

    List getAllContentByTaskId(long taskId);

    long addAttachment(long taskId, Attachment attachment, Content content);

    void deleteAttachment(long taskId, long attachmentId);

    List getAllAttachmentsByTaskId(long taskId);

    void removeTaskEventsById(long taskId);

    OrganizationalEntity getOrganizationalEntityById(String entityId);

    void setDescriptions(long taskId, List descriptions);

    void setSkipable(long taskId, boolean skipable);

    void setSubTaskStrategy(long taskId, SubTasksStrategy strategy);

    int getPriority(long taskId);

    Date getExpirationDate(long taskId);

    List getDescriptions(long taskId);

    boolean isSkipable(long taskId);

    SubTasksStrategy getSubTaskStrategy(long taskId);

    Task getTaskInstanceById(long taskId);

    int getCompletedTaskByUserId(String userId);

    int getPendingTaskByUserId(String userId);

    List getTasksAssignedByGroup(String groupId);

    List getTasksAssignedByGroups(List groupIds);

    void addMarshallerContext(String ownerId, ContentMarshallerContext context);

    void removeMarshallerContext(String ownerId);

    ContentMarshallerContext getMarshallerContext(Task task);

    TaskSummaryQueryBuilder taskSummaryQuery(String userId);

    List getTasksAssignedAsBusinessAdministratorByStatus(String userId, String language ,List statuses);

    void executeReminderForTask(long taskId,String fromUser);

    long addContentFromUser(long taskId, String userId, Map params);

}