Package com.microstrategy.web.tasks
Interface TaskFactory
-
- All Known Implementing Classes:
AggregatingTaskFactory
,AppTaskFactory
,BeanTaskFactory
,FilteredBeanTaskFactory
public interface TaskFactory
This interface represents a class that is a factory for a set ofTask
classes.- Since:
- MicroStrategy Web 8.1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
TaskFactory.TaskCategory
Enumerations for task categories.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
destroy()
Instructs the factory to destroy any persistent data structures.java.util.List<java.lang.String>
getRegisteredTaskIDList(TaskFactory.TaskCategory taskCat)
Returns a List of registered task IDs in the specified task category.java.util.Iterator<java.lang.String>
getRegisteredTaskIDs(TaskFactory.TaskCategory taskCat)
Returns an Iterator of registered task IDs in the specified task category.void
init(ContainerServices cntrSvcs)
Instructs the factory to initialize itself using the associated ContainerServices object.void
init(ContainerServices cntrSvcs, TaskFactoryInfo config)
Instructs the factory to initialize itself using the associated ContainerServices and task factory configuration objects.Task
newTask(java.lang.String id)
Create a new instance of the Task whose identifier is 'id'.
-
-
-
Method Detail
-
init
void init(ContainerServices cntrSvcs)
Instructs the factory to initialize itself using the associated ContainerServices object.- Parameters:
cntrSvcs
- TheContainerServices
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
- TheContainerServices
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 theTask
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
- TheTaskFactory.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
- TheTaskFactory.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.
-
-