org.eclipse.emf.cdo.common

## Interface CDOCommonSession.Options

- All Superinterfaces:
    INotifier, IOptions
  All Known Subinterfaces:
    CDONet4jSession.Options, CDOSession.Options, CDOSession.Options, InternalSession
  Enclosing interface:
    CDOCommonSession

      public static interface CDOCommonSession.Options
      extends IOptions

  Encapsulates the configuration options of CDO sessions that are common to both client and server side.
  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.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `CDOCommonSession.Options.LockNotificationMode` Enumerates the possible `lock notification modes` of a CDO session.
    `static interface` | `CDOCommonSession.Options.LockNotificationModeEvent` An `options event` fired when the `lock notification mode` of a CDO session has changed.
    `static interface` | `CDOCommonSession.Options.PassiveUpdateEvent` An `options event` fired when the `passive update mode` of a CDO session has changed.
    `static class` | `CDOCommonSession.Options.PassiveUpdateMode` Enumerates the possible `passive update modes` of a CDO session.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `CDOCommonSession` | `getContainer()` Returns the `session` of this options object.
    `CDOCommonSession.Options.LockNotificationMode` | `getLockNotificationMode()`
    `CDOCommonSession.Options.PassiveUpdateMode` | `getPassiveUpdateMode()`
    `boolean` | `isPassiveUpdateEnabled()`
    `void` | `setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)`
    `void` | `setPassiveUpdateEnabled(boolean enabled)` Specifies whether objects will be invalidated due by other users changes.
    `void` | `setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode mode)`

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

      `addListener, getListeners, hasListeners, removeListener`

- - ### Method Detail

    - #### getContainer

          CDOCommonSession getContainer()

      Returns the `session` of this options object.
      Specified by:
        `getContainer` in interface `IOptions`
      Since:
        4.0

    - #### isPassiveUpdateEnabled

          boolean isPassiveUpdateEnabled()

    - #### setPassiveUpdateEnabled

          void setPassiveUpdateEnabled(boolean enabled)

      Specifies whether objects will be invalidated due by other users changes.

      Example:

      `session.setPassiveUpdateEnabled(false);`

      By default this property is enabled. If this property is disabled the latest versions of objects can still be obtained by calling refresh().

      Passive update can be disabled in cases where more performance is needed and/or more control over when objects will be refreshed.

      When enabled again, a refresh will be automatically performed to be in sync with the server.

      Since:
        3.0

    - #### getPassiveUpdateMode

          CDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode()

      Since:
        3.0

    - #### setPassiveUpdateMode

          void setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode mode)

      Since:
        3.0

    - #### getLockNotificationMode

          CDOCommonSession.Options.LockNotificationMode getLockNotificationMode()

      Since:
        4.1

    - #### setLockNotificationMode

          void setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)

      Since:
        4.1

Copyright (c) 2004-2019 Eike Stepper (Loehne, Germany) and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html