Package wt.epm.workspaces

Class EPMWorkspaceManagerEvent

java.lang.Object

wt.events.KeyedEvent

wt.epm.workspaces.EPMWorkspaceManagerEvent

All Implemented Interfaces:

wt.events.summary.SummarizedEvent

public class EPMWorkspaceManagerEvent
extends KeyedEvent

Supported API: true

Extendable: false

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECKOUT_TO_WORKSPACE	This event is dispatched when a list of Workable objects are checked out to a workspace folder.
static final String	NEW_TO_WORKSPACE	This event is dispatched when new Persistable objects are created in a workspace folder on the server.
static final String	POST_WORKSPACE_CHECKIN	This event is dispatched when a list of Workable objects are checked in from a workspace.
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.

Method Summary

Modifier and Type	Method	Description
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: true
WTCollection	getWorkspaceObjects()	Returns a collection of workspace objects related to this event.

Methods inherited from class wt.events.KeyedEvent

generateEventKey, getEventKey, getEventTarget, getEventType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NEW_TO_WORKSPACE

public static final String NEW_TO_WORKSPACE

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

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

Method Details

getWorkspace

public EPMWorkspace getWorkspace()

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

Supported API: true

Returns:

EPMWorkspace

getWorkspaceObjects

public WTCollection getWorkspaceObjects()

Returns a collection of workspace objects related to this event. Use this method with NEW_TO_WORKSPACE event.

Supported API: true

Returns:

WTCollection

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: true

Returns:

WTKeyedMap