• Home
• org.ow2.bonita
• bonita-server
• 5.10.2
• source code
• WebAPI.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.ow2.bonita.facade.WebAPI Maven / Gradle / Ivy

/**
 * Copyright (C) 2009  BonitaSoft S.A.
 * BonitaSoft, 31 rue Gustave Eiffel - 38000 Grenoble
 * 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.
 **/
package org.ow2.bonita.facade;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.ow2.bonita.facade.exception.CategoryAlreadyExistsException;
import org.ow2.bonita.facade.exception.CategoryNotFoundException;
import org.ow2.bonita.facade.exception.DocumentAlreadyExistsException;
import org.ow2.bonita.facade.exception.DocumentationCreationException;
import org.ow2.bonita.facade.exception.ProcessNotFoundException;
import org.ow2.bonita.facade.runtime.ActivityInstance;
import org.ow2.bonita.facade.runtime.Category;
import org.ow2.bonita.facade.runtime.Document;
import org.ow2.bonita.facade.runtime.Label;
import org.ow2.bonita.facade.uuid.CategoryUUID;
import org.ow2.bonita.facade.uuid.ProcessDefinitionUUID;
import org.ow2.bonita.facade.uuid.ProcessInstanceUUID;
import org.ow2.bonita.light.LightProcessDefinition;
import org.ow2.bonita.light.LightProcessInstance;

/**
 * Internal use only.
 */
public interface WebAPI {

  @Deprecated
  List getSystemLabels(String ownerName);

  @Deprecated
  List getUserCustomLabels(String ownerName);

  Label getLabel(String ownerName, String labelName);

  Set getLabels(String ownerName);

  void addLabel(String labelName, String ownerName, String editableCSSStyleName, String readonlyCSSStyleName, 
      String previewCSSStyleName, boolean isVisible, boolean hasToBeDisplayed, String iconCSSStyle, 
      Set caseList, int displayOrder, boolean isSystemLabel);

  void removeLabel(String ownerName, String labelName);

  void removeLabels(String ownerName, Collection labelNames);

  void addCasesToLabel(String ownerName, String labelName, Set caseList);

  void removeCasesFromLabel(String ownerName, String labelName, Set caseList);

  void updateLabelCSS(String ownerName, String labelName, String aEditableCSSStyle, String aPreviewCSSStyle, String aReadOnlyCSSStyle);

  void updateLabelVisibility(String ownerName, String labelName, boolean isVisible);

  void updateLabelVisibility(String ownerName, Map labelvisibilities);

  void updateLabelName(String ownerName, String labelName, String newName);

  Set getCaseLabels(String ownerName, ProcessInstanceUUID case_);

  Map> getCasesLabels(String ownerName, Set cases);

  void removeAllCasesFromLabels(Set caseList);

  Set getLabels(String ownerName, Set labelsName);
  void removeAllLabelsExcept(Set labelNames);
  void removeLabels(Set labelNames);

  Map getCasesNumber(String owner, Collection labelNames, int limit);
  Map getCasesNumber(String owner, Collection labelNames);
  Map getCasesNumber(String owner, String labelName, Collection labelNames, int limit);

  Set getCases(String ownerName, Set labels);

  List getLightProcessInstances(String ownerName, Set theLabelsName, int startingIndex, int maxElementCount);

  void deletePhantomCases();
  void deleteAllCases();

  String generateTemporaryToken(String identityKey);
  String getIdentityKeyFromTemporaryToken(String token);

  Set getAllCategories();
  Set getCategories(Set names);
  Set getCategoriesByUUIDs(Set uuids);
  Set getAllCategoriesByUUIDExcept(Set uuids);
  void deleteCategoriesByUUIDs(Set uuids);
  void deleteCategories(Set categoryNames);

  void executeConnectorAndSetVariables(String connectorClassName, Map parameters, ActivityInstance activityInstance, Map context) throws Exception;
  Map executeConnectorAndGetVariablesToSet(String connectorClassName, Map parameters, ProcessDefinitionUUID processDefinitionUUID, Map context) throws Exception;

  LightProcessDefinition setProcessCategories(ProcessDefinitionUUID aUUID, Set aCategoriesName) throws ProcessNotFoundException;

  void addCategory(String name, String iconCSSStyle, String previewCSSStyleName, String cssStyleName) throws CategoryAlreadyExistsException;

  Category updateCategoryByUUID(String value, String name, String iconCSSStyle, String previewCSSStyleName, String cssStyleName) throws CategoryNotFoundException, CategoryAlreadyExistsException;

  Document addProcessDocumentTemplate(String name, ProcessDefinitionUUID processDefinitionUUID, String fileName, String mimeType, byte[] content)
  throws ProcessNotFoundException, DocumentAlreadyExistsException, DocumentationCreationException;

  List getProcessDocumentTemplates(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException, DocumentationCreationException;
}