1 /*
2 * ====================
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 *
5 * Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
6 *
7 * The contents of this file are subject to the terms of the Common Development
8 * and Distribution License("CDDL") (the "License"). You may not use this file
9 * except in compliance with the License.
10 *
11 * You can obtain a copy of the License at
12 * http://IdentityConnectors.dev.java.net/legal/license.txt
13 * See the License for the specific language governing permissions and limitations
14 * under the License.
15 *
16 * When distributing the Covered Code, include this CDDL Header Notice in each file
17 * and include the License file at identityconnectors/legal/license.txt.
18 * If applicable, add the following below this CDDL Header, with the fields
19 * enclosed by brackets [] replaced by your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
21 * ====================
22 */
23 package org.identityconnectors.framework.api.operations;
24
25 import org.identityconnectors.framework.common.exceptions.UnknownUidException;
26 import org.identityconnectors.framework.common.objects.ObjectClass;
27 import org.identityconnectors.framework.common.objects.OperationOptions;
28 import org.identityconnectors.framework.common.objects.Uid;
29
30 public interface DeleteApiOp extends APIOperation {
31
32 /**
33 * Delete the object that the specified Uid identifies (if any).
34 *
35 * @param objClass
36 * type of object to delete.
37 * @param uid
38 * The unique id that specifies the object to delete.
39 * @param options
40 * additional options that impact the way this operation is run.
41 * May be null.
42 * @throws UnknownUidException
43 * iff the {@link Uid} does not exist on the resource.
44 * @throws RuntimeException
45 * iff a problem occurs during the operation (for instance, an
46 * operational timeout).
47 */
48 public void delete(final ObjectClass objClass, final Uid uid, final OperationOptions options);
49 }