org.kie.internal.task.api.TaskQueryService 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: 10.0.0
/*
 * 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.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.internal.query.QueryFilter;
import org.kie.internal.query.data.QueryData;


/**
 * The Task Query Service will contain all the methods 
 *  to get information about the current Task Instances. 
 *  Most of the times these methods will be used to build
 *  User Interfaces, and we should not include any method 
 *  related with Task Statistics here. 
 */
public interface TaskQueryService {
    
    List getTasksAssignedAsPotentialOwner(String userId, List groupIds, List status, QueryFilter filter);
    
    List getTasksOwned(String userId, List status, QueryFilter filter);
    
    List getTasksAssignedAsPotentialOwner(String userId, List groupIds);
    
    List getTasksAssignedAsBusinessAdministrator(String userId, List groupIds);
    
    List getTasksAssignedAsBusinessAdministratorByStatus(String userId, List groupIds, List status);

    List getTasksAssignedAsExcludedOwner(String userId);
    
    List getTasksAssignedAsPotentialOwnerByExpirationDate(String userId, List groupIds, List status, Date expirationDate);
    
    List getTasksAssignedAsPotentialOwnerByExpirationDateOptional(String userId, List groupIds, List status, Date expirationDate);
    
    List getTasksAssignedAsPotentialOwnerByExpirationDate(String userId, List status, Date expirationDate);
    
    List getTasksAssignedAsPotentialOwnerByExpirationDateOptional(String userId, List status, Date expirationDate);

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

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

    List getTasksAssignedAsTaskInitiator(String userId);

    List getTasksAssignedAsTaskStakeholder(String userId);

    List getTasksAssignedByGroup(String groupId);
    
    List getTasksAssignedByGroups(List groupsId);
    
    List getTasksAssignedByGroupsByExpirationDate(List groupIds,  Date expirationDate);
    
    List getTasksAssignedByGroupsByExpirationDateOptional(List groupIds,  Date expirationDate);
    
    List getTasksOwned(String userId);

    List getTasksOwnedByStatus(String userId, List status);
    
    List getTasksOwnedByExpirationDate(String userId, List status, Date expirationDate);
    
    List getTasksOwnedByExpirationDateOptional(String userId, List status, Date expirationDate);
    
    List getTasksOwnedByExpirationDateBeforeSpecifiedDate(String userId, List status, Date date);
    
    List getSubTasksAssignedAsPotentialOwner(long parentId, String userId);
    
    List getSubTasksByParent(long parentId);
    
    List getTasksByStatusByProcessInstanceId(long processInstanceId, List status);

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

    int getPendingSubTasksByParent(long parentId);
    
    Task getTaskByWorkItemId(long workItemId);
    
    Task getTaskInstanceById(long taskId);
    
    List getTasksByProcessInstanceId(long processInstanceId);
    
    Map> getPotentialOwnersForTaskIds(List taskIds);
  
    int getCompletedTaskByUserId(String userId);
    int getPendingTaskByUserId(String userId);

    /**
     * This method will no longer be available as of jBPM 7.x
     * 
     * @param parameters A map of parameters to add to the query
     * @param union Whether the query should return a union or intersection of the criteria (parameters)
     * 
     * @see {@link #query(String, QueryData)}
     * @return
     */
    @Deprecated
    List getTasksByVariousFields( String userId, Map> parameters, boolean union);
    
    
    /**
     * 
     * @param queryWhere
     * @return
     */
    List query( String userId, Object queryWhere );
}