Class DeclassifyEntityProxy
java.lang.Object
org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.AbstractTransactionFunction
org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.DeclassifyEntity
org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.DeclassifyEntityProxy
Transaction function for removing a classification to an entity.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.DeclassifyEntity
xtdbDoc
-
Constructor Summary
ConstructorDescriptionDeclassifyEntityProxy
(Long txId, clojure.lang.PersistentHashMap existing, clojure.lang.PersistentHashMap proxy, String entityGUID, String classificationName) 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 updated document to write-back from the transaction.static Classification
transact
(XTDBOMRSRepositoryConnector xtdb, EntityProxy entityProxy, String classificationName) Update the status of the provided 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.AbstractTransactionFunction
createTransactionFunction, getGUID, getInstanceProvenanceType, getMetadataCollectionId, getTxnTimeCalculation, getTypeDefForInstance, getTypeDefGUID, incrementVersion, incrementVersion
-
Field Details
-
FUNCTION_NAME
public static final clojure.lang.Keyword FUNCTION_NAME
-
-
Constructor Details
-
DeclassifyEntityProxy
public DeclassifyEntityProxy(Long txId, clojure.lang.PersistentHashMap existing, clojure.lang.PersistentHashMap proxy, String entityGUID, String classificationName) throws Exception Constructor used to execute the transaction function.- Parameters:
txId
- the transaction ID of this function invocationexisting
- XTDB document to updateproxy
- XTDB document to update, if existing is emptyentityGUID
- of the entity to updateclassificationName
- name of the classification- Throws:
Exception
- on any error
-
-
Method Details
-
transact
public static Classification transact(XTDBOMRSRepositoryConnector xtdb, EntityProxy entityProxy, String classificationName) throws EntityNotKnownException, InvalidParameterException, ClassificationErrorException, RepositoryErrorException Update the status of the provided entity instance in the XTDB repository by pushing the transaction down into the repository itself.- Parameters:
xtdb
- connectivityentityProxy
- of the entity to declassifyclassificationName
- name of the classification- Returns:
- Classification that was removed
- Throws:
EntityNotKnownException
- if the entity cannot be foundInvalidParameterException
- if the entity exists but cannot be updated (deleted, reference copy, etc)ClassificationErrorException
- if there is any issue related to the classificationRepositoryErrorException
- 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
- transaction through which to create the function
-