ScheduleEntry (FirstSpirit Access-API)

All Superinterfaces:: Lockable

public interface ScheduleEntry
extends Lockable

Since:: 4.0

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ScheduleEntry.ParallelExecutionMode
The modes used to set the ParallelExecutionMode of this entry

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ScheduleEntry.ParallelExecutionMode` The modes used to set the `ParallelExecutionMode` of this entry

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGroup(Group group)`
`void`	`addUser(User user)`
`<T extends ScheduleTask> T`	`copyTask(T value)` Copy's the given task.
`<T extends ExecutionSchedule> T`	`createExecutionSchedule(Class<T> type)` Changes the `ExecutionSchedule` of this schedule entry to the given type.
`<T extends ScheduleTask> T`	`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()`
`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()` Queries the server if this entry is running.
`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()`
`boolean`	`isSystem()` Returns `true` if this `ScheduleEntry` is a system schedule entry or not.
`void`	`removeGroup(Group group)`
`void`	`removeUser(User user)`
`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)`
`void`	`setEmail(String value)`
`void`	`setFolderName(String value)`
`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)`

Methods inherited from interface de.espirit.firstspirit.access.Lockable
isLocked, lock, refresh, save, unlock

- Method Detail
  - getId
```
long getId()
```
    -1 for unsaved new entries
    
    Since:
    
    4.0
  - getRunningEntries
```
List<ScheduleEntryControl> getRunningEntries()
```
    Queries the server if this entry is running.
    
    Returns:
    List
    Since:
    
    4.0
  - execute
```
ScheduleEntryControl execute()
                             throws ScheduleEntryRunningException
```
    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.
    
    Returns:
    ScheduleEntryControl
    
    Throws:
    
    ScheduleEntryRunningException - If the ScheduleEntry is already running.
    Since:
    
    4.0
  - getName
```
@NotNull
String getName()
```
    Returns the name of this ScheduleEntry.
    
    Returns:
    String
    Since:
    
    4.0
  - setName
```
void setName(@NotNull
           String value)
```
    Provide the name of this ScheduleEntry.
    
    Parameters:
    value - the name
    Since:
    
    4.0
  - getDescription
```
@Nullable
String getDescription()
```
    Since:
    
    4.0
  - setDescription
```
void setDescription(@Nullable
                  String value)
```
    Since:
    
    4.0
  - isActive
```
boolean isActive()
```
    Returns true if this ScheduleEntry is active, false otherwise.
    
    Returns:
    true if this ScheduleEntry is active, false otherwise.
    Since:
    
    4.0
  - isSystem
```
boolean isSystem()
```
    Returns true if this ScheduleEntry is a system schedule entry or not.
    System entries could not be deleted and some properties could not be changed (e.g. the name).
    
    Returns:
    true if this is a system entry, false otherwise
    Since:
    
    4.0
  - setActive
```
void setActive(boolean value)
```
    Provide true if this ScheduleEntry should be activated, false otherwise.
    
    Parameters:
    value - true if this ScheduleEntry should be activated, false otherwise.
    Since:
    
    4.0
  - getTasks
```
List<ScheduleTask> getTasks()
```
    Returns a List of ScheduleTask which belongs to this schedule entry.
    
    Returns:
    a List of ScheduleTask which belongs to this schedule entry.
    Since:
    
    4.0
  - createTask
```
<T extends ScheduleTask> T createTask(Class<T> type)
```
    Creates a ScheduleTask with type type. To add the created ScheduleTask to this ScheduleEntry use getTasks().add().
    
    Parameters:
    type - The class ScheduleTask should have.
    
    Returns:
    The created ScheduleTask
    Since:
    
    4.0
  - createTask
```
@NotNull
ScheduleTask createTask(@NotNull
                              ScheduleTaskTemplate template)
```
    Creates a 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().
    
    Parameters:
    template - The ScheduleTaskTemplate to use.
    
    Returns:
    The created ScheduleTask
    Since:
    
    4.0
  - copyTask
```
@NotNull
<T extends ScheduleTask> T copyTask(@NotNull
                                          T value)
```
    Copy's the given task.
    
    Parameters:
    value - The ScheduleTask to copy
    
    Returns:
    The copy of the ScheduleTask
    Since:
    
    4.0
  - getEmail
```
@Nullable
String getEmail()
```
    The e-mail adress(es) which will be used for status mails for finished tasks.
    
    Returns:
    null or e-mail adresses seperated with ";"
    Since:
    
    4.0
    
    See Also:
    setEmail(String)
  - setEmail
