Package org.eclipse.emf.cdo.transaction

## Interface CDOCommitContext

- All Superinterfaces:
    `CDOBranchProvider`
  All Known Subinterfaces:
    `InternalCDOTransaction.InternalCDOCommitContext`, `InternalCDOXATransaction.InternalCDOXACommitContext`

      public interface CDOCommitContext
      extends CDOBranchProvider

  Provides a context for commit operations.
  Since:
    2.0
  Author:
    Simon McDuff
  No Implement
    This interface is not intended to be implemented by clients.
  No Extend
    This interface is not intended to be extended by clients.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Deprecated Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `CDOBranch` | `getBranch()` |
    `java.lang.String` | `getCommitComment()` |
    `CDOCommitData` | `getCommitData()` |
    `CDOBranchPoint` | `getCommitMergeSource()` |
    `java.util.Map<CDOID,​CDOObject>` | `getDetachedObjects()` | Returns a map of the detached `objects` that are to be committed with this commit context.
    `java.util.Map<CDOID,​CDOObject>` | `getDirtyObjects()` | Returns a map of the dirty `objects` that are to be committed with this commit context.
    `java.util.Collection<CDOID>` | `getIDsToUnlock()` |
    `java.util.Collection<CDOLob<?>>` | `getLobs()` |
    `java.util.Collection<CDOLockState>` | `getLocksOnNewObjects()` |
    `java.util.Map<CDOID,​CDOObject>` | `getNewObjects()` | Returns a map of the new `objects` that are to be committed with this commit context.
    `java.util.List<CDOPackageUnit>` | `getNewPackageUnits()` | Returns a list of the new `package units` that are to be committed with this commit context.
    `java.util.Map<CDOID,​CDORevisionDelta>` | `getRevisionDeltas()` | Returns a map of the `revision deltas` that are to be committed with this commit context.
    `CDOTransaction` | `getTransaction()` | Returns the `transaction` associated with this commit context.
    `java.lang.String` | `getUserID()` |
    `int` | `getViewID()` |
    `boolean` | `isAutoReleaseLocks()` | Deprecated. As of 4.5 no longer supported.
    `boolean` | `isPartialCommit()` |

- - ### Method Detail

    - #### getUserID

          java.lang.String getUserID()

      Since:
        4.1

    - #### getViewID

          int getViewID()

      Since:
        4.1

    - #### getBranch

          CDOBranch getBranch()

      Specified by:
        `getBranch` in interface `CDOBranchProvider`
      Since:
        4.1

    - #### getTransaction

          CDOTransaction getTransaction()

      Returns the `transaction` associated with this commit context.

    - #### isPartialCommit

          boolean isPartialCommit()

      Since:
        4.0

    - #### getCommitData

          CDOCommitData getCommitData()

      Since:
        4.1

    - #### getCommitComment

          java.lang.String getCommitComment()

      Since:
        4.1

    - #### getCommitMergeSource

          CDOBranchPoint getCommitMergeSource()

      Since:
        4.6

    - #### getNewPackageUnits

          java.util.List<CDOPackageUnit> getNewPackageUnits()

      Returns a list of the new `package units` that are to be committed with this commit context.

    - #### getNewObjects

          java.util.Map<CDOID,​CDOObject> getNewObjects()

      Returns a map of the new `objects` that are to be committed with this commit context.

    - #### getDirtyObjects

          java.util.Map<CDOID,​CDOObject> getDirtyObjects()

      Returns a map of the dirty `objects` that are to be committed with this commit context.

    - #### getDetachedObjects

          java.util.Map<CDOID,​CDOObject> getDetachedObjects()

      Returns a map of the detached `objects` that are to be committed with this commit context.

    - #### getRevisionDeltas

          java.util.Map<CDOID,​CDORevisionDelta> getRevisionDeltas()

      Returns a map of the `revision deltas` that are to be committed with this commit context.

    - #### getLobs

          java.util.Collection<CDOLob<?>> getLobs()

      Since:
        4.0

    - #### isAutoReleaseLocks

          @Deprecated
          boolean isAutoReleaseLocks()

      Deprecated.
      As of 4.5 no longer supported. See `getIDsToUnlock()`.
      Since:
        4.1

    - #### getLocksOnNewObjects

          java.util.Collection<CDOLockState> getLocksOnNewObjects()

      Since:
        4.1

    - #### getIDsToUnlock

          java.util.Collection<CDOID> getIDsToUnlock()

      Since:
        4.6