CDOTransaction (CDO Model Repository Documentation)

All Superinterfaces:

CDOBranchPoint, CDOChangeSetDataProvider, CDOCommitHistory.Provider<CDOObject,CDOObjectHistory>, CDOCommonTransaction, CDOCommonView, CDOLockOwner, CDORevisionProvider, CDOTimeProvider, CDOUpdatable, CDOUserTransaction, CDOView, Closeable, IAdaptable, IContainer<CDOResourceNode>, INotifier, IOptionsContainer

All Known Subinterfaces:

InternalCDOTransaction

All Known Implementing Classes:

CDOPushTransaction
```
public interface CDOTransaction
extends CDOView, CDOCommonTransaction, CDOUserTransaction, CDOChangeSetDataProvider
```
A read-write view to the current (i.e. latest) state of the object graph in the repository.

Since:

2.0

No Implement

This interface is not intended to be implemented by clients.

No Extend

This interface is not intended to be extended by clients.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface CDOTransaction.Options
Encapsulates a set of notifying transaction configuration options.
- Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer
  IContainer.Modifiable<E>

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CDOTransaction.Options` Encapsulates a set of notifying `transaction` configuration options.

Field Summary
- Fields inherited from interface org.eclipse.emf.cdo.util.CDOUpdatable
  NO_TIMEOUT
- Fields inherited from interface org.eclipse.emf.cdo.common.branch.CDOBranchPoint
  INVALID_DATE, UNSPECIFIED_DATE

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTransactionHandler(CDOTransactionHandlerBase handler)`
`CDOBinaryResource`	`createBinaryResource(String path)`
`CDOQuery`	`createQuery(String language, String queryString, boolean considerDirtyState)`
`CDOQuery`	`createQuery(String language, String queryString, Object context, boolean considerDirtyState)`
`CDOResource`	`createResource(String path)`
`CDOResourceFolder`	`createResourceFolder(String path)`
`CDOTextResource`	`createTextResource(String path)`
`CDOSavepoint[]`	`exportChanges(OutputStream out)`
`String`	`getCommitComment()` Returns the comment to be used in the next commit operation.
`Set<? extends EObject>`	`getCommittables()`
`Set<CDOObject>`	`getConflicts()`
`Map<CDOID,CDOObject>`	`getDetachedObjects()`
`Map<CDOID,CDOObject>`	`getDirtyObjects()`
`CDOSavepoint`	`getFirstSavepoint()`
`long`	`getLastCommitTime()`
`CDOSavepoint`	`getLastSavepoint()`
`Map<CDOID,CDOObject>`	`getNewObjects()`
`CDOBinaryResource`	`getOrCreateBinaryResource(String path)`
`CDOResource`	`getOrCreateResource(String path)`
`CDOResourceFolder`	`getOrCreateResourceFolder(String path)`
`CDOTextResource`	`getOrCreateTextResource(String path)`
`Map<CDOID,CDORevisionDelta>`	`getRevisionDeltas()`
`CDOTransactionHandler[]`	`getTransactionHandlers()`
`CDOTransactionHandler1[]`	`getTransactionHandlers1()`
`CDOTransactionHandler2[]`	`getTransactionHandlers2()`
`boolean`	`hasConflict()` Returns `true` if this transaction contains local modifications that are conflicting with remote modifications, `false` otherwise.
`CDOSavepoint[]`	`importChanges(InputStream in, boolean reconstructSavepoints)`
`boolean`	`isDirty()` Returns `true` if this transaction is not closed and contains uncommitted changes, `false` otherwise.
`CDOChangeSetData`	`merge(CDOBranchPoint source, CDOBranchPoint sourceBase, CDOMerger merger)`
`CDOChangeSetData`	`merge(CDOBranchPoint source, CDOMerger merger)`
`CDOTransaction.Options`	`options()` Returns the `options` of this view.
`void`	`removeTransactionHandler(CDOTransactionHandlerBase handler)`
`void`	`setCommitComment(String comment)` Sets the comment to be used in the next commit operation.
`void`	`setCommittables(Set<? extends EObject> committables)`
`CDOSavepoint`	`setSavepoint()` Creates a save point in the `CDOTransaction` that can be used to roll back a part of the transaction Save points do not involve the server side, everything is done on the client side.

