Class RestoreRelationship
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.RestoreRelationship
Transaction function for restoring a deleted relationship back to active.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionRestoreRelationship
(Long txId, clojure.lang.PersistentHashMap existing, String userId, String relationshipGUID, String metadataCollectionId) Constructor used to execute the transaction function. -
Method Summary
Modifier and TypeMethodDescriptionstatic 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 Relationship
transact
(XTDBOMRSRepositoryConnector xtdb, String userId, String relationshipGUID) Restore the deleted relationship 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
-
Field Details
-
FUNCTION_NAME
public static final clojure.lang.Keyword FUNCTION_NAME
-
-
Constructor Details
-
RestoreRelationship
public RestoreRelationship(Long txId, clojure.lang.PersistentHashMap existing, String userId, String relationshipGUID, String metadataCollectionId) throws Exception Constructor used to execute the transaction function.- Parameters:
txId
- the transaction ID of this function invocationexisting
- XTDB document to restoreuserId
- doing the restorerelationshipGUID
- of the relationship to restoremetadataCollectionId
- of the metadata collection in which the transaction is running- Throws:
Exception
- on any error
-
-
Method Details
-
transact
public static Relationship transact(XTDBOMRSRepositoryConnector xtdb, String userId, String relationshipGUID) throws RelationshipNotKnownException, RelationshipNotDeletedException, InvalidParameterException, RepositoryErrorException Restore the deleted relationship instance in the XTDB repository by pushing the transaction down into the repository itself.- Parameters:
xtdb
- connectivityuserId
- doing the restorerelationshipGUID
- of the relationship on which to restore- Returns:
- Relationship as restored
- Throws:
RelationshipNotKnownException
- if the relationship cannot be foundRelationshipNotDeletedException
- if the relationship exists but cannot be restored because it is not deletedInvalidParameterException
- if the relationship 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
-