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

Class UpdateEntityStatus

java.lang.Object

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

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

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

public class UpdateEntityStatus
extends UpdateInstanceStatus

Transaction function for updating an entity's status.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
UpdateEntityStatus(Long txId, clojure.lang.PersistentHashMap existing, String userId, String entityGUID, String metadataCollectionId, Integer instanceStatus)	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, InstanceStatus newStatus)	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.UpdateInstanceStatus

updateInstanceStatus, 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

UpdateEntityStatus

public UpdateEntityStatus(Long txId,
 clojure.lang.PersistentHashMap existing,
 String userId,
 String entityGUID,
 String metadataCollectionId,
 Integer instanceStatus)
                   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

instanceStatus - to apply to the entity

Throws:

Exception - on any error

Method Details

transact

public static EntityDetail transact(XTDBOMRSRepositoryConnector xtdb,
 String userId,
 String entityGUID,
 InstanceStatus newStatus)
                             throws EntityNotKnownException,
StatusNotSupportedException,
InvalidParameterException,
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

userId - doing the update

entityGUID - of the entity on which to update the status

newStatus - to apply to the entity

Returns:

EntityDetail of the entity with the new status applied

Throws:

EntityNotKnownException - if the entity cannot be found

StatusNotSupportedException - if the provided status is not supported by the entity

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

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