Package org.eclipse.emf.cdo.transaction
Interface CDOTransaction.Options
- 
- All Superinterfaces:
- CDOCommonView.Options,- CDOView.Options,- org.eclipse.net4j.util.event.INotifier,- org.eclipse.net4j.util.options.IOptions
 - Enclosing interface:
- CDOTransaction
 
 public static interface CDOTransaction.Options extends CDOView.Options Encapsulates a set of notifyingtransactionconfiguration options.- 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 interfaceCDOTransaction.Options.AttachedRevisionsMapstatic interfaceCDOTransaction.Options.AutoReleaseLocksEventAnoptions eventfired from transactionoptionswhen theauto release locks enabledorauto release locks exemptionsoptions have changed.static interfaceCDOTransaction.Options.CommitInfoTimeoutstatic interfaceCDOTransaction.Options.ConflictResolversEventstatic interfaceCDOTransaction.Options.StaleReferenceCleanerEventAnoptions eventfired from transactionoptionswhen thestale reference cleaneroption has changed.static interfaceCDOTransaction.Options.UndoDetectorEvent- 
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonView.OptionsCDOCommonView.Options.LockNotificationEvent
 - 
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.view.CDOView.OptionsCDOView.Options.CacheReferenceTypeEvent, CDOView.Options.ChangeSubscriptionPoliciesEvent, CDOView.Options.ClearAdapterPolicyEvent, CDOView.Options.DetachmentNotificationEvent, CDOView.Options.FeatureAnalyzerEvent, CDOView.Options.InvalidationNotificationEvent, CDOView.Options.InvalidationPolicyEvent, CDOView.Options.LoadNotificationEvent, CDOView.Options.ReferencePolicyEvent, CDOView.Options.RevisionPrefetchingPolicyEvent, CDOView.Options.StaleReferencePolicyEvent, CDOView.Options.StrongReferencePolicyEvent
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static longDEFAULT_COMMIT_INFO_TIMEOUTstatic CDOUndoDetectorDEFAULT_UNDO_DETECTOR- 
Fields inherited from interface org.eclipse.emf.cdo.view.CDOView.OptionsDEFAULT_REVISION_PREFETCHING, NO_REVISION_PREFETCHING
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddAutoReleaseLocksExemptions(boolean recursive, org.eclipse.emf.ecore.EObject... objects)Adds the givenobjectto the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.voidaddConflictResolver(CDOConflictResolver resolver)Adds a conflict resolver to the list of conflict resolvers of this transaction.voidclearAutoReleaseLocksExemptions()Clears the set ofobjectsthat are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.java.util.Map<CDOID,CDORevision>getAttachedRevisionsMap()Returns a map which, if non-null, stores copies of the initialrevisionsof newly attached objects.java.util.Set<? extends org.eclipse.emf.ecore.EObject>getAutoReleaseLocksExemptions()Returns the set ofobjectsthat are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.longgetCommitInfoTimeout()Returns the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()is called.CDOConflictResolver[]getConflictResolvers()Returns a copy of the conflict resolver list of this transaction.CDOTransactiongetContainer()Returns thetransactionof this options object.CDOStaleReferenceCleanergetStaleReferenceCleaner()Get theCDOStaleReferenceCleanerto be used to clean stale references when receiving remote changes on invalidation.CDOUndoDetectorgetUndoDetector()Returns the undo detector of this transaction.booleanisAutoReleaseLocksEnabled()Returnstrueif locks in this transaction will be released whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called,falseotherwise.booleanisAutoReleaseLocksExemption(org.eclipse.emf.ecore.EObject object)Returnstrueif the given object is treated as an exemption to theisAutoReleaseLocksEnabled()option,falseotherwise.voidremoveAutoReleaseLocksExemptions(boolean recursive, org.eclipse.emf.ecore.EObject... objects)Removes the givenobjectfrom the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.voidremoveConflictResolver(CDOConflictResolver resolver)Removes a conflict resolver from the list of conflict resolvers of this transaction.voidsetAttachedRevisionsMap(java.util.Map<CDOID,CDORevision> attachedRevisionsMap)Sets a map which, if non-null, stores copies of the initialrevisionsof newly attached objects, so that these objects can and will be rolled back to the model values they had at attachment time.voidsetAutoReleaseLocksEnabled(boolean on)Specifies whether locks in this transaction will be released whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called.voidsetCommitInfoTimeout(long commitInfoTimeout)Specifies the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()is called.voidsetConflictResolvers(CDOConflictResolver[] resolvers)Sets the conflict resolver list of this transaction.voidsetStaleReferenceCleaner(CDOStaleReferenceCleaner staleReferenceCleaner)Set theCDOStaleReferenceCleanerto be used to clean stale references when receiving remote changes on invalidation.voidsetUndoDetector(CDOUndoDetector undoDetector)Sets the undo detector of this transaction.- 
Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonView.OptionsisLockNotificationEnabled, setLockNotificationEnabled
 - 
Methods inherited from interface org.eclipse.emf.cdo.view.CDOView.OptionsaddChangeSubscriptionPolicy, getCacheReferenceType, getChangeSubscriptionPolicies, getClearAdapterPolicy, getFeatureAnalyzer, getInvalidationPolicy, getRevisionPrefetchingPolicy, getStaleReferenceBehaviour, getStaleReferencePolicy, getStrongReferencePolicy, isDetachmentNotificationEnabled, isInvalidationNotificationEnabled, isLoadNotificationEnabled, removeChangeSubscriptionPolicy, setCacheReferenceType, setClearAdapterPolicy, setDetachmentNotificationEnabled, setFeatureAnalyzer, setInvalidationNotificationEnabled, setInvalidationPolicy, setLoadNotificationEnabled, setRevisionPrefetchingPolicy, setStaleReferenceBehaviour, setStaleReferencePolicy, setStrongReferencePolicy
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_UNDO_DETECTORstatic final CDOUndoDetector DEFAULT_UNDO_DETECTOR - Since:
- 4.3
 
 - 
