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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    POST_CHECKIN
    A constant that defines an event marking the occurrence of a checkin that has completed.
    static final String
    POST_CHECKOUT
    A constant that defines an event marking the occurrence of a checkout that has completed.
    static final String
    POST_CONVERT_CHECKOUT
    A constant that defines an event marking the occurrence of a private checkout being converted to a reserved checkout or vice versa has completed.
    static final String
    POST_UNDO_CHECKOUT
    A constant that defines an event marking the occurrance of an undo of a checkout that has completed.
    static final String
    PRE_CHECKIN
    A constant that defines an event marking the occurrence of a checkin that is about to commence.
    static final String
    PRE_CHECKOUT
    A constant that defines an event marking the occurrence of a checkout that is about to commence.
    static final String
    PRE_CONVERT_CHECKOUT
    A constant that defines an event marking the occurrence of a private checkout being converted to a reserved checkout or vice versa that is about to commence.
    static final String
    PRE_UNDO_CHECKOUT
    A constant that defines an event marking the occurrence of an undo of a checkout that is about to commence.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 wt.events.KeyedEvent

    generateEventKey, getEventKey, getEventType

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PRE_CHECKIN

      public static final String PRE_CHECKIN
      A constant that defines an event marking the occurrence of a checkin that is about to commence. 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:

    • POST_CHECKIN

      public static final String POST_CHECKIN
      A constant that defines an event marking the occurrence 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:

    • PRE_CHECKOUT

      public static final String PRE_CHECKOUT
      A constant that defines an event marking the occurrence of a checkout that is about to commence. 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:

    • POST_CHECKOUT

      public static final String POST_CHECKOUT
      A constant that defines an event marking the occurrence 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:

    • PRE_UNDO_CHECKOUT

      public static final String PRE_UNDO_CHECKOUT
      A constant that defines an event marking the occurrence of an undo of a checkout that is about to commence. 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:

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

    • PRE_CONVERT_CHECKOUT

      public static final String PRE_CONVERT_CHECKOUT
      A constant that defines an event marking the occurrence of a private checkout being converted to a reserved checkout or vice versa that is about to commence. 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:

    • POST_CONVERT_CHECKOUT

      public static final String POST_CONVERT_CHECKOUT
      A constant that defines an event marking the occurrence of a private checkout being converted to a reserved checkout or vice versa has completed. Listener's of this event can perform post-processing related to the conversion of a checkout to reserved or private 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:

  • Method Details