Package org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn

Class DeleteEntity

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.AbstractTransactionFunction

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.DeleteInstance

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.DeleteEntity

public class DeleteEntity
extends DeleteInstance

Transaction function for soft-deleting an entity.

Field Summary

Fields

Modifier and Type	Field	Description
static final clojure.lang.Keyword	FUNCTION_NAME

Constructor Summary

Constructors

Constructor	Description
DeleteEntity(Long txId, clojure.lang.PersistentHashMap existing, String userId, String obsoleteEntityGUID)	Constructor used to execute the transaction function.

Method Summary

Modifier and Type	Method	Description
static void	create(xtdb.api.tx.Transaction.Builder tx)	Create the transaction function within XTDB.
clojure.lang.IPersistentMap	doc()	Interface that returns the updated document to write-back from the transaction.
static EntityDetail	transact(XTDBOMRSRepositoryConnector xtdb, String userId, String entityGUID)	Soft-delete the specified entity by pushing down the transaction.

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.DeleteInstance

deleteInstance

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.AbstractTransactionFunction

createTransactionFunction, getGUID, getInstanceProvenanceType, getMetadataCollectionId, getTxnTimeCalculation, getTypeDefForInstance, getTypeDefGUID, incrementVersion, incrementVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FUNCTION_NAME

public static final clojure.lang.Keyword FUNCTION_NAME

Constructor Details

DeleteEntity

public DeleteEntity(Long txId,
 clojure.lang.PersistentHashMap existing,
 String userId,
 String obsoleteEntityGUID)
             throws Exception

Constructor used to execute the transaction function.

Parameters:

txId - the transaction ID of this function invocation

existing - XTDB document to update

userId - doing the deletion

obsoleteEntityGUID - of the entity to delete

Throws:

Exception - on any error

Method Details

transact

public static EntityDetail transact(XTDBOMRSRepositoryConnector xtdb,
 String userId,
 String entityGUID)
                             throws EntityNotKnownException,
InvalidParameterException,
RepositoryErrorException

Soft-delete the specified entity by pushing down the transaction.

Parameters:

xtdb - connectivity

userId - doing the deletion

entityGUID - of the entity to be deleted

Returns:

the resulting deleted entity

Throws:

EntityNotKnownException - if the entity cannot be found

InvalidParameterException - if the relationship exists but is already soft-deleted

RepositoryErrorException - on any other error

doc

public clojure.lang.IPersistentMap doc()

Interface that returns the updated document to write-back from the transaction.

Returns:

IPersistentMap giving the updated document in its entirety

create

public static void create(xtdb.api.tx.Transaction.Builder tx)

Create the transaction function within XTDB.

Parameters:

tx - the transaction through which to create this function