Methods inherited from interface org.eclipse.emf.cdo.util.CDOUpdatable
getLastUpdateTime, waitForUpdate, waitForUpdate

Methods inherited from interface org.eclipse.emf.cdo.common.commit.CDOCommitHistory.Provider
getHistory, getHistory

Methods inherited from interface org.eclipse.net4j.util.container.IContainer
getElements, isEmpty

Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener

Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonView
getDurableLockingID, getViewID, isReadOnly

Methods inherited from interface org.eclipse.emf.cdo.common.lock.CDOLockOwner
getSessionID, isDurableView

Methods inherited from interface org.eclipse.emf.cdo.common.branch.CDOBranchPoint
getBranch, getTimeStamp

Methods inherited from interface org.eclipse.emf.cdo.common.revision.CDORevisionProvider
getRevision

Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter

Methods inherited from interface org.eclipse.net4j.util.collection.Closeable
close, isClosed

Methods inherited from interface org.eclipse.emf.cdo.transaction.CDOUserTransaction
commit, commit, rollback

Methods inherited from interface org.eclipse.emf.cdo.common.commit.CDOChangeSetDataProvider
getChangeSetData

Method Detail

isDirty
```
boolean isDirty()
```
Returns true if this transaction is not closed and contains uncommitted changes, false otherwise.

Specified by:

isDirty in interface CDOView

See Also:
isDirty()

hasConflict
```
boolean hasConflict()
```
Returns true if this transaction contains local modifications that are conflicting with remote modifications, false otherwise.

Specified by:

hasConflict in interface CDOView

See Also:
hasConflict()

getConflicts
```
Set<CDOObject> getConflicts()
```

merge

CDOChangeSetData merge(CDOBranchPoint source,
                     CDOMerger merger)

Since:: 3.0

merge

CDOChangeSetData merge(CDOBranchPoint source,
                     CDOBranchPoint sourceBase,
                     CDOMerger merger)

Since:: 4.0

createResourceFolder

CDOResourceFolder createResourceFolder(String path)

Since:: 4.0

getOrCreateResourceFolder

CDOResourceFolder getOrCreateResourceFolder(String path)

Since:: 4.0

createResource
```
CDOResource createResource(String path)
```
See Also:
ResourceSet.createResource(URI)

getOrCreateResource

CDOResource getOrCreateResource(String path)

createTextResource

CDOTextResource createTextResource(String path)

Since:: 4.2

getOrCreateTextResource

CDOTextResource getOrCreateTextResource(String path)

Since:: 4.2

createBinaryResource

CDOBinaryResource createBinaryResource(String path)

Since:: 4.2

getOrCreateBinaryResource

CDOBinaryResource getOrCreateBinaryResource(String path)

Since:: 4.2

addTransactionHandler

void addTransactionHandler(CDOTransactionHandlerBase handler)

Since:: 4.0

removeTransactionHandler

void removeTransactionHandler(CDOTransactionHandlerBase handler)

Since:: 4.0

getTransactionHandlers

CDOTransactionHandler[] getTransactionHandlers()

Since:: 3.0

getTransactionHandlers1

CDOTransactionHandler1[] getTransactionHandlers1()

Since:: 4.0

getTransactionHandlers2

CDOTransactionHandler2[] getTransactionHandlers2()

Since:: 4.0

setSavepoint
```
CDOSavepoint setSavepoint()
```
Description copied from interface: CDOUserTransaction

Creates a save point in the CDOTransaction that can be used to roll back a part of the transaction
Save points do not involve the server side, everything is done on the client side.

Specified by:

setSavepoint in interface CDOUserTransaction

