Package de.espirit.firstspirit.access

Interface Workflowable

All Known Subinterfaces:

Allowed, Body, ChannelSourceProvider, Content2, Content2Params, Content2Section, ContentFolder, ContentProducer, ContentStoreRoot, ContentWorkflowable, DataProvider, Dataset, DocLink, DocumentGroup, File, FolderLangSpec, FormatTemplate, FormatTemplateChannel, FormatTemplateContainer, FormatTemplateFolder, FormatTemplates, GCABody, GCAFolder, GCAPage, GCASection, GlobalContentArea, GlobalStoreRoot, GomSourceProvider, IDProvider, LanguageInfo, LinkTemplate, LinkTemplates, MasterTemplate, Media, MediaElement, MediaFolder, MediaStoreRoot, PackagePoolItem, Page, PageFolder, PageGroup, PageLangSpec, PageRef, PageRefFolder, PageStoreRoot, PageTemplate, PageTemplates, Picture, PictureResolution, Previewable, PreviewImageProvider, ProjectProperties, Query, Referenceable, Schema, SchemaContainer, SchemaFolder, Schemes, Script, ScriptContainer, ScriptFolder, Scripts, Section<T>, SectionReference<T>, SectionTemplate, SectionTemplates, SiteStoreFolder, SiteStoreRoot, StartNode, Store, StoreElement, StyleTemplate, StyleTemplateLink, TableFormatTemplate, TableTemplate, Template, TemplateBody, TemplateContainer<T>, TemplateContentProvider, TemplateExtension, TemplateFolder<T>, TemplateProvider<T>, TemplateStoreElement, TemplateStoreRoot, URLProperties, UserProperties, Workflow, WorkflowContainer, WorkflowFolder, Workflows

public interface Workflowable

Implementors are FirstSpirit elements which allows starting a workflow.

Since:

3.1.168

See Also:

• Task

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes this Workflowable.
@Nullable Color	getColor()	Get the color of the current state.
@Nullable Task	getTask()	Get the possible assigned Task or null.
boolean	hasTask()	Does this elements has a Task assigned?
void	removeTask()	Removes a already set Task.
void	setColor(Color color)	Set a new color.
void	setTask(Task task)	Set the given Task.

Method Details

hasTask

@ApiDoc(comment="Does this elements has a Task assigned?",
        since="3.1.168")
boolean hasTask()

Does this elements has a Task assigned?

Since:

3.1.168

See Also:

• StoreElement
• Task

getTask

@ApiDoc(comment="Get the possible assigned Task or null.",
        since="3.1.168")
@Nullable
@Nullable Task getTask()

Get the possible assigned Task or null.

Returns:

the Task or null

Since:

3.1.168

See Also:

• Task
• setTask(Task)

setTask

@ApiDoc(comment="Set the given Task.",
        since="3.1.168")
void setTask(Task task)

Set the given Task.

Since:

3.1.168

See Also:

• Task
• getTask()

removeTask

@ApiDoc(comment="Removes a already set Task.",
        since="3.1.168")
void removeTask()

Removes a already set Task.

Since:

3.1.168

getColor

@ApiDoc(comment="Get the color of the current state.",
        since="3.1.168")
@Nullable
@Nullable Color getColor()

Get the color of the current state.

Returns:

the color or null

Since:

3.1.168

See Also:

• State.getColor()

setColor

@ApiDoc(comment="Set a new color.",
        since="3.1.168")
void setColor(Color color)

Set a new color.

Since:

3.1.168

See Also:

• State.getColor()

delete

@ApiDoc(comment="Deletes this Workflowable.",
        since="4.0.122")
void delete()
     throws LockException

Deletes this Workflowable.

Throws:

LockException - if the direct parent is locked in a different session

Since:

4.0.122