Package wt.events

Class KeyedEvent

java.lang.Object
wt.events.KeyedEvent
All Implemented Interfaces:
wt.events.summary.SummarizedEvent
Direct Known Subclasses:
AccessControlEvent, AdministrativeDomainManagerEvent, BaselineServiceEvent, BuildServiceEvent, ChangeService2Event, ContainerTeamServiceEvent, ContentServiceEvent, DeleteManagerEvent, EffGroupAssistantEvent, EffServiceEvent, EPMDocumentManagerEvent, EPMWorkspaceManagerEvent, ESIResultEvent, FolderServiceEvent, IBAValueManagerEvent, IdentityServiceEvent, ImportEvent, LockServiceEvent, ObjectGraphServiceEvent, OccurrenceEvent, PersistedCollectionEvent, PersistenceManagerEvent, ProjectManagementEvent, RecordHistoryEvent, RegulatoryMasterServiceEvent, ReservationEvent, wt.router.RoutingEvent, SessionIterationEvent, StandardManagerServiceEvent, TeamServiceEvent, VersionControlServiceEvent, WfCustomEvent, WorkInProgressServiceEvent, WorkPackageDeliveryEvent, WorkPackageEvent, wt.inf.container.WTContainerServiceEvent

public class KeyedEvent extends Object implements wt.events.summary.SummarizedEvent
A basic event class which can be used with the KeyedEventDispatcher. Although event dispatching works with class java.lang.Object and does not need wt.events.KeyedEvent, class wt.events.KeyedEvent provides basic functionality commonly used to process events.

Supported API: true

Extendable: true
  • Method Details

    • getEventType

      public String getEventType()
      Gets the value of the attribute: eventType; The type of the event. For example, "PRE_DELETE".

      Supported API: true
      Returns:
      String
    • getEventTarget

      public Object getEventTarget()
      Gets the value of the attribute: eventTarget; The primary target of this event. May be null.

      Supported API: true
      Returns:
      Object
    • getEventKey

      public String getEventKey()
      Return the event key. The default method returns

      \t "/"

      Supported API: true

      Returns:
      String
    • generateEventKey

      public static String generateEventKey(Class eventClass, String eventType)
      Generate a prototype key based on the class of the concrete event class and a user defined type.

      Supported API: true
      Parameters:
      eventClass - the class of the event to which the listeners subscribes.
      eventType - the type of the event, may be null.
      Returns:
      String