org.identityconnectors.framework.api.operations

Interface DeleteApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

AsyncConnectorFacade, ConnectorFacade, DeleteAsyncApiOp

All Known Implementing Classes:

AbstractConnectorFacade, DeleteAsyncApiOpImpl, DeleteImpl, LocalConnectorFacadeImpl, RemoteAsyncConnectorFacade, RemoteConnectorFacadeImpl

public interface DeleteApiOp
extends APIOperation

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

NO_TIMEOUT

Method Summary

Modifier and Type	Method and Description
void	delete(ObjectClass objectClass, Uid uid, OperationOptions options) Delete the object that the specified Uid identifies (if any).

Method Detail

delete

void delete(ObjectClass objectClass,
            Uid uid,
            OperationOptions options)

Delete the object that the specified Uid identifies (if any).

Parameters:

objectClass - type of object to delete.

uid - The unique id that specifies the object to delete.

options - additional options that impact the way this operation is run. May be null.

Throws:

UnknownUidException - if the Uid does not exist on the resource.

RuntimeException - if a problem occurs during the operation (for instance, an operational timeout).