public interface JobAgent
Modifier and Type | Field and Description |
---|---|
static SpecialistType<JobAgent> |
TYPE
Agent providing access to the overall information of the active job.
|
Modifier and Type | Method and Description |
---|---|
void |
abort()
Abort this job and all currently running tasks.
|
FileHandle |
getFolder()
Provides a handle to the job folder.
|
String |
getFolderPath()
Provides the absolute path to the job folder.
|
Date |
getStartingTime()
Provides the starting time of the job.
|
Object |
getVariable(String name)
Gets the variable value stored by the given name.
|
void |
setVariable(String name,
Object value)
Sets the variable of the given name to the defined value.
|
static final SpecialistType<JobAgent> TYPE
@NotNull Date getStartingTime()
@Nullable Object getVariable(@NotNull String name)
name
- The variable's name.void setVariable(@NotNull String name, @Nullable Object value)
name
- The variable's name.value
- The variable's value.@NotNull FileHandle getFolder() throws IOException
IOException
- If the folder could not be found or accessed.@NotNull String getFolderPath()
void abort()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210