Package org.eclipse.emf.cdo.common
Interface CDOCommonSession.Options
-
- All Superinterfaces:
org.eclipse.net4j.util.event.INotifier,org.eclipse.net4j.util.options.IOptions
- All Known Subinterfaces:
CDONet4jSession.Options,CDOSession.Options,CDOSession.Options,InternalSession
- Enclosing interface:
- CDOCommonSession
public static interface CDOCommonSession.Options extends org.eclipse.net4j.util.options.IOptionsEncapsulates 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 Description static interfaceCDOCommonSession.Options.LockNotificationEventAnoptions eventfired when thelock notification modeof a CDO session has changed.static classCDOCommonSession.Options.LockNotificationModeEnumerates the possiblelock notification modesof a CDO session.static interfaceCDOCommonSession.Options.LockNotificationModeEventAnoptions eventfired when thelock notification modeof a CDO session has changed.static interfaceCDOCommonSession.Options.PassiveUpdateEventAnoptions eventfired when thepassive update modeof a CDO session has changed.static classCDOCommonSession.Options.PassiveUpdateModeEnumerates the possiblepassive update modesof a CDO session.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CDOCommonSessiongetContainer()Returns thesessionof this options object.CDOCommonSession.Options.LockNotificationModegetLockNotificationMode()CDOCommonSession.Options.PassiveUpdateModegetPassiveUpdateMode()booleanisLockNotificationEnabled()booleanisPassiveUpdateEnabled()voidsetLockNotificationEnabled(boolean enabled)voidsetLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)voidsetPassiveUpdateEnabled(boolean enabled)Specifies whether objects will be invalidated due by other users changes.voidsetPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode mode)
-
-
-
Method Detail
-
getContainer
CDOCommonSession getContainer()
Returns thesessionof this options object.- Specified by:
getContainerin interfaceorg.eclipse.net4j.util.options.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
-
isLockNotificationEnabled
boolean isLockNotificationEnabled()
- Since:
- 4.15
-
setLockNotificationEnabled
void setLockNotificationEnabled(boolean enabled)
- Since:
- 4.15
-
getLockNotificationMode
CDOCommonSession.Options.LockNotificationMode getLockNotificationMode()
- Since:
- 4.1
-
setLockNotificationMode
void setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)
- Since:
- 4.1
-
-