```
void setEmail(@Nullable
            String value)
```
    Parameters:
    value - null or e-mail adresses seperated with ";", an empty string will be mapped to null
    Since:
    
    4.0
    
    See Also:
    getEmail()
  - isProjectSchedule
```
boolean isProjectSchedule()
```
    Returns:
    true for project specific tasks
    Since:
    4.0 See Also: getProject()
  getProject @Nullable Project getProject() Returns the project for project specific tasks or null if it is a non project related entry Returns: the project for project specific tasks or null for server entries Since: 4.0 setProject void setProject(@Nullable Project project) Parameters: project - null for a project independent ScheduleEntry Since: 4.0 getExecutionSchedule @NotNull ExecutionSchedule getExecutionSchedule() Returns the ExecutionSchedule of this ScheduleEntry. Returns: the ExecutionSchedule of this ScheduleEntry. Since: 4.0 See Also: ExecutionSchedule createExecutionSchedule <T extends ExecutionSchedule> T createExecutionSchedule(Class<T> type) Changes the ExecutionSchedule of this schedule entry to the given type. Parameters: type - The class ExecutionSchedule should have. Returns: The created ExecutionSchedule Since: 4.0 See Also: ExecutionSchedule isChanged boolean isChanged() true if this ScheduleEntry has been changed, false otherwise Specified by: isChanged in interface Lockable Returns: true if this object is changed locally, false otherwise Since: 4.0 getStatistic ScheduleEntryStatistic getStatistic() Statistic of this ScheduleEntry. Since: 4.0 See Also: ScheduleEntryStatistic resetStatistic void resetStatistic() Resets the statistic of this ScheduleEntry. Since: 4.0 delete boolean delete() Deletes this ScheduleEntry. The ScheduleEntry has to be locked before calling this method. Returns: true if ScheduleEntry has been deleted, false otherwise. Since: 4.0 getAllowInteractiveExecution boolean getAllowInteractiveExecution() true if interactive execution is allowed, false otherwise (default). Since: 4.0 setAllowInteractiveExecution void setAllowInteractiveExecution(boolean value) Provide true if interactive execution should be allowed, false otherwise (default). Parameters: value - true or false Since: 4.0 getUsers @NotNull List<User> getUsers() a List of type User containing all users allowed to execute this ScheduleEntry interactive. Since: 4.0 addUser void addUser(@NotNull User user) Parameters: user - the user which should be allowed to execute this schedule entry interactively Since: 4.0 removeUser void removeUser(@NotNull User user) Parameters: user - the user which should not be allowed to execute this schedule entry interactively anymore Since: 4.0 getGroups @NotNull List<Group> getGroups() a List of type Group containing all groups allowed to execute this ScheduleEntry interactive. Since: 4.0 addGroup void addGroup(@NotNull Group group) Parameters: group - the group which users should be allowed to execute this schedule entry interactively Since: 4.0 removeGroup void removeGroup(@NotNull Group group) Parameters: group - the group which users should not be allowed to execute this schedule entry interactively anymore Since: 4.0 getParallelExecutionMode @NotNull ScheduleEntry.ParallelExecutionMode getParallelExecutionMode() the ParallelExecutionMode of this entry. Since: 4.0 See Also: ParallelExecutionMode setParallelExecutionMode void setParallelExecutionMode(@NotNull ScheduleEntry.ParallelExecutionMode mode) Changes the ParallelExecutionMode to the given mode. Parameters: mode - the ParallelExecutionMode Since: 4.0 See Also: ParallelExecutionMode getFolderName @NotNull 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 Since: 4.0 setFolderName void setFolderName(@NotNull String value) Parameters: value - the folder name where pages should be generated in. if value is null or length equals 0 the default folder name will be used on task execution (the schedule entry id) Since: 4.0

Interface ScheduleEntry

Nested Class Summary

Method Summary

Methods inherited from interface de.espirit.firstspirit.access.Lockable

Method Detail

getId

getRunningEntries

execute

getName

setName

getDescription

setDescription

isActive

isSystem

setActive

getTasks

createTask

createTask

copyTask

getEmail

setEmail

isProjectSchedule

getProject

setProject

getExecutionSchedule

createExecutionSchedule

isChanged

getStatistic

resetStatistic

delete

getAllowInteractiveExecution

setAllowInteractiveExecution

getUsers

addUser

removeUser

getGroups

addGroup

removeGroup

getParallelExecutionMode

setParallelExecutionMode

getFolderName

setFolderName