public interface ScheduleTaskFactory<DTO extends ScheduleTaskFactory.TaskDto,T extends ScheduleTask>
datatransfer object
(which is also the persistent format), a createTask(ScheduleEntry,ScheduleTaskFactory.TaskDto)
schedule task}, and an executor
.Modifier and Type | Interface and Description |
---|---|
static interface |
ScheduleTaskFactory.TaskDto
Marker interface for task data transfer and persistence object.
|
Modifier and Type | Method and Description |
---|---|
DTO |
createDto()
Create a new Task DTO to use with a task factory to create a new task.
|
<E> E |
createEditorFactory(Class<E> type,
T task)
Create a gui factory of a specified type.
|
T |
createTask(ScheduleEntry scheduleEntry,
DTO dto)
Create a new task.
|
de.espirit.firstspirit.server.scheduler.TaskExecutor |
createTaskExecutor()
Factory providing an executor object for performing a task.
|
Class<T> |
getApiType()
Provides the API type for tasks being created by this factory.
|
String |
getDescription()
Provides a description of the created task's job.
|
String |
getDisplayName()
Provides the display name for creating tasks from this factory.
|
Class<DTO> |
getDtoType()
Provides the DTO type for tasks.
|
boolean |
isLicensed(SpecialistsBroker broker)
Is this task type enabled by license?
|
boolean |
mayExecuteWithoutProject()
Deprecated.
since 5.2.16 - use
#mayExecuteInContext(ScheduleTaskDefinitionContext) |
boolean |
mayExecuteWithProject()
Deprecated.
since 5.2.16 - use
#mayExecuteInContext(ScheduleTaskDefinitionContext) |
Class<T> getApiType()
<T>
Class<DTO> getDtoType()
@NotNull String getDisplayName()
@NotNull String getDescription()
@Deprecated boolean mayExecuteWithoutProject()
#mayExecuteInContext(ScheduleTaskDefinitionContext)
true
if createTask(ScheduleEntry,ScheduleTaskFactory.TaskDto)
generated tasks} may be executed without project binding.mayExecuteWithProject()
@Deprecated boolean mayExecuteWithProject()
#mayExecuteInContext(ScheduleTaskDefinitionContext)
true
if generated tasks
may be executed with project binding.mayExecuteWithoutProject()
@NotNull DTO createDto()
Note: this method needs to be called before creating a new task
.
createTask(ScheduleEntry,ScheduleTaskFactory.TaskDto)
@NotNull T createTask(@NotNull ScheduleEntry scheduleEntry, @NotNull DTO dto)
Note: createDto
needs to be called first to obtain a valid DTO.
scheduleEntry
- the ScheduleEntry
dto
- a specialized dto object (see createDto()
)createDto()
@NotNull de.espirit.firstspirit.server.scheduler.TaskExecutor createTaskExecutor()
TaskExecutor
@Nullable <E> E createEditorFactory(@NotNull Class<E> type, @NotNull T task)
null
.type
- desired factory type, current known types are ScheduleTaskDialogFactory
for the java clientand TODO (name class for web client)task
- a specialized task object<
- E > dialog factory typeboolean isLicensed(@NotNull SpecialistsBroker broker)
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210