DEFAULT_COMMIT_INFO_TIMEOUTstatic final long DEFAULT_COMMIT_INFO_TIMEOUT - Since:
- 4.5
- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getContainerCDOTransaction getContainer() Returns thetransactionof this options object.- Specified by:
- getContainerin interface- CDOView.Options
- Specified by:
- getContainerin interface- org.eclipse.net4j.util.options.IOptions
- Since:
- 4.0
 
 - 
getUndoDetectorCDOUndoDetector getUndoDetector() Returns the undo detector of this transaction.- Since:
- 4.3
 
 - 
setUndoDetectorvoid setUndoDetector(CDOUndoDetector undoDetector) Sets the undo detector of this transaction.- Since:
- 4.3
 
 - 
getConflictResolversCDOConflictResolver[] getConflictResolvers() Returns a copy of the conflict resolver list of this transaction.
 - 
setConflictResolversvoid setConflictResolvers(CDOConflictResolver[] resolvers) Sets the conflict resolver list of this transaction.
 - 
addConflictResolvervoid addConflictResolver(CDOConflictResolver resolver) Adds a conflict resolver to the list of conflict resolvers of this transaction.
 - 
removeConflictResolvervoid removeConflictResolver(CDOConflictResolver resolver) Removes a conflict resolver from the list of conflict resolvers of this transaction.
 - 
getStaleReferenceCleanerCDOStaleReferenceCleaner getStaleReferenceCleaner() Get theCDOStaleReferenceCleanerto be used to clean stale references when receiving remote changes on invalidation.- Since:
- 4.4
 
 - 
setStaleReferenceCleanervoid setStaleReferenceCleaner(CDOStaleReferenceCleaner staleReferenceCleaner) Set theCDOStaleReferenceCleanerto be used to clean stale references when receiving remote changes on invalidation.- Since:
- 4.4
 
 - 
isAutoReleaseLocksEnabledboolean isAutoReleaseLocksEnabled() Returnstrueif locks in this transaction will be released whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called,falseotherwise.The default value is true.- See Also:
- getAutoReleaseLocksExemptions()
 
 - 
setAutoReleaseLocksEnabledvoid setAutoReleaseLocksEnabled(boolean on) Specifies whether locks in this transaction will be released whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called.If set to falseall locks will be kept whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called.The default value is true.- See Also:
- getAutoReleaseLocksExemptions()
 
 - 
getAutoReleaseLocksExemptionsjava.util.Set<? extends org.eclipse.emf.ecore.EObject> getAutoReleaseLocksExemptions() Returns the set ofobjectsthat are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.That means: -  If isAutoReleaseLocksEnabled()returnstrue, the locks on the objects in this set are not released whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called.
-  If isAutoReleaseLocksEnabled()returnsfalse, the locks on the objects in this set are released nevertheless whenCDOUserTransaction.commit()orCDOUserTransaction.rollback()are called.
 The returned set is unmodifiable. To modify the set use the clearAutoReleaseLocksExemptions(),addAutoReleaseLocksExemption(), andremoveAutoReleaseLocksExemption()methods.Implementation note: This set stores weak references to the contained objects. 
-  If 
 - 
isAutoReleaseLocksExemptionboolean isAutoReleaseLocksExemption(org.eclipse.emf.ecore.EObject object) Returnstrueif the given object is treated as an exemption to theisAutoReleaseLocksEnabled()option,falseotherwise.- Since:
- 4.6
- See Also:
- getAutoReleaseLocksExemptions()
 
 - 
clearAutoReleaseLocksExemptionsvoid clearAutoReleaseLocksExemptions() Clears the set ofobjectsthat are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.
 - 
addAutoReleaseLocksExemptionsvoid addAutoReleaseLocksExemptions(boolean recursive, org.eclipse.emf.ecore.EObject... objects)Adds the givenobjectto the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.
 - 
removeAutoReleaseLocksExemptionsvoid removeAutoReleaseLocksExemptions(boolean recursive, org.eclipse.emf.ecore.EObject... objects)Removes the givenobjectfrom the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()option.
 - 
getAttachedRevisionsMapjava.util.Map<CDOID,CDORevision> getAttachedRevisionsMap() Returns a map which, if non-null, stores copies of the initialrevisionsof newly attached objects.- Since:
- 4.8
- See Also:
- setAttachedRevisionsMap(Map)
 
 - 
setAttachedRevisionsMapvoid setAttachedRevisionsMap(java.util.Map<CDOID,CDORevision> attachedRevisionsMap) Sets a map which, if non-null, stores copies of the initialrevisionsof newly attached objects, so that these objects can and will be rolled back to the model values they had at attachment time. If this map isnullnewly attached objects will keep the model values they have at rollback time. Note that remembering copies of all newly attached objects can impose resource problems when many objects are attached, e.g., during larger imports.- Since:
- 4.8
 
 - 
getCommitInfoTimeoutlong getCommitInfoTimeout() Returns the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()is called.Default value is 10000. - Since:
- 4.5
 
 - 
setCommitInfoTimeoutvoid setCommitInfoTimeout(long commitInfoTimeout) Specifies the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()is called.Default value is 10000. - Since:
- 4.5
 
 
- 
 
-