public interface

TaskFactory

com.microstrategy.web.tasks.TaskFactory
Known Indirect Subclasses

Class Overview

This interface represents a class that is a factory for a set of Task classes.

Summary

Nested Classes
enum TaskFactory.TaskCategory Enumerations for task categories. 
Public Methods
abstract void destroy()
Instructs the factory to destroy any persistent data structures.
abstract List<String> getRegisteredTaskIDList(TaskFactory.TaskCategory taskCat)
Returns a List of registered task IDs in the specified task category.
abstract Iterator<String> getRegisteredTaskIDs(TaskFactory.TaskCategory taskCat)
Returns an Iterator of registered task IDs in the specified task category.
abstract void init(ContainerServices cntrSvcs)
Instructs the factory to initialize itself using the associated ContainerServices object.
abstract void init(ContainerServices cntrSvcs, TaskFactoryInfo config)
Instructs the factory to initialize itself using the associated ContainerServices and task factory configuration objects.
abstract Task newTask(String id)
Create a new instance of the Task whose identifier is 'id'.

Public Methods

public abstract void destroy ()

Instructs the factory to destroy any persistent data structures.

public abstract List<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.

public abstract Iterator<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.

public abstract void init (ContainerServices cntrSvcs)

Instructs the factory to initialize itself using the associated ContainerServices object.

Parameters
cntrSvcs The ContainerServices object.

public abstract 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

public abstract Task newTask (String id)

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.