• Home
• org.kie.server
• kie-server-client
• 7.65.0.Final
• source code
• CaseServicesClient.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.kie.server.client.CaseServicesClient Maven / Gradle / Ivy

/*
 * Copyright 2016 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.server.client;

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

import org.kie.server.api.model.cases.CaseAdHocFragment;
import org.kie.server.api.model.cases.CaseComment;
import org.kie.server.api.model.cases.CaseDefinition;
import org.kie.server.api.model.cases.CaseFile;
import org.kie.server.api.model.cases.CaseFileDataItem;
import org.kie.server.api.model.cases.CaseInstance;
import org.kie.server.api.model.cases.CaseInstanceCustomVars;
import org.kie.server.api.model.cases.CaseMilestone;
import org.kie.server.api.model.cases.CaseRoleAssignment;
import org.kie.server.api.model.cases.CaseStage;
import org.kie.server.api.model.cases.CaseUserTaskWithVariables;
import org.kie.server.api.model.definition.ProcessDefinition;
import org.kie.server.api.model.definition.SearchQueryFilterSpec;
import org.kie.server.api.model.instance.NodeInstance;
import org.kie.server.api.model.instance.ProcessInstance;
import org.kie.server.api.model.instance.TaskSummary;

public interface CaseServicesClient {

    public static final String SORT_BY_CASE_DEFINITION_ID = "CaseId";
    public static final String SORT_BY_CASE_DEFINITION_NAME = "CaseName";
    public static final String SORT_BY_CASE_DEFINITION_DEPLOYMENT_ID = "Project";

    public static final String SORT_BY_CASE_INSTANCE_ID = "CorrelationKey";

    public static final String SORT_BY_PROCESS_NAME = "ProcessName";
    public static final String SORT_BY_PROCESS_VERSION = "ProcessVersion";
    public static final String SORT_BY_PROCESS_PROJECT = "Project";

    public static final String SORT_BY_PROCESS_INSTANCE_ID = "ProcessInstanceId";

    public static final String COMMENT_SORT_BY_AUTHOR = "Author";
    public static final String COMMENT_SORT_BY_DATE = "Date";
    
    public static final String ACCESS_PUBLIC_GROUP = "_public_";

    String startCase(String containerId, String caseDefinitionId);

    String startCase(String containerId, String caseDefinitionId, CaseFile caseFile);

    CaseInstance getCaseInstance(String containerId, String caseId);

    CaseInstance getCaseInstance(String containerId, String caseId, boolean withData, boolean withRoles, boolean withMilestones, boolean withStages);

    void closeCaseInstance(String containerId, String caseId, String comment);
    
    void cancelCaseInstance(String containerId, String caseId);

    void destroyCaseInstance(String containerId, String caseId);

    void reopenCase(String caseId, String containerId, String caseDefinitionId);

    void reopenCase(String caseId, String containerId, String caseDefinitionId, Map data);

    Map getCaseInstanceData(String containerId, String caseId);
    
    Map getCaseInstanceData(String containerId, String caseId, List names);

    Object getCaseInstanceData(String containerId, String caseId, String name);

    void putCaseInstanceData(String containerId, String caseId, Map data);

    void putCaseInstanceData(String containerId, String caseId, String name, Object data);
    
    void putCaseInstanceData(String containerId, String caseId, Map data, List restrictions);

    void putCaseInstanceData(String containerId, String caseId, String name, Object data, List restrictions);

    void removeCaseInstanceData(String containerId, String caseId, String... names);

    void addDynamicUserTask(String containerId, String caseId, String name, String subject, String actors, String groups, Map data);

    void addDynamicTask(String containerId, String caseId, String nodeType, String name, Map data);

    void addDynamicUserTaskToStage(String containerId, String caseId, String stageId, String name, String description, String actors, String groups, Map data);

    void addDynamicTaskToStage(String containerId, String caseId, String stageId, String nodeType, String name, Map data);

    void addDynamicSubProcess(String containerId, String caseId, String processId, Map data);

    void addDynamicSubProcessToStage(String containerId, String caseId, String stageId,  String processId, Map data);

    void triggerAdHocFragment(String containerId, String caseId, String adHocName, Map data);

    void triggerAdHocFragmentInStage(String containerId, String caseId, String stageId, String adHocName, Map data);

    List getMilestones(String containerId, String caseId, boolean achievedOnly, Integer page, Integer pageSize);

    List getStages(String containerId, String caseId, boolean activeOnly, Integer page, Integer pageSize);

    List getAdHocFragments(String containerId, String caseId);

    List getRoleAssignments(String containerId, String caseId);

    List getActiveNodes(String containerId, String caseId, Integer page, Integer pageSize);

    List getCompletedNodes(String containerId, String caseId, Integer page, Integer pageSize);

    List getActiveProcessInstances(String containerId, String caseId, Integer page, Integer pageSize);

    List getActiveProcessInstances(String containerId, String caseId, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getProcessInstances(String containerId, String caseId, List status, Integer page, Integer pageSize);

    List getProcessInstances(String containerId, String caseId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    void assignUserToRole(String containerId, String caseId, String roleName, String user);

    void assignGroupToRole(String containerId, String caseId, String roleName, String group);

    void removeUserFromRole(String containerId, String caseId, String roleName, String user);

    void removeGroupFromRole(String containerId, String caseId, String roleName, String group);

    List getComments(String containerId, String caseId, Integer page, Integer pageSize);

    List getComments(String containerId, String caseId, String sortBy, Integer page, Integer pageSize);

    String addComment(String containerId, String caseId, String author, String text);

    void updateComment(String containerId, String caseId, String commentId, String author, String text);
    
    String addComment(String containerId, String caseId, String author, String text, List restrictions);

    void updateComment(String containerId, String caseId, String commentId, String author, String text, List restrictions);

    void removeComment(String containerId, String caseId, String commentId);    

    List getCaseInstances(Integer page, Integer pageSize);

    List getCaseInstances(List status, Integer page, Integer pageSize);

    List getCaseInstances(Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseInstances(List status, Integer page, Integer pageSize, String sort, boolean sortOrder);
    
    List getCaseInstances(List status, Integer page, Integer pageSize, String sort, boolean sortOrder, boolean withData);

    List getCaseInstancesOwnedBy(String owner, List status, Integer page, Integer pageSize);

    List getCaseInstancesOwnedBy(String owner, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseInstancesOwnedBy(String owner, List status, Integer page, Integer pageSize, String sort, boolean sortOrder, boolean withData);

    List getCaseInstancesByContainer(String containerId, List status, Integer page, Integer pageSize);

    List getCaseInstancesByContainer(String containerId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseInstancesByContainer(String containerId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder, boolean withData);

    List getCaseInstancesByDefinition(String containerId, String caseDefinitionId, List status, Integer page, Integer pageSize);

    List getCaseInstancesByDefinition(String containerId, String caseDefinitionId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseInstancesByDefinition(String containerId, String caseDefinitionId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder, boolean withData);

    List getCaseInstancesByData(String dataItemName, List status, Integer page, Integer pageSize);

    List getCaseInstancesByData(String dataItemName, String dataItemValue, List status, Integer page, Integer pageSize);

    List getCaseDefinitionsByContainer(String containerId, Integer page, Integer pageSize);

    List getCaseDefinitionsByContainer(String containerId, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseDefinitions(Integer page, Integer pageSize);

    List getCaseDefinitions(String filter, Integer page, Integer pageSize);

    List getCaseDefinitions(Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseDefinitions(String filter, Integer page, Integer pageSize, String sort, boolean sortOrder);

    CaseDefinition getCaseDefinition(String containerId, String caseDefinitionId);

    List findCaseTasksAssignedAsBusinessAdministrator(String caseId, String userId, Integer page, Integer pageSize);

    List findCaseTasksAssignedAsBusinessAdministrator(String caseId, String userId, List status, Integer page, Integer pageSize);

    List findCaseTasksAssignedAsPotentialOwner(String caseId, String userId, Integer page, Integer pageSize);

    List findCaseTasksAssignedAsPotentialOwner(String caseId, String userId, List status, Integer page, Integer pageSize);

    List findCaseTasksAssignedAsStakeholder(String caseId, String userId, Integer page, Integer pageSize);

    List findCaseTasksAssignedAsStakeholder(String caseId, String userId, List status, Integer page, Integer pageSize);

    List findCaseTasksAssignedAsBusinessAdministrator(String caseId, String userId, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findCaseTasksAssignedAsBusinessAdministrator(String caseId, String userId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findCaseTasksAssignedAsPotentialOwner(String caseId, String userId, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findCaseTasksAssignedAsPotentialOwner(String caseId, String userId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findCaseTasksAssignedAsStakeholder(String caseId, String userId, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findCaseTasksAssignedAsStakeholder(String caseId, String userId, List status, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findProcesses(Integer page, Integer pageSize);

    List findProcesses(String filter, Integer page, Integer pageSize);

    List findProcessesByContainerId(String containerId, Integer page, Integer pageSize);

    List findProcesses(Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findProcesses(String filter, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List findProcessesByContainerId(String containerId, Integer page, Integer pageSize, String sort, boolean sortOrder);

    List getCaseInstanceDataItems(String caseId, Integer page, Integer pageSize);

    List getCaseInstanceDataItemsByName(String caseId, List names, Integer page, Integer pageSize);

    List getCaseInstanceDataItemsByType(String caseId, List types, Integer page, Integer pageSize);

    List queryCasesByVariables(SearchQueryFilterSpec spec, Integer page, Integer pageSize);

    List queryUserTaskByVariables(SearchQueryFilterSpec spec, Integer page, Integer pageSize);
}