wt.epm.workspaces
Class EPMWorkspaceManagerEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.epm.workspaces.EPMWorkspaceManagerEvent

All Implemented Interfaces:

Serializable

public class EPMWorkspaceManagerEvent

extends KeyedEvent

implements Serializable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	CHECKOUT_TO_WORKSPACE This event is dispatched when a list of Workable objects are checked out to a workspace folder.
private static String	CLASSNAME
static String	NEW_TO_WORKSPACE This event is dispatched when new Persistable objects are created in a workspace folder.
static String	POST_WORKSPACE_CHECKIN This event is dispatched when a list of Workable objects are checked in from a workspace.
static String	PRE_WORKSPACE_CHECKIN This event is dispatched when a list of Workable objects are about to be checked in from a workspace.
private static String	RESOURCE
private EPMWorkspace	workspace

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

	EPMWorkspaceManagerEvent(String eventType, EPMWorkspace workspace, WTCollection workspaceObjects) Supported API: false
protected	EPMWorkspaceManagerEvent(String eventType, EPMWorkspace workspace, WTKeyedMap wipMap) Creates WorkspaceManager event for Checkin and Checkout.

Method Summary

static String	generateEventKey(String eventType) Generates an event key from an event type.
WTKeyedMap	getWIPMap() Returns a Map associated with PRE_WORKSPACE_CHECKIN, POST_WORKSPACE_CHECKOUT, CHECKOUT_TO_WORKSPACE events.
EPMWorkspace	getWorkspace() Gets the value of the attribute: workspace; The EPM workspace related to this event Supported API: false
WTCollection	getWorkspaceObjects() Returns a collection of workspace objects related to this event.
KeyedEvent	toMultiObjectEvent() Supported API: false
KeyedEvent[]	toSingleObjectEvents() Supported API: false

Methods inherited from class wt.events.KeyedEvent

generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventTarget, 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

NEW_TO_WORKSPACE

public static final String NEW_TO_WORKSPACE

This event is dispatched when new Persistable objects are created in a workspace folder.

Supported API: true

See Also:

Constant Field Values

PRE_WORKSPACE_CHECKIN

public static final String PRE_WORKSPACE_CHECKIN

This event is dispatched when a list of Workable objects are about to be checked in from a workspace. Target of this event is a map whose keys are working copy objects and values are original objects. For Workables that are getting checked-in for the first time, original is null.

Supported API: true

See Also:

Constant Field Values

POST_WORKSPACE_CHECKIN

public static final String POST_WORKSPACE_CHECKIN

This event is dispatched when a list of Workable objects are checked in from a workspace. Target of this event is a map whose keys are working copy objects and values are original objects. For Workables that are getting checked-in for the first time, original is null.

Supported API: true

See Also:

Constant Field Values

CHECKOUT_TO_WORKSPACE

public static final String CHECKOUT_TO_WORKSPACE

This event is dispatched when a list of Workable objects are checked out to a workspace folder. Target of this event is a map whose keys are original objects and values are working copy objects.

Supported API: true

See Also:

Constant Field Values

workspace

private EPMWorkspace workspace

Constructor Detail

EPMWorkspaceManagerEvent

public EPMWorkspaceManagerEvent(String eventType,
                                EPMWorkspace workspace,
                                WTCollection workspaceObjects)
                         throws WTException

Supported API: false

Parameters:

eventType - Type of the event

workspace -

workspaceObjects - A collection of objects applicable to this event.

Throws:

WTException

EPMWorkspaceManagerEvent

protected EPMWorkspaceManagerEvent(String eventType,
                                   EPMWorkspace workspace,
                                   WTKeyedMap wipMap)
                            throws WTException

Creates WorkspaceManager event for Checkin and Checkout.

Supported API: false

Parameters:

eventType - Type of the event

workspace -

wipMap - Map for checkout or checkin events.

Throws:

WTException

Method Detail

getWorkspace

public EPMWorkspace getWorkspace()

Gets the value of the attribute: workspace; The EPM workspace related to this event

Supported API: false

Returns:

EPMWorkspace

getWorkspaceObjects

public WTCollection getWorkspaceObjects()

Returns a collection of workspace objects related to this event.

Supported API: false

Returns:

WTCollection

generateEventKey

public static String generateEventKey(String eventType)

Generates an event key from an event type.

Supported API: false

Parameters:

eventType -

Returns:

String

toSingleObjectEvents

public KeyedEvent[] toSingleObjectEvents()
                                  throws WTException

Supported API: false

Overrides:

toSingleObjectEvents in class KeyedEvent

Returns:

KeyedEvent[]

Throws:

WTException

toMultiObjectEvent

public KeyedEvent toMultiObjectEvent()

Supported API: false

Overrides:

toMultiObjectEvent in class KeyedEvent

Returns:

KeyedEvent

getWIPMap

public WTKeyedMap getWIPMap()

Returns a Map associated with PRE_WORKSPACE_CHECKIN, POST_WORKSPACE_CHECKOUT, CHECKOUT_TO_WORKSPACE events. For checkin events, map has key as a working copy object and value as original object. For checkout event, map has key as original object and value as working copy.

Supported API: false

Returns:

WTKeyedMap