com.orientechnologies.orient.core.storage

Interface OBasicTransaction

All Known Subinterfaces:

OTransaction, OTransactionInternal

All Known Implementing Classes:

OMicroTransaction, OTransactionAbstract, OTransactionNoTx, OTransactionOptimistic, OTransactionOptimisticClient, OTransactionOptimisticDistributed, OTransactionOptimisticProxy, OTransactionOptimisticServer, OTransactionRealAbstract

public interface OBasicTransaction

Captures the basic transaction traits.

Author:

Sergey Sitnikov

Field Summary

Fields

Modifier and Type	Field and Description
static ORecord	DELETED_RECORD Indicates the record deleted in a transaction.

Method Summary

Modifier and Type	Method and Description
void	addChangedDocument(ODocument document) Adds the given document to a set of changed documents known to this transaction.
void	addIndexEntry(OIndex index, String indexName, OTransactionIndexChanges.OPERATION operation, Object key, OIdentifiable value) Adds the transactional index entry in this transaction.
void	deleteRecord(ORecord record, ODatabase.OPERATION_MODE mode) Deletes the given record in this transaction.
default int	getClientTransactionId()
Object	getCustomData(String name) Obtains the custom value by its name stored in the context of this transaction.
int	getId()
OTransactionIndexChanges	getIndexChanges(String indexName) Obtains the index changes done in the context of this transaction.
OTransactionIndexChanges	getIndexChangesInternal(String indexName) Does the same thing as getIndexChanges(String), but handles remote storages in a special way.
ORecord	getRecord(ORID rid) Resolves a record with the given RID in the context of this transaction.
boolean	isActive()
ORecord	saveRecord(ORecord record, String clusterName, ODatabase.OPERATION_MODE operationMode, boolean forceCreate, ORecordCallback<? extends Number> createdCallback, ORecordCallback<Integer> updatedCallback) Saves the given record in this transaction.
void	setCustomData(String name, Object value) Sets the custom value by its name stored in the context of this transaction.

Field Detail

DELETED_RECORD

static final ORecord DELETED_RECORD

Indicates the record deleted in a transaction.

See Also:

getRecord(ORID)

Method Detail

isActive

boolean isActive()

Returns:

true if this transaction is active, false otherwise.

saveRecord

ORecord saveRecord(ORecord record,
                   String clusterName,
                   ODatabase.OPERATION_MODE operationMode,
                   boolean forceCreate,
                   ORecordCallback<? extends Number> createdCallback,
                   ORecordCallback<Integer> updatedCallback)

Saves the given record in this transaction.

Parameters:

record - the record to save.

clusterName - record's cluster name.

operationMode - the operation mode.

forceCreate - the force creation flag, true to force the creation of the record, false to allow updates.

createdCallback - the callback to invoke when the record save operation triggered the creation of the record.

updatedCallback - the callback to invoke when the record save operation triggered the update of the record.

Returns:

the record saved.

deleteRecord

void deleteRecord(ORecord record,
                  ODatabase.OPERATION_MODE mode)

Deletes the given record in this transaction.

Parameters:

record - the record to delete.

mode - the operation mode.

getRecord

ORecord getRecord(ORID rid)

Resolves a record with the given RID in the context of this transaction.

Parameters:

rid - the record RID.

Returns:

the resolved record, or null if no record is found, or DELETED_RECORD if the record was deleted in this transaction.

addIndexEntry

void addIndexEntry(OIndex index,
                   String indexName,
                   OTransactionIndexChanges.OPERATION operation,
                   Object key,
                   OIdentifiable value)

Adds the transactional index entry in this transaction.

Parameters:

index - the index.

indexName - the index name.

operation - the index operation to register.

key - the index key.

value - the index key value.

addChangedDocument

void addChangedDocument(ODocument document)

Adds the given document to a set of changed documents known to this transaction.

Parameters:

document - the document to add.

getIndexChanges

OTransactionIndexChanges getIndexChanges(String indexName)

Obtains the index changes done in the context of this transaction.

Parameters:

indexName - the index name.

Returns:

the index changes in question or null if index is not found.

getIndexChangesInternal

OTransactionIndexChanges getIndexChangesInternal(String indexName)

Does the same thing as getIndexChanges(String), but handles remote storages in a special way.

Parameters:

indexName - the index name.

Returns:

the index changes in question or null if index is not found or storage is remote.

getCustomData

Object getCustomData(String name)

Obtains the custom value by its name stored in the context of this transaction.

Parameters:

name - the value name.

Returns:

the obtained value or null if no value found.

setCustomData

void setCustomData(String name,
                   Object value)

Sets the custom value by its name stored in the context of this transaction.

Parameters:

name - the value name.

value - the value to store.

getClientTransactionId

default int getClientTransactionId()

Returns:

this transaction ID as seen by the client of this transaction.

getId

int getId()