Package org.eclipse.emf.cdo.session
Interface CDOSession.Options
- 
- All Superinterfaces:
- CDOCommonSession.Options,- org.eclipse.net4j.util.event.INotifier,- org.eclipse.net4j.util.options.IOptions
 - All Known Subinterfaces:
- CDONet4jSession.Options,- CDOSession.Options
 - Enclosing interface:
- CDOSession
 
 public static interface CDOSession.Options extends CDOCommonSession.Options Encapsulates a set of notifyingsessionconfiguration options.The session options can fire the following events: -  CDOSession.Options.GeneratedPackageEmulationEventafter thegenerated package emulation modehas changed.
-  CDOSession.Options.CollectionLoadingPolicyEventafter thecollection loading policyhas changed.
-  CDOSession.Options.LobCacheEventafter thelarge object cachehas changed.
 - 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 SummaryNested Classes Modifier and Type Interface Description static interfaceCDOSession.Options.CollectionLoadingPolicyEventstatic interfaceCDOSession.Options.DelegableViewLockEventstatic interfaceCDOSession.Options.GeneratedPackageEmulationEventAnoptions eventfired when thegenerated package emulation enabledoption of asessionhas changed.static interfaceCDOSession.Options.LobCacheEventstatic interfaceCDOSession.Options.PermissionUpdaterEvent- 
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.OptionsCDOCommonSession.Options.LockNotificationEvent, CDOCommonSession.Options.LockNotificationMode, CDOCommonSession.Options.LockNotificationModeEvent, CDOCommonSession.Options.PassiveUpdateEvent, CDOCommonSession.Options.PassiveUpdateMode
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description CDOCollectionLoadingPolicygetCollectionLoadingPolicy()Thecollection loading policyof thissessioncontrols how a list gets populated.CDOSessiongetContainer()Returns thesessionof this options object.CDOLobStoregetLobCache()Returns thelarge object cachecurrently being used by this session.CDOPermissionUpdatergetPermissionUpdater()Returns thepermission updatercurrently being used by this session.booleanisDelegableViewLockEnabled()booleanisGeneratedPackageEmulationEnabled()voidsetCollectionLoadingPolicy(CDOCollectionLoadingPolicy policy)Sets thecollection loadingto be used by this session.voidsetDelegableViewLockEnabled(boolean delegableViewLockEnabled)This method is useful, for example, if EMFadapterscallDisplay.syncExec()in response to CDO notifications.voidsetGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled)voidsetLobCache(CDOLobStore lobCache)Sets thelarge object cacheto be used by this session.voidsetPermissionUpdater(CDOPermissionUpdater permissionUpdater)Sets thepermission updaterto be used by this session.- 
Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.OptionsgetLockNotificationMode, getPassiveUpdateMode, isLockNotificationEnabled, isPassiveUpdateEnabled, setLockNotificationEnabled, setLockNotificationMode, setPassiveUpdateEnabled, setPassiveUpdateMode
 
- 
 
- 
- 
- 
Method Detail- 
getContainerCDOSession getContainer() Returns thesessionof this options object.- Specified by:
- getContainerin interface- CDOCommonSession.Options
- Specified by:
- getContainerin interface- org.eclipse.net4j.util.options.IOptions
- Since:
- 4.0
 
 - 
isGeneratedPackageEmulationEnabledboolean isGeneratedPackageEmulationEnabled() 
 - 
setGeneratedPackageEmulationEnabledvoid setGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled) 
 - 
getCollectionLoadingPolicyCDOCollectionLoadingPolicy getCollectionLoadingPolicy() Thecollection loading policyof thissessioncontrols how a list gets populated. By default, when an object is fetched, all its elements are filled with the proper values.This could be time-consuming, especially if the reference list does not need to be accessed. In CDO it is possible to partially load collections. The default list implementation that is shipped with CDO makes a distinction between the two following situations: - How many CDOIDs to fill when an object is loaded for the first time;
- Which elements to fill with CDOIDs when the accessed element is not yet filled.
 CDOUtil.createCollectionLoadingPolicy(initialElements, subsequentElements);The user can also provide its own implementation of the CDOCollectionLoadingPolicy interface. 
 - 
setCollectionLoadingPolicyvoid setCollectionLoadingPolicy(CDOCollectionLoadingPolicy policy) Sets thecollection loadingto be used by this session.
 - 
getLobCacheCDOLobStore getLobCache() Returns thelarge object cachecurrently being used by this session.- Since:
- 4.0
 
 - 
setLobCachevoid setLobCache(CDOLobStore lobCache) Sets thelarge object cacheto be used by this session.- Since:
- 4.0
 
 - 
getPermissionUpdaterCDOPermissionUpdater getPermissionUpdater() Returns thepermission updatercurrently being used by this session.- Since:
- 4.3
 
 - 
setPermissionUpdatervoid setPermissionUpdater(CDOPermissionUpdater permissionUpdater) Sets thepermission updaterto be used by this session.- Since:
- 4.3
 
 - 
isDelegableViewLockEnabledboolean isDelegableViewLockEnabled() - Since:
- 4.5
 
 - 
setDelegableViewLockEnabledvoid setDelegableViewLockEnabled(boolean delegableViewLockEnabled) This method is useful, for example, if EMFadapterscallDisplay.syncExec()in response to CDO notifications. In these cases aDelegableReentrantLockcan be injected into the newview, which does not deadlock when both CDO's invalidation thread and the display thread acquire the view lock.- Since:
- 4.5
- See Also:
- CDOUtil.setNextViewLock(Lock)
 
 
- 
 
-