com.microsoft.tfs.core.clients.versioncontrol.events
Class OperationCompletedEvent

java.lang.Object
  extended by com.microsoft.tfs.core.clients.CoreClientEvent
      extended by com.microsoft.tfs.core.clients.versioncontrol.events.OperationCompletedEvent
Direct Known Subclasses:
GetOperationCompletedEvent, MergeOperationCompletedEvent, PendOperationCompletedEvent, ResolveConflictCompletedEvent, ResolveConflictsCompletedEvent, RollbackOperationCompletedEvent, UndoOperationCompletedEvent, UnshelveShelvesetCompletedEvent

public abstract class OperationCompletedEvent
extends CoreClientEvent

Event fired when some kinds of core operations, which may fire other events in the course if its execution, have completed. Every core operation that fires a OperationCompletedEvent will have fired exactly one OperationStartedEvent before it.

The primary use of this started/completed pattern is to "batch" up events fired in between, so UI elements can be updated more efficiently (e.g. during an "undo" operation).

This class is abstract and is designed to be extended to contain specific operation data (see UndoOperationCompletedEvent, GetOperationCompletedEvent, PendOperationCompletedEvent, etc.).

Since:
TEE-SDK-10.1

Constructor Summary
OperationCompletedEvent(EventSource source, Workspace workspace, ProcessType type)
           
 
Method Summary
 ProcessType getProcessType()
           
 Workspace getWorkspace()
           
 
Methods inherited from class com.microsoft.tfs.core.clients.CoreClientEvent
getEventSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OperationCompletedEvent

public OperationCompletedEvent(EventSource source,
                               Workspace workspace,
                               ProcessType type)
Method Detail

getWorkspace

public Workspace getWorkspace()
Returns:
the workspace where this operation completed.

getProcessType

public ProcessType getProcessType()
Returns:
the type of processing that fired this event.


© 2015 Microsoft. All rights reserved.