org.eclipse.emf.cdo.common
Interface CDOCommonSession.Options

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

public static interface CDOCommonSession.Options
extends IOptions

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
static interface CDOCommonSession.Options.PassiveUpdateEvent
           
static class CDOCommonSession.Options.PassiveUpdateMode
           
 
Method Summary
 CDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode()
           
 boolean isPassiveUpdateEnabled()
           
 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.options.IOptions
getContainer
 
Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener
 

Method Detail

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


Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.