Modifier and Type | Interface and Description |
---|---|
static class |
ScheduleEntry.ParallelExecutionMode
The modes used to set the
ParallelExecutionMode of this entry |
Modifier and Type | Method and Description |
---|---|
void |
addGroup(Group group)
Adds a group to execute this schedule entry.
|
void |
addUnifiedTask(ScheduleTask task)
Unifies the given task's name and adds it to this entry.
|
void |
addUser(User user)
Adds the given user which should be allowed to execute this schedule entry.
|
<T extends ScheduleTask> |
copyTask(T value)
Copy's the given task.
|
<T extends ExecutionSchedule> |
createExecutionSchedule(Class<T> type)
Changes the
ExecutionSchedule of this schedule entry to the given type. |
<T extends ScheduleTask> |
createTask(Class<T> type)
Creates a
ScheduleTask with type type . |
ScheduleTask |
createTask(ScheduleTaskTemplate template)
Creates a
ScheduleTask which uses all properties of the given ScheduleTaskTemplate . |
boolean |
delete()
Deletes this
ScheduleEntry . |
ScheduleEntryControl |
execute()
Start execution on the server - locked entries will be started with the settings which are actually set on client
side, all other entries will be started with the settings wich are stored on the server.
|
boolean |
getAllowInteractiveExecution()
true if interactive execution is allowed, false otherwise (default). |
String |
getDescription()
Get the description for the schedule entry.
|
String |
getEmail()
The e-mail adress(es) which will be used for status mails for finished tasks.
|
ExecutionSchedule |
getExecutionSchedule()
Returns the
ExecutionSchedule of this ScheduleEntry . |
String |
getFolderName()
the folder name where pages should be generated in
if folder name is null or length zero, the schedule entry id will be used on task execution |
List<Group> |
getGroups()
a
List of type Group containing all groups allowed to execute this ScheduleEntry interactive. |
long |
getId()
-1 for unsaved new entries
|
String |
getName()
Returns the name of this
ScheduleEntry . |
ScheduleEntry.ParallelExecutionMode |
getParallelExecutionMode()
the
ParallelExecutionMode of this entry. |
Project |
getProject()
Returns the project for
project specific tasks or null
if it is a non project related entry |
List<ScheduleEntryControl> |
getRunningEntries()
Returns a list of
schedule entry controls related to this schedule entry and
currently running on the FirstSpirit server. |
ScheduleEntryStatistic |
getStatistic()
Statistic of this
ScheduleEntry . |
List<ScheduleTask> |
getTasks()
Returns a
List of ScheduleTask which belongs to this schedule entry. |
List<User> |
getUsers()
a
List of type User containing all users allowed to execute this ScheduleEntry interactive. |
boolean |
isActive()
Returns
true if this ScheduleEntry is active, false otherwise. |
boolean |
isChanged()
true if this ScheduleEntry has been changed, false otherwise |
boolean |
isProjectSchedule()
Determines if the schedule entry is related to a project.
|
boolean |
isSystem()
Returns
true if this ScheduleEntry is a system
schedule entry or not. |
void |
removeGroup(Group group)
Removes the given group which users shouldn't be allowed to execute the schedule entry anymore.
|
void |
removeUser(User user)
Removes the given user who shouldn't be allowed to execute the schedule entry anymore.
|
void |
resetStatistic()
Resets the statistic of this
ScheduleEntry . |
void |
setActive(boolean value)
Provide
true if this ScheduleEntry should be activated, false otherwise. |
void |
setAllowInteractiveExecution(boolean value)
Provide
true if interactive execution should be allowed, false otherwise (default). |
void |
setDescription(String value)
Sets the given
String as description. |
void |
setEmail(String value)
Sets the e-mail address(es) that should be used for status mails.
|
void |
setFolderName(String value)
Sets the folder (given by its name) where pages should be generated in.
|
void |
setName(String value)
Provide the name of this
ScheduleEntry . |
void |
setParallelExecutionMode(ScheduleEntry.ParallelExecutionMode mode)
Changes the
ParallelExecutionMode to the given mode. |
void |
setProject(Project project)
Sets the project, if the schedule entry should be related to it.
|
long getId()
List<ScheduleEntryControl> getRunningEntries()
schedule entry controls
related to this schedule entry and
currently running on the FirstSpirit server.ScheduleEntryControl execute() throws ScheduleEntryRunningException
ScheduleEntryRunningException
- If the ScheduleEntry
is already running.@NotNull String getName()
ScheduleEntry
.void setName(@NotNull String value)
ScheduleEntry
.value
- the name@Nullable String getDescription()
void setDescription(@Nullable String value)
String
as description.value
- The given String
that should be the schedule entry's description.boolean isActive()
true
if this ScheduleEntry
is active, false
otherwise.true
if this ScheduleEntry
is active, false
otherwise.boolean isSystem()
true
if this ScheduleEntry
is a system
schedule entry or not.true
if this is a system entry, false
otherwisevoid setActive(boolean value)
true
if this ScheduleEntry
should be activated, false
otherwise.value
- true
if this ScheduleEntry
should be activated, false
otherwise.List<ScheduleTask> getTasks()
List
of ScheduleTask
which belongs to this schedule entry.List
of ScheduleTask
which belongs to this schedule entry.<T extends ScheduleTask> T createTask(Class<T> type)
ScheduleTask
with type type
.
To add the created ScheduleTask
to this ScheduleEntry
use
getTasks()
.add()
.type
- The class ScheduleTask
should have.ScheduleTask
void addUnifiedTask(ScheduleTask task)
task
- The task to be added.@NotNull ScheduleTask createTask(@NotNull ScheduleTaskTemplate template)
ScheduleTask
which uses all properties of the given ScheduleTaskTemplate
.
Only parallel execution
and
activity state
of the created instance are modifyable.
To add the created ScheduleTask
to this ScheduleEntry
use
getTasks()
.add()
.template
- The ScheduleTaskTemplate
to use.ScheduleTask
@NotNull <T extends ScheduleTask> T copyTask(@NotNull T value)
value
- The ScheduleTask
to copyScheduleTask
@Nullable String getEmail()
null
or e-mail adresses seperated with ";"setEmail(String)
void setEmail(@Nullable String value)
value
- null
or e-mail addresses separated with ";", an empty string will be mapped to
null
getEmail()
boolean isProjectSchedule()
true for project specific tasks
getProject()
,
setProject(Project)
@Nullable Project getProject()
project specific
tasks or null
if it is a non project related entryproject specific
tasks or null
for server entriesisProjectSchedule()
void setProject(@Nullable Project project)
project
- null
for a project independent ScheduleEntry
getProject()
,
isProjectSchedule()
@NotNull ExecutionSchedule getExecutionSchedule()
ExecutionSchedule
of this ScheduleEntry
.ExecutionSchedule
of this ScheduleEntry
.ExecutionSchedule
<T extends ExecutionSchedule> T createExecutionSchedule(Class<T> type)
ExecutionSchedule
of this schedule entry to the given type.type
- The class ExecutionSchedule
should have.ExecutionSchedule
ExecutionSchedule
boolean isChanged()
true
if this ScheduleEntry
has been changed, false
otherwiseScheduleEntryStatistic getStatistic()
ScheduleEntry
.ScheduleEntryStatistic
void resetStatistic()
ScheduleEntry
.boolean delete()
ScheduleEntry
.
The ScheduleEntry
has to be locked before calling this method.true
if ScheduleEntry
has been deleted, false
otherwise.boolean getAllowInteractiveExecution()
true
if interactive execution is allowed, false
otherwise (default).void setAllowInteractiveExecution(boolean value)
true
if interactive execution should be allowed, false
otherwise (default).value
- true
or false
@NotNull List<User> getUsers()
List
of type User
containing all users allowed to execute this ScheduleEntry
interactive.void addUser(@NotNull User user)
user
- the user which should be allowed to execute this schedule entry interactivelyvoid removeUser(@NotNull User user)
user
- the user which should not be allowed to execute this schedule entry interactively anymore@NotNull List<Group> getGroups()
List
of type Group
containing all groups allowed to execute this ScheduleEntry
interactive.void addGroup(@NotNull Group group)
group
- the group which users should be allowed to execute this schedule entry interactivelyvoid removeGroup(@NotNull Group group)
group
- the group which users should not be allowed to execute this schedule entry interactively anymore@NotNull ScheduleEntry.ParallelExecutionMode getParallelExecutionMode()
ParallelExecutionMode
of this entry.ParallelExecutionMode
void setParallelExecutionMode(@NotNull ScheduleEntry.ParallelExecutionMode mode)
ParallelExecutionMode
to the given mode.mode
- the ParallelExecutionMode
ParallelExecutionMode
@NotNull String getFolderName()
void setFolderName(@NotNull String value)
value
- the folder name where pages should be generated in.value
is null or length equals 0
the default folder name will be used on task execution (the schedule entry id)Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210