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

Class UpdateEntityProperties

java.lang.Object

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

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

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

public class UpdateEntityProperties
extends UpdateInstanceProperties

Transaction function for updating InstanceProperties on a metadata instance.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
UpdateEntityProperties(Long txId, clojure.lang.PersistentHashMap existing, String userId, String entityGUID, String metadataCollectionId, InstanceProperties properties)	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, InstanceProperties properties)	Update the properties 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.UpdateInstanceProperties

updateInstanceProperties, updateInstanceProperties, validate

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

UpdateEntityProperties

public UpdateEntityProperties(Long txId,
 clojure.lang.PersistentHashMap existing,
 String userId,
 String entityGUID,
 String metadataCollectionId,
 InstanceProperties properties)
                       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 update

entityGUID - of the entity to update

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

properties - to apply to the entity

Throws:

Exception - on any error

Method Details

transact

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

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

Parameters:

xtdb - connectivity

userId - doing the update

entityGUID - of the entity on which to update the properties

properties - to apply to the entity

Returns:

EntityDetail of the entity with the new properties applied

Throws:

EntityNotKnownException - if the entity cannot be found

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

PropertyErrorException - one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this instance's type

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