1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.syncope.core.flowable.api;
20
21 import java.io.OutputStream;
22 import java.util.List;
23 import org.apache.syncope.common.lib.to.BpmnProcess;
24 import org.apache.syncope.common.lib.types.BpmnProcessFormat;
25
26 public interface BpmnProcessManager {
27
28 /**
29 * @return all available workflow processes.
30 */
31 List<BpmnProcess> getProcesses();
32
33 /**
34 * Export the process for the given key, in the requested format.
35 *
36 * @param key process key
37 * @param format export format
38 * @param os export stream
39 */
40 void exportProcess(String key, BpmnProcessFormat format, OutputStream os);
41
42 /**
43 * Export the process graphical representation for the given key (if available).
44 *
45 * @param key process key
46 * @param os export stream
47 */
48 void exportDiagram(String key, OutputStream os);
49
50 /**
51 * Import the process for the given key.
52 *
53 * @param key process key
54 * @param format import format
55 * @param process process
56 */
57 void importProcess(String key, BpmnProcessFormat format, String process);
58
59 /**
60 * Remove the process for the given key.
61 *
62 * @param key process key
63 */
64 void deleteProcess(String key);
65 }