org.ow2.bonita.services.Querier Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2007  Bull S. A. S.
 * Bull, Rue Jean Jaures, B.P.68, 78340, Les Clayes-sous-Bois
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA  02110-1301, USA.
 * 
 * Mofified by Charles Souillard - BonitaSoft S.A.
 **/
package org.ow2.bonita.services;

import java.util.Collection;
import java.util.Set;

import org.ow2.bonita.facade.def.majorElement.ActivityDefinition;
import org.ow2.bonita.facade.def.majorElement.ProcessDefinition;
import org.ow2.bonita.facade.runtime.ActivityInstance;
import org.ow2.bonita.facade.runtime.ActivityState;
import org.ow2.bonita.facade.runtime.ProcessInstance;
import org.ow2.bonita.facade.runtime.TaskInstance;
import org.ow2.bonita.facade.uuid.ActivityDefinitionUUID;
import org.ow2.bonita.facade.uuid.ActivityInstanceUUID;
import org.ow2.bonita.facade.uuid.ProcessDefinitionUUID;
import org.ow2.bonita.facade.uuid.ProcessInstanceUUID;

/**
 * @author Pierre Vigneras, Charles Souillard
 */
public interface Querier {

  String DEFAULT_KEY = "queryList";

  /*
   * ACTIVITY
   */
  Set getActivityInstances(ProcessInstanceUUID instanceUUID);
  ActivityInstance getActivityInstance(ProcessInstanceUUID instanceUUID, 
      String activityId, String iterationId, String activityInstanceId);
  ActivityInstance getActivityInstance(ActivityInstanceUUID activityInstanceUUID);

  /*
   * HOOK
   */
  //Map getHooks(String processUUID, String activityId);

  /*
   * INSTANCE
   */
  Set getProcessInstances();
  Set getProcessInstances(ProcessDefinitionUUID processUUID);
  Set getProcessInstances(Collection instanceUUIDs);
  ProcessInstance getProcessInstance(ProcessInstanceUUID instanceUUID);
  Set getProcessInstancesWithTaskState(Collection acitivtyStates);
  Set getUserInstances(String userId);
  
  /*
   * TASK
   */
  Set getTaskInstances(ProcessInstanceUUID instanceUUID);
  TaskInstance getTaskInstance(ActivityInstanceUUID taskUUID);
  /** return all tasks associated to the given user and having the given state */
  Set getUserTasks(String userId, ActivityState taskState);
  Set getUserTasks(String userId, Collection taskStates);
  /** return all tasks associated to the given user and the given instance and having the given state */
  Set getUserInstanceTasks(String userId, 
      ProcessInstanceUUID instanceUUID, ActivityState taskState);
  
  /*
   * DEFINITION
   */

  Set getProcesses();
  Set getProcesses(String processId);
  Set getProcesses(ProcessDefinition.ProcessState processState);
  Set getProcesses(String processId, ProcessDefinition.ProcessState processState);
  ProcessDefinition getProcess(String processId, String version);
  ProcessDefinition getProcess(ProcessDefinitionUUID processUUID);
  ProcessDefinition getLastDeployedProcess(String processId, ProcessDefinition.ProcessState processState);

  Set getDependentProcesses(ProcessDefinitionUUID processUUID);
  Set getDependentProcesses(String className);

  ActivityDefinition getActivity(ActivityDefinitionUUID activityDefinitionUUID);
  ActivityState getActivityInstanceState(ActivityInstanceUUID activityUUID);

  /*
   * WEB
   */
  Set getWebProcessInstances(String labelId);
  Set getNewWebProcessInstances(String userId);
}