Package com.technia.tif.enovia.jobevent

Class JobEvents

java.lang.Object
com.technia.tif.core.util.LockSupport
com.technia.tif.enovia.jobevent.JobEvents
All Implemented Interfaces:
com.technia.common.xml.XMLReadable, com.technia.tif.core.Lockable
@API public class JobEvents extends com.technia.tif.core.util.LockSupport implements com.technia.common.xml.XMLReadable
Manages job event listeners available on a job instance. Handles both a registry of listeners for each JobEventType and triggering when a event occurs.
Since:
2015.3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final JobEvents
    EMPTY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobEvents()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.technia.tif.enovia.jobevent.JobEventListeners
    getOnError()
     
    com.technia.tif.enovia.jobevent.JobEventListeners
    getOnStart()
     
    com.technia.tif.enovia.jobevent.JobEventListeners
    getOnSuccess()
     
    com.technia.tif.enovia.jobevent.JobEventListeners
    getOnValidate()
     
    void
    initialize(com.technia.common.xml.XMLReader reader)
     
    void
    lock()
     
    void
    trigger(JobEvent event)
    Trigger an event based on the provided parameter.

    Methods inherited from class com.technia.tif.core.util.LockSupport

    ensureModifiable, isLocked

    Methods inherited from class java.lang.Object

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

  • Field Details

    • EMPTY

      public static final JobEvents EMPTY

  • Constructor Details

    • JobEvents

      public JobEvents()

  • Method Details

    • lock

      public void lock()
      Specified by:
      lock in interface com.technia.tif.core.Lockable
      Overrides:
      lock in class com.technia.tif.core.util.LockSupport

    • getOnValidate

      public com.technia.tif.enovia.jobevent.JobEventListeners getOnValidate()

    • getOnStart

      public com.technia.tif.enovia.jobevent.JobEventListeners getOnStart()

    • getOnSuccess

      public com.technia.tif.enovia.jobevent.JobEventListeners getOnSuccess()

    • getOnError

      public com.technia.tif.enovia.jobevent.JobEventListeners getOnError()

    • trigger

      public void trigger(JobEvent event) throws com.technia.tif.enovia.jobevent.JobEventListenerException
      Trigger an event based on the provided parameter. The listeners matching the JobEventType are invoked.
      Parameters:
      event - Job event data
      Throws:
      com.technia.tif.enovia.jobevent.JobEventListenerException
      Since:
      2015.3.0

    • initialize

      public void initialize(com.technia.common.xml.XMLReader reader) throws com.technia.common.xml.XMLException
      Specified by:
      initialize in interface com.technia.common.xml.XMLReadable
      Throws:
      com.technia.common.xml.XMLException