wt.vc.wip
Class WorkInProgressServiceEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.vc.wip.WorkInProgressServiceEvent

All Implemented Interfaces:

Serializable, wt.events.summary.SummarizedEvent

public class WorkInProgressServiceEvent
extends KeyedEvent
implements Serializable

Provides a service specific event extended from KeyedEvent used in conjunction with the standard implementation of the server-side functionality as defined by the WorkInProgressService interface. This event could also be used by a custom implementation of the WorkInProgressService.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	POST_CHECKIN A constant that defines an event marking the occurrance of a checkin that has completed.
static String	POST_CHECKOUT A constant that defines an event marking the occurrance of a checkout that has completed.
static String	POST_UNDO_CHECKOUT A constant that defines an event marking the occurrance of an undo of a checkout that has completed.
static String	PRE_CHECKIN A constant that defines an event marking the occurrance of a checkin that is about to commense.
static String	PRE_CHECKOUT A constant that defines an event marking the occurrance of a checkout that is about to commense.
static String	PRE_UNDO_CHECKOUT A constant that defines an event marking the occurrance of an undo of a checkout that is about to commense.

Method Summary

Workable	getOriginalCopy() Gets the original copy target of the event.
Workable	getTarget() Deprecated. Replaced by getOriginalCopy()
WTValuedMap	getTargetMap() Return a WTValuedMap with key=original copy and value = working copy.
WTCollection	getTargets() Gets the event targent (WTKeyedMap of original - working pairs) as a WTCollection.
Workable	getWorkingCopy() Gets the working copy target of the event.

Methods inherited from class java.lang.Object

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

Field Detail

PRE_CHECKIN

public static final String PRE_CHECKIN

A constant that defines an event marking the occurrance of a checkin that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

POST_CHECKIN

public static final String POST_CHECKIN

A constant that defines an event marking the occurrance of a checkin that has completed. Listener's of this event can perform post-processing related to the checkin of an object, and can stipulate that postconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_CHECKOUT

public static final String PRE_CHECKOUT

A constant that defines an event marking the occurrance of a checkout that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

POST_CHECKOUT

public static final String POST_CHECKOUT

A constant that defines an event marking the occurrance of a checkout that has completed. Listener's of this event can perform post-processing related to the checkout of an object, and can stipulate that postconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_UNDO_CHECKOUT

public static final String PRE_UNDO_CHECKOUT

A constant that defines an event marking the occurrance of an undo of a checkout that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

POST_UNDO_CHECKOUT

public static final String POST_UNDO_CHECKOUT

A constant that defines an event marking the occurrance of an undo of a checkout that has completed. Listener's of this event can perform post-processing related to the undo of a checkout of an object, and can stipulate that postconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

Method Detail

getOriginalCopy

public Workable getOriginalCopy()

Gets the original copy target of the event.

Supported API: true

Returns:

Workable

See Also:

wt.vc.wip.PRE_CHECKOUT, wt.vc.wip.POST_CHECKOUT, wt.vc.wip.PRE_CHECKIN, wt.vc.wip.POST_CHECKIN, wt.vc.wip.PRE_UNDO_CHECKOUT, wt.vc.wip.POST_UNDO_CHECKOUT

getWorkingCopy

public Workable getWorkingCopy()

Gets the working copy target of the event.

Supported API: true

Returns:

Workable

See Also:

wt.vc.wip.POST_CHECKOUT, wt.vc.wip.PRE_CHECKIN, wt.vc.wip.POST_CHECKIN, wt.vc.wip.PRE_UNDO_CHECKOUT, wt.vc.wip.POST_UNDO_CHECKOUT

getTarget

public Workable getTarget()

Deprecated. Replaced by getOriginalCopy()

Gets the original copy target of the event.

Supported API: true

Returns:

Workable

See Also:

wt.vc.wip.PRE_CHECKOUT

getTargetMap

public WTValuedMap getTargetMap()

Return a WTValuedMap with key=original copy and value = working copy.

Supported API: true

Returns:

WTValuedMap

getTargets

public WTCollection getTargets()

Gets the event targent (WTKeyedMap of original - working pairs) as a WTCollection.

Supported API: true

Returns:

WTCollection