wt.sandbox
Class SandboxServiceCheckoutEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.sandbox.SandboxServiceMultiEvent
          wt.sandbox.SandboxServiceCheckoutEvent

All Implemented Interfaces:

Cloneable, Serializable

public class SandboxServiceCheckoutEvent

extends SandboxServiceMultiEvent

implements Serializable

Encapusulates SandboxService event/occurence data which occur upon sandbox check-outs.

The target object of the event is a WTSet of the original copies when the event type is PRE_SB_CHECKOUT_EVENT, whereas it is a WTCollection of the resulting working copies when the event type is POST_SB_CHECKOUT_EVENT. Except where attempting to treat many service events generically, it is recommended that the more specific methods provided on this class be used in preference to getEventTarget(), however.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private WTValuedMap	origToWorkingCopyMap
static String	POST_SB_CHECKOUT_EVENT Event type indicating state immediately prior to end of sandbox check out transaction block Supported API: false
static String	PRE_SB_CHECKOUT_EVENT Event type indicating state immediately prior to sandbox check out but within transaction block thereof Supported API: false
private static String	RESOURCE

Fields inherited from class wt.sandbox.SandboxServiceMultiEvent

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

private

SandboxServiceCheckoutEvent(String eventType, WTValuedMap origToWorkingCopyMap)

Method Summary

private static void	fireCheckOutEvent(ManagerService managerService, WTValuedMap origToWorkingCopyMap, boolean preEvent)
(package private) static void	firePostCheckOutEvent(ManagerService managerService, WTValuedMap origToWorkingCopyMap)
(package private) static void	firePreCheckOutEvent(ManagerService managerService, WTValuedMap origToWorkingCopyMap)
static String	generateEventKey(String eventType) Generate an appropriate event key for this class given an event type.
WTSet	getOriginalCopies() Gets set of original copies.
WTValuedMap	getOriginalToWorkingCopyMap() Gets map from original to working copies.
WTCollection	getWorkingCopies() Gets collection of resulting working copies.

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

PRE_SB_CHECKOUT_EVENT

public static final String PRE_SB_CHECKOUT_EVENT

Event type indicating state immediately prior to sandbox check out but within transaction block thereof

Supported API: false

See Also:

Constant Field Values

POST_SB_CHECKOUT_EVENT

public static final String POST_SB_CHECKOUT_EVENT

Event type indicating state immediately prior to end of sandbox check out transaction block

Supported API: false

See Also:

Constant Field Values

origToWorkingCopyMap

private WTValuedMap origToWorkingCopyMap

Constructor Detail

SandboxServiceCheckoutEvent

private SandboxServiceCheckoutEvent(String eventType,
                                    WTValuedMap origToWorkingCopyMap)

Method Detail

getOriginalToWorkingCopyMap

public WTValuedMap getOriginalToWorkingCopyMap()

Gets map from original to working copies.

Supported API: false

Returns:

WTValuedMap

getOriginalCopies

public WTSet getOriginalCopies()

Gets set of original copies.

Supported API: false

Returns:

WTSet

getWorkingCopies

public WTCollection getWorkingCopies()

Gets collection of resulting working copies.

Supported API: false

Returns:

WTCollection

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

firePreCheckOutEvent

static void firePreCheckOutEvent(ManagerService managerService,
                                 WTValuedMap origToWorkingCopyMap)
                          throws WTException

Throws:

WTException

firePostCheckOutEvent

static void firePostCheckOutEvent(ManagerService managerService,
                                  WTValuedMap origToWorkingCopyMap)
                           throws WTException

Throws:

WTException

fireCheckOutEvent

private static void fireCheckOutEvent(ManagerService managerService,
                                      WTValuedMap origToWorkingCopyMap,
                                      boolean preEvent)
                               throws WTException

Throws:

WTException