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

Class RestoreEntity

java.lang.Object

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

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

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

public class RestoreEntity
extends RestoreInstance

Transaction function for restoring a deleted entity back to active.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RestoreEntity(Long txId, clojure.lang.PersistentHashMap existing, String userId, String entityGUID, String metadataCollectionId)	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 restored document to write-back from the transaction.
static EntityDetail	transact(XTDBOMRSRepositoryConnector xtdb, String userId, String entityGUID)	Restore the deleted entity instance in the XTDB repository by pushing the transaction down into the repository itself.

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

restoreInstance

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

RestoreEntity

public RestoreEntity(Long txId,
 clojure.lang.PersistentHashMap existing,
 String userId,
 String entityGUID,
 String metadataCollectionId)
              throws Exception

Constructor used to execute the transaction function.

Parameters:

txId - the transaction ID of this function invocation

existing - XTDB document to restore

userId - doing the restore

entityGUID - of the entity to restore

metadataCollectionId - of the metadata collection in which the transaction is running

Throws:

Exception - on any error

Method Details

transact

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

Restore the deleted entity instance in the XTDB repository by pushing the transaction down into the repository itself.

Parameters:

xtdb - connectivity

userId - doing the restore

entityGUID - of the entity on which to restore

Returns:

EntityDetail as restored

Throws:

EntityNotKnownException - if the entity cannot be found

EntityNotDeletedException - if the entity exists but cannot be restored because it is not deleted

InvalidParameterException - if the entity exists but cannot be restored (reference copy, etc)

RepositoryErrorException - on any other error

doc

public clojure.lang.IPersistentMap doc()

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

Returns:

IPersistentMap giving the restored document in its entirety

create

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

Create the transaction function within XTDB.

Parameters:

tx - transaction through which to create the function