Interface TaskFactory

    • Method Detail

      • init

        void init​(ContainerServices cntrSvcs)
        Instructs the factory to initialize itself using the associated ContainerServices object.
        Parameters:
        cntrSvcs - The ContainerServices object.
      • init

        void init​(ContainerServices cntrSvcs,
                  TaskFactoryInfo config)
        Instructs the factory to initialize itself using the associated ContainerServices and task factory configuration objects.
        Parameters:
        cntrSvcs - The ContainerServices object.
        config - The task factory configuration object
      • newTask

        Task newTask​(java.lang.String id)
              throws TaskException
        Create a new instance of the Task whose identifier is 'id'.
        Parameters:
        id - The identifier of the Task to instantiate.
        Returns:
        A new instance of the Task whose ID is given.
        Throws:
        TaskException - If something fails in the creation of the task.
      • getRegisteredTaskIDs

        java.util.Iterator<java.lang.String> getRegisteredTaskIDs​(TaskFactory.TaskCategory taskCat)
        Returns an Iterator of registered task IDs in the specified task category.
        Parameters:
        taskCat - The TaskFactory.TaskCategory in which task IDs are being requested.
        Returns:
        An Iterator of all registered task names.
      • getRegisteredTaskIDList

        java.util.List<java.lang.String> getRegisteredTaskIDList​(TaskFactory.TaskCategory taskCat)
        Returns a List of registered task IDs in the specified task category.
        Parameters:
        taskCat - The TaskFactory.TaskCategory in which task IDs are being requested.
        Returns:
        An List of all registered task names. They are sorted alphabetically.
        Since:
        MicroStrategy Web 9.0.0
      • destroy

        void destroy()
        Instructs the factory to destroy any persistent data structures.