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

java.lang.Object
  extended by com.microsoft.tfs.core.clients.CoreClientEvent
      extended by com.microsoft.tfs.core.clients.versioncontrol.events.OperationStartedEvent
Direct Known Subclasses:
GetOperationStartedEvent, MergeOperationStartedEvent, PendOperationStartedEvent, ResolveConflictsStartedEvent, ResolveConflictStartedEvent, RollbackOperationStartedEvent, UndoOperationStartedEvent, UnshelveShelvesetStartedEvent

public abstract class OperationStartedEvent
extends CoreClientEvent

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

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 UndoOperationStartedEvent, GetOperationStartedEvent, PendOperationStartedEvent, etc.).

Since:
TEE-SDK-10.1

Constructor Summary
OperationStartedEvent(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

OperationStartedEvent

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

getWorkspace

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

getProcessType

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


© 2015 Microsoft. All rights reserved.