Package com.swiftmq.swiftlet.scheduler

Interface JobGroup

  • public interface JobGroup
    A JobGroup is the interface between the Scheduler Swiftlet and other Swiftlets. Each Swiftlet should have their own unique JobGroup to register its JobFactories.
    Author:
    IIT GmbH, Bremen/Germany, Copyright (c) 2000-2003, All Rights Reserved

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addJobFactory​(java.lang.String name, JobFactory factory)
      Registers a JobFactory at this JobGroup.
      java.lang.String[] getJobFactoryNames()
      Returns an array of registered JobFactory names.
      java.lang.String getName()
      Returns the name of the JobGroup.
      boolean hasJobFactory​(java.lang.String name)
      Checks whether a JobFactory with a given name is registered at this JobGroup.
      void removeAll()
      Removes all JobFactories from this JobGroup.
      void removeJobFactory​(java.lang.String name)
      Removes a JobFactory from this JobGroup.

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the JobGroup. This name should be unique and should reflect the Swiftlet in some manner, e.g. 'Store' for the StoreSwiftlet. The name is set during creation of the JobGroup.
        Returns:
        Name

      • getJobFactoryNames

        java.lang.String[] getJobFactoryNames()
        Returns an array of registered JobFactory names. If no JobFactories are registered, null is returned.
        Returns:
        JobFactory names

      • hasJobFactory

        boolean hasJobFactory​(java.lang.String name)
        Checks whether a JobFactory with a given name is registered at this JobGroup.
        Parameters:
        name - JobFactory name
        Returns:
        true/false

      • addJobFactory

        void addJobFactory​(java.lang.String name,
                   JobFactory factory)
        Registers a JobFactory at this JobGroup. Schedules which refers to this JobFactory are activated.
        Parameters:
        name - Name of the JobFactory
        factory - JobFactory

      • removeJobFactory

        void removeJobFactory​(java.lang.String name)
        Removes a JobFactory from this JobGroup. Schedules which refers to this JobFactory are deactivated, running Jobs from this JobFactory are stopped.
        Parameters:
        name - Name of the JobFactory

      • removeAll

        void removeAll()
        Removes all JobFactories from this JobGroup. Schedules which refers to this JobFactories are deactivated, running Jobs from this JobFactories are stopped.