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

Class DeclassifyEntityDetail

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.DeclassifyEntityDetail

public class DeclassifyEntityDetail
extends DeclassifyEntity

Transaction function for removing a classification to an entity.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DeclassifyEntityDetail(Long txId, clojure.lang.PersistentHashMap existing, String entityGUID, String classificationName)	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 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail	transact(XTDBOMRSRepositoryConnector xtdb, String entityGUID, 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

getGUID, getInstanceProvenanceType, getMetadataCollectionId, getTypeDefForInstance, getTypeDefGUID

Methods inherited from class java.lang.Object

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

Field Details

FUNCTION_NAME

public static final clojure.lang.Keyword FUNCTION_NAME

Constructor Details

DeclassifyEntityDetail

public DeclassifyEntityDetail(Long txId,
 clojure.lang.PersistentHashMap existing,
 String entityGUID,
 String classificationName)
                       throws Exception

Constructor used to execute the transaction function.

Parameters:

txId - the transaction ID of this function invocation

existing - XTDB document to update

entityGUID - of the entity to update

classificationName - name of the classification

Throws:

Exception - on any error

Method Details

transact

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail transact(XTDBOMRSRepositoryConnector xtdb,
 String entityGUID,
 String classificationName)
                                                                                                                                     throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.ClassificationErrorException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException

Update the status of the provided entity instance in the XTDB repository by pushing the transaction down into the repository itself.

Parameters:

xtdb - connectivity

entityGUID - of the entity on which to update the status

classificationName - name of the classification

Returns:

EntityDetail of the entity with the new status applied

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - if the entity cannot be found

org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - if the entity exists but cannot be updated (deleted, reference copy, etc)

org.odpi.openmetadata.repositoryservices.ffdc.exception.ClassificationErrorException - if there is any issue related to the classification

org.odpi.openmetadata.repositoryservices.ffdc.exception.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 - transaction through which to create the function