Package org.eclipse.emf.cdo.common

# Schnittstelle CDOCommonSession.Options

Alle Superschnittstellen:
  `org.eclipse.net4j.util.event.INotifier`, `org.eclipse.net4j.util.options.IOptions`

Alle bekannten Unterschnittstellen:
  `CDONet4jSession.Options`, `CDOSession.Options`, `CDOSession.Options`, `InternalSession`

Umschließende Schnittstelle:
  `CDOCommonSession`

public static interface CDOCommonSession.Options extends org.eclipse.net4j.util.options.IOptions
Encapsulates the configuration options of CDO sessions that are common to both client and server side.

Autor:
  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.

## Verschachtelte Klassen - Übersicht

Verschachtelte Klassen
Modifizierer und Typ
Schnittstelle
Beschreibung
`static interface`
`CDOCommonSession.Options.LockNotificationEvent`
An `options event` fired when the `lock notification mode` of a CDO session has changed.
`static enum`
`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 enum`
`CDOCommonSession.Options.PassiveUpdateMode`
Enumerates the possible `passive update modes` of a CDO session.

## Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen org.eclipse.net4j.util.event.INotifier

`org.eclipse.net4j.util.event.INotifier.INotifier2`

## Methodenübersicht

Modifizierer und Typ
Methode
Beschreibung
`CDOCommonSession`
`getContainer()`
Returns the `session` of this options object.
`CDOCommonSession.Options.LockNotificationMode`
`getLockNotificationMode()`
`CDOCommonSession.Options.PassiveUpdateMode`
`getPassiveUpdateMode()`
`boolean`
`isLockNotificationEnabled()`
`boolean`
`isPassiveUpdateEnabled()`
`void`
`setLockNotificationEnabled(boolean enabled)`
`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)`

### Von Schnittstelle geerbte Methoden org.eclipse.net4j.util.event.INotifier

`addListener, getListeners, hasListeners, removeListener`

## Methodendetails

### getContainer

CDOCommonSession getContainer()
Returns the `session` of this options object.

Angegeben von:
  `getContainer` in Schnittstelle `org.eclipse.net4j.util.options.IOptions`
Seit:
  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.

Seit:
  3.0

### getPassiveUpdateMode

CDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode()

Seit:
  3.0

### setPassiveUpdateMode

void setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode mode)

Seit:
  3.0

### isLockNotificationEnabled

boolean isLockNotificationEnabled()

Seit:
  4.15

### setLockNotificationEnabled

void setLockNotificationEnabled(boolean enabled)

Seit:
  4.15

### getLockNotificationMode

CDOCommonSession.Options.LockNotificationMode getLockNotificationMode()

Seit:
  4.1

### setLockNotificationMode

void setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)

Seit:
  4.1