Package 

Class BatchModule


  • 
    public abstract class BatchModule
    
                        

    Abstract class of a Batch Module

    • Method Summary

      Modifier and Type Method Description
      abstract String getId() ID of the module
      abstract int getState() Should return the state of the module (usually 0 for deactivated, 1 for activated)
      void batchContextBecameAvailable(@NonNull() Context applicationContext) Called by Batch as soon as a context is available in the runtimeManagerFor convenience, the application context is available as a parameter.LocalBroadcastManager is also up.
      void batchWillStart() Called by Batch before batch startNB : Context & activity are already available from the runtimeManager
      void batchDidStart() Called by Batch right after batch startNB : Same context and activity that in willStart but with the new state READY set
      void batchIsFinishing() Called by Batch before switching to FINISHINGNB : Context and activity are still available from the runtimeManager
      void batchWillStop() Called by Batch before switching to OFFNB : Context is still available from runtimeManager (not activity)
      void batchDidStop() Called by Batch right after batch stopNB : No context or activity are available
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getState

         abstract int getState()

        Should return the state of the module (usually 0 for deactivated, 1 for activated)

      • batchContextBecameAvailable

         void batchContextBecameAvailable(@NonNull() Context applicationContext)

        Called by Batch as soon as a context is available in the runtimeManagerFor convenience, the application context is available as a parameter.LocalBroadcastManager is also up.

      • batchWillStart

         void batchWillStart()

        Called by Batch before batch startNB : Context & activity are already available from the runtimeManager

      • batchDidStart

         void batchDidStart()

        Called by Batch right after batch startNB : Same context and activity that in willStart but with the new state READY set

      • batchIsFinishing

         void batchIsFinishing()

        Called by Batch before switching to FINISHINGNB : Context and activity are still available from the runtimeManager

      • batchWillStop

         void batchWillStop()

        Called by Batch before switching to OFFNB : Context is still available from runtimeManager (not activity)

      • batchDidStop

         void batchDidStop()

        Called by Batch right after batch stopNB : No context or activity are available