public interface ScheduleStorage
Modifier and Type | Field and Description |
---|---|
static String |
GENERATE_FULL
Name for default full generation task.
|
static String |
GENERATE_PARTLY
Name for default partial generation task.
|
Modifier and Type | Method and Description |
---|---|
ScheduleEntry |
copyScheduleEntry(ScheduleEntry scheduleEntry,
Project project)
Copies the given
scheduleEntry to another project. |
ScheduleEntry |
createScheduleEntry(String name) |
ScheduleTaskTemplate |
createScheduleTaskTemplate()
the created
ScheduleTaskTemplate |
InputStream |
getDefaultMailText()
Returns the default mail text used for
MailTask |
List<ScheduleEntryControl> |
getHistory(Date from,
Date until,
int maxCount,
boolean includeProjectEntries)
Get the execution history of server schedule entries.
|
List<ScheduleEntryControl> |
getHistory(Date from,
Date until,
int maxCount,
Project project)
Get the execution history of schedule entries of the given project.
|
List<ScheduleEntry> |
getQueuedEntries()
Returns the list schedule entries that would be executed in the future.
|
List<ScheduleEntryControl> |
getRunningEntries()
Returns the list of running schedule entries.
|
List<ScheduleEntry> |
getScheduleEntries(boolean includeProjectEntries) |
List<ScheduleEntry> |
getScheduleEntries(Project project) |
ScheduleEntry |
getScheduleEntry(long id)
Returns the schedule entry specified by the given id.
|
ScheduleEntry |
getScheduleEntry(Project project,
String name)
Returns the specified entry or
null if it couldn't be found. |
ScheduleTaskTemplate |
getScheduleTaskTemplate(long id)
Returns the
ScheduleTaskTemplate with the given id or null for an unknown id. |
List<ScheduleTaskTemplate> |
getScheduleTaskTemplates(Project project) |
static final String GENERATE_FULL
static final String GENERATE_PARTLY
@NotNull ScheduleTaskTemplate createScheduleTaskTemplate()
ScheduleTaskTemplate
@Nullable ScheduleTaskTemplate getScheduleTaskTemplate(long id)
ScheduleTaskTemplate
with the given id or null
for an unknown id.id
- ScheduleTaskTemplate
id.ScheduleTaskTemplate
with the given id or null
for an unknown id.@NotNull List<ScheduleTaskTemplate> getScheduleTaskTemplates(@Nullable Project project)
project
- a Project
or null
for server dependent ScheduleTaskTemplate
'sScheduleTaskTemplate
's for given project@NotNull ScheduleEntry createScheduleEntry(String name)
name
- name of the created ScheduleEntry
the created ScheduleEntry
@NotNull ScheduleEntry copyScheduleEntry(@NotNull ScheduleEntry scheduleEntry, @Nullable Project project)
scheduleEntry
to another project. scheduleEntry
- to copyproject
- destination project or null
to make a server-wide schedule entry.ScheduleEntry
.@NotNull List<ScheduleEntry> getScheduleEntries(boolean includeProjectEntries)
includeProjectEntries
- true
if all existant schedule entries should be returned, false
if only server dependent entries should be returned
a list of schedule entries@NotNull List<ScheduleEntry> getScheduleEntries(@NotNull Project project)
project
- the project which entries should be returned
a list of schedule entries depending to given project@Nullable ScheduleEntry getScheduleEntry(@NotNull Project project, String name)
null
if it couldn't be found.project
- the project which entries should be scanned.name
- schedule entry name.null
.@NotNull List<ScheduleEntryControl> getRunningEntries()
@NotNull List<ScheduleEntry> getQueuedEntries()
paralle execution mode
is set to DISALLOWED_WAIT
.@NotNull List<ScheduleEntryControl> getHistory(Date from, Date until, int maxCount, boolean includeProjectEntries)
from
- start date, only entries which were started at or after this date will be contained in the resultuntil
- end date, only entries which were started at or before this date will be contained in the resultmaxCount
- the maximum count of entries which should be contained in the resultincludeProjectEntries
- true if include project schedule entries, false otherwise@NotNull List<ScheduleEntryControl> getHistory(Date from, Date until, int maxCount, @NotNull Project project)
from
- start date, only entries which were started at or after this date will be contained in the resultuntil
- end date, only entries which were started at or before this date will be contained in the resultmaxCount
- the maximum count of entries which should be contained in the resultproject
- the project whose schedule entries are to be displayed@NotNull ScheduleEntry getScheduleEntry(long id)
id
- the id of requested ScheduleEntry
the ScheduleEntry
with the given idIllegalArgumentException
- if no schedule entry was found with the given id@NotNull InputStream getDefaultMailText() throws IOException
MailTask
IOException
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500