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.workflow.api;
20
21 import org.apache.syncope.common.lib.request.AnyObjectCR;
22 import org.apache.syncope.common.lib.request.AnyObjectUR;
23 import org.apache.syncope.core.provisioning.api.WorkflowResult;
24
25 /**
26 * Interface for calling underlying workflow implementations.
27 */
28 public interface AnyObjectWorkflowAdapter extends WorkflowAdapter {
29
30 /**
31 * Create an anyObject.
32 *
33 * @param anyObjectCR anyObject to be created and whether to propagate it as active
34 * @param creator username that requested this operation
35 * @param context context information
36 * @return anyObject just created
37 */
38 WorkflowResult<String> create(AnyObjectCR anyObjectCR, String creator, String context);
39
40 /**
41 * Update an anyObject.
42 *
43 * @param anyObjectUR modification set to be performed
44 * @param updater username that requested this operation
45 * @param context context information
46 * @return anyObject just updated and propagations to be performed
47 */
48 WorkflowResult<AnyObjectUR> update(AnyObjectUR anyObjectUR, String updater, String context);
49
50 /**
51 * Delete an anyObject.
52 *
53 * @param anyObjectKey anyObject to be deleted
54 * @param eraser username that requested this operation
55 * @param context context information
56 */
57 void delete(String anyObjectKey, String eraser, String context);
58 }