de.espirit.firstspirit.access.schedule

Interface ScheduleTaskTemplate

All Superinterfaces:

Lockable

public interface ScheduleTaskTemplate
extends Lockable

Since:

4.0

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ScheduleTask> T	createTask(Class<T> type) Create and set a task of the provided type.
boolean	delete() To delete this template it has to be locked
long	getId() -1 for unsaved new task templates
Project	getProject() the project for project specific task templates
ScheduleTask	getTask() The task instance.
int	getUsageCount() Returns the number of usages of this template.
List<ScheduleEntry>	getUsages() a list of schedule entries which contains task that use this template
boolean	isChanged() true if this template has been changed, false otherwise
boolean	isProjectTaskTemplate() true for project specific task templates
boolean	isPublic() returns true if this template is visible for other projects, false if this template is only available for local usage note: only server schedule task templates can be public
void	setProject(Project project)
void	setPublic(boolean value)

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

isLocked, lock, refresh, save, unlock

Method Detail

getId

long getId()

-1 for unsaved new task templates

Since:

4.0

isProjectTaskTemplate

boolean isProjectTaskTemplate()

true for project specific task templates

Since:

4.0

See Also:

getProject()

getProject

@Nullable
Project getProject()

the project for project specific task templates

Since:

4.0

setProject

void setProject(@Nullable
              Project project)

Parameters:

project - null for a project independent schedule task template

Since:

4.0

isChanged

boolean isChanged()

true if this template has been changed, false otherwise

Specified by:

isChanged in interface Lockable

Returns:

true if this object is changed locally, false otherwise

Since:

4.0

isPublic

boolean isPublic()

returns true if this template is visible for other projects, false if this template is only available for local usage
note: only server schedule task templates can be public

Returns:

true if this template is visible for other projects, false if this template is only available for local usage

Since:

4.0

setPublic

void setPublic(boolean value)

Parameters:

value - true if this template should be visible for other projects, false if this template should be only available for local usage

Since:

4.0

getTask

@Nullable
ScheduleTask getTask()

The task instance. For new task templates this is null until createTask(Class) has been called.

Returns:

The current task instance or null if no task instance has been created.

Since:

4.0

See Also:

createTask(Class)

createTask

<T extends ScheduleTask> T createTask(Class<T> type)

Create and set a task of the provided type. Calling this will overwrites the current task!

Parameters:

type - Task type.

Returns:

The created task.

Since:

4.0

delete

boolean delete()

To delete this template it has to be locked

Returns:

true if template could be deleted, false otherwise

Since:

4.0

getUsages

@NotNull
List<ScheduleEntry> getUsages()

a list of schedule entries which contains task that use this template

Since:

4.0

getUsageCount

int getUsageCount()

Returns the number of usages of this template.

Returns:

the number of usages

Since:

5.0.31

See Also:

getUsages()