wt.sandbox
Class SandboxServiceInitialCheckinEvent

java.lang.Object
  extended bywt.events.KeyedEvent
      extended bywt.sandbox.SandboxServiceMultiEvent
          extended bywt.sandbox.SandboxServiceInitialCheckinEvent
All Implemented Interfaces:
Cloneable, Serializable

public class SandboxServiceInitialCheckinEvent
extends SandboxServiceMultiEvent
implements Serializable

Encapusulates SandboxService event/occurence data state immediately prior to storing initial sandbox checkins. Provides intial checkins to listeners for modification for any/all necessary validation and/or modification.

Note that this event is focused on the production of formation of initial sandbox checkin objects, whereas SandboxServiceCheckinEvent provides a broader, more encompassing view but does not provide access to the initial checkin objects as they are being formed.

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  WTKeyedMap initialCheckinWorkingCopyToDataMap
           
private static String RESOURCE
           
static String SB_INITIAL_CHECKIN_EVENT
          

Supported API: false
private  WTValuedMap workingCopyToInitialCheckinMap
           
 
Fields inherited from class wt.sandbox.SandboxServiceMultiEvent
 
Fields inherited from class wt.events.KeyedEvent
 
Constructor Summary
private SandboxServiceInitialCheckinEvent(WTValuedMap workingCopyToInitialCheckinMap, WTKeyedMap initialCheckinWorkingCopyToDataMap)
           
 
Method Summary
(package private) static void fireInitialCheckinEvent(ManagerService managerService, WTValuedMap workingCopyToInitialCheckinMap, WTKeyedMap initialCheckinWorkingCopyToDataMap)
           
static String generateEventKey(String eventType)
          Generate an appropriate event key for this class given an event type.
 WTKeyedMap getInitialCheckinWorkingCopyToDataMap()
          Gets map from working copies for intial check in to InitialCheckinData objects.
 WTValuedMap getWorkingCopyToInitialCheckinMap()
          Gets map from working copies to initial checkin objects formed from them.
 
Methods inherited from class wt.sandbox.SandboxServiceMultiEvent
getEventTarget, toMultiObjectEvent, toSingleObjectEvents
 
Methods inherited from class wt.events.KeyedEvent
generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventType, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

SB_INITIAL_CHECKIN_EVENT

public static final String SB_INITIAL_CHECKIN_EVENT


Supported API: false

See Also:
Constant Field Values

workingCopyToInitialCheckinMap

private WTValuedMap workingCopyToInitialCheckinMap

initialCheckinWorkingCopyToDataMap

private WTKeyedMap initialCheckinWorkingCopyToDataMap
Constructor Detail

SandboxServiceInitialCheckinEvent

private SandboxServiceInitialCheckinEvent(WTValuedMap workingCopyToInitialCheckinMap,
                                          WTKeyedMap initialCheckinWorkingCopyToDataMap)
Method Detail

getWorkingCopyToInitialCheckinMap

public WTValuedMap getWorkingCopyToInitialCheckinMap()
Gets map from working copies to initial checkin objects formed from them. Note that the checkins have not yet been stored but will be after the completion of this event dispatch. This thus affords listeners with an opportunity to contribute to the formation of these new objects.

Supported API: false

Returns:
WTValuedMap

getInitialCheckinWorkingCopyToDataMap

public WTKeyedMap getInitialCheckinWorkingCopyToDataMap()
Gets map from working copies for intial check in to InitialCheckinData objects.

Supported API: false

Returns:
WTKeyedMap

generateEventKey

public static String generateEventKey(String eventType)
Generate an appropriate event key for this class given an event type.

Supported API: false

Parameters:
eventType - the event type
Returns:
String

fireInitialCheckinEvent

static void fireInitialCheckinEvent(ManagerService managerService,
                                    WTValuedMap workingCopyToInitialCheckinMap,
                                    WTKeyedMap initialCheckinWorkingCopyToDataMap)
                             throws WTException
Throws:
WTException