Since:

3.0

getFirstSavepoint
```
CDOSavepoint getFirstSavepoint()
```
Since:

4.1

getLastSavepoint
```
CDOSavepoint getLastSavepoint()
```
Specified by:

getLastSavepoint in interface CDOUserTransaction

Since:

3.0

getNewObjects
```
Map<CDOID,CDOObject> getNewObjects()
```

getDetachedObjects

Map<CDOID,CDOObject> getDetachedObjects()

Since:: 2.0

getDirtyObjects
```
Map<CDOID,CDOObject> getDirtyObjects()
```

getRevisionDeltas

Map<CDOID,CDORevisionDelta> getRevisionDeltas()

exportChanges

CDOSavepoint[] exportChanges(OutputStream out)
                             throws IOException

Throws:: IOException
Since:: 3.0

importChanges

CDOSavepoint[] importChanges(InputStream in,
                           boolean reconstructSavepoints)
                             throws IOException

Throws:: IOException
Since:: 3.0

getLastCommitTime
```
long getLastCommitTime()
```

getCommitComment
```
String getCommitComment()
```
Returns the comment to be used in the next commit operation.

Since:

3.0

See Also:
CDOCommitInfo.getComment()

setCommitComment
```
void setCommitComment(String comment)
```
Sets the comment to be used in the next commit operation.

Since:

3.0

See Also:
CDOCommitInfo.getComment()

setCommittables

void setCommittables(Set<? extends EObject> committables)

Since:: 4.0

getCommittables

Set<? extends EObject> getCommittables()

Since:: 4.0

createQuery

CDOQuery createQuery(String language,
                   String queryString,
                   boolean considerDirtyState)

Since:: 4.0

createQuery

CDOQuery createQuery(String language,
                   String queryString,
                   Object context,
                   boolean considerDirtyState)

Since:: 4.0

options
```
CDOTransaction.Options options()
```
Description copied from interface: CDOCommonView

Returns the options of this view.

Specified by:

options in interface CDOCommonView

Specified by:

options in interface CDOView

Specified by:

options in interface IOptionsContainer

Interface CDOTransaction

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer

Field Summary

Fields inherited from interface org.eclipse.emf.cdo.util.CDOUpdatable

Fields inherited from interface org.eclipse.emf.cdo.common.branch.CDOBranchPoint

Method Summary

Methods inherited from interface org.eclipse.emf.cdo.view.CDOView

Methods inherited from interface org.eclipse.emf.cdo.util.CDOUpdatable

Methods inherited from interface org.eclipse.emf.cdo.common.commit.CDOCommitHistory.Provider

Methods inherited from interface org.eclipse.net4j.util.container.IContainer

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonView

Methods inherited from interface org.eclipse.emf.cdo.common.lock.CDOLockOwner

Methods inherited from interface org.eclipse.emf.cdo.common.branch.CDOBranchPoint

Methods inherited from interface org.eclipse.emf.cdo.common.revision.CDORevisionProvider

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

Methods inherited from interface org.eclipse.net4j.util.collection.Closeable

Methods inherited from interface org.eclipse.emf.cdo.transaction.CDOUserTransaction

Methods inherited from interface org.eclipse.emf.cdo.common.commit.CDOChangeSetDataProvider

Method Detail

isDirty

hasConflict

getConflicts

merge

merge

createResourceFolder

getOrCreateResourceFolder

createResource

getOrCreateResource

createTextResource

getOrCreateTextResource

createBinaryResource

getOrCreateBinaryResource

addTransactionHandler

removeTransactionHandler

getTransactionHandlers

getTransactionHandlers1

getTransactionHandlers2

setSavepoint

getFirstSavepoint

getLastSavepoint

getNewObjects

getDetachedObjects

getDirtyObjects

getRevisionDeltas

exportChanges

importChanges

getLastCommitTime

getCommitComment

setCommitComment

setCommittables

getCommittables

createQuery

createQuery

options