Package de.espirit.firstspirit.access.schedule

Interface GenerateTask

All Superinterfaces:

ScheduleTask

public interface GenerateTask
extends ScheduleTask

Generation task.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GenerateTask.EntityEntry	An entry referencing an Entity and a PageRef node.
static enum	GenerateTask.GenerationSource	Source used for generating.
static enum	GenerateTask.SuccessCondition	The condition the generate task should be marked as "finished successful"
static enum	GenerateTask.Type	The generation Type used for this generate task

Method Summary

Modifier and Type	Method	Description
GenerateTask.EntityEntry	createEntityEntry(long entityId, long pageRefId)	Create an entry which may be added to the entity start node list.
List<UrlCreatorSpecification>	getAvailableUrlCreatorSpecifications()	Get available url creators.
boolean	getCancelScheduleWhenNoChanges()	true if execution should be canceled if there are no changes, false otherwise.
boolean	getCreateGenerateTag()	Should a tagged repository revision be created for this generation.
boolean	getCreateMediaFiles()	true if media files should be created, false otherwise.
boolean	getDeleteDirectory()	true if directory should be deleted before generation, false otherwise
Collection<GenerateTask.EntityEntry>	getEntityStartNodes()	Returns a modifyable Collection of entity start nodes.
long	getErrorThreshold()	Returns the threshold of errors until generation should be canceled
boolean	getGenerateFlag(Language language, TemplateSet templateSet)	Get the generate flag for a specific language/template set combination.
List<Pair<Language,TemplateSet>>	getGenerateList()	Get a list of language/template set combinations which should be generated.
@NotNull GenerateTask.GenerationSource	getGenerationSource()	Get the generation source state.
@NotNull List<IDProvider>	getStartNodes()	Returns a modifyable list of start nodes for a partial generate.
boolean	getStartnodesDefinableByUser()	true if the startnodes are definable by the user, false otherwise (default)
GenerateTask.SuccessCondition	getSuccessCondition()	GenerateTask.SuccessCondition
@NotNull GenerateTask.Type	getType()	The generation type used for this GenerateTask
String	getUrlCreatorClassName()	Deprecated. since 5.0 - use getUrlCreatorSpecification().
@NotNull UrlCreatorSpecification	getUrlCreatorSpecification()	Get the url creator setting.
String	getUrlPrefix()	The url prefix
@NotNull List<Map.Entry<String,String>>	getVariables()	A set of variables set for this GenerateTask
long	getWarningThreshold()	Returns the threshold of warnings until generation should be canceled.
void	removeVariable(@NotNull String name)	Removes a variable having the given name.
void	setCancelScheduleWhenNoChanges(boolean value)	Provide true if execution should be canceled if there are no changes, false otherwise
void	setCreateGenerateTag(boolean createTag)	Should a tagged repository revision be created for this generation.
void	setCreateMediaFiles(boolean value)	Provide true if media files should be created, false otherwise.
void	setDeleteDirectory(boolean value)	Provide true if directory should be deleted before generation, false otherwise
void	setErrorThreshold(long value)	Provide the threshold of errors until generation should be canceled.
void	setGenerateFlag(Language language, TemplateSet templateSet, boolean generate)	Set the generate flag for a specific language/template set combination.
void	setGenerationSource(@NotNull GenerateTask.GenerationSource value)	Set the source version to use for generation.
void	setStartnodesDefinableByUser(boolean value)	Provide true if the startnodes should be definable by the user, false otherwise (default).
void	setSuccessCondition(GenerateTask.SuccessCondition value)	Provide a SuccessCondition
void	setType(@NotNull GenerateTask.Type type)	Provide the Type used for this GenerateTask.
void	setUrlCreatorClassName(String value)	Deprecated. since 5.0 - use setUrlCreatorSpecification(UrlCreatorSpecification).
void	setUrlCreatorSpecification(@NotNull UrlCreatorSpecification value)	Set the url creator specifiaction.
void	setUrlPrefix(String value)	Provide the url prefix
void	setUseAclDb(boolean value)	Set Access Control databse usage.
void	setVariable(@NotNull String name, @Nullable String value)	Sets a value to a variable with the given name.
void	setWarningThreshold(long value)	Set the threshold of warnings until generation should be canceled.
boolean	useAclDb()	Should the Access Control databse be used.

Methods inherited from interface de.espirit.firstspirit.access.schedule.ScheduleTask

checkParams, getClusterNodeName, getDescription, getExecuteInFault, getExecuteParallel, getName, getRemoteTaskType, getScheduleEntry, getTemplate, hasTemplate, isActive, isExecuteOnClusterNode, isProjectTask, setActive, setClusterNodeName, setDescription, setExecuteInFault, setExecuteOnClusterNode, setExecuteParallel, setName, setTemplate, test

Method Details

getType

@NotNull
@NotNull GenerateTask.Type getType()

The generation type used for this GenerateTask

Since:

4.0

setType

void setType(@NotNull
 @NotNull GenerateTask.Type type)

Provide the Type used for this GenerateTask.

Parameters:

type - the Type used for this GenerateTask

Since:

4.0

getVariables

@NotNull
@NotNull List<Map.Entry<String,String>> getVariables()

A set of variables set for this GenerateTask

Since:

4.0

setVariable

void setVariable(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable String value)

Sets a value to a variable with the given name.

Parameters:

name - The variable's name.

value - The value to set.

Since:

4.0

removeVariable

void removeVariable(@NotNull
 @NotNull String name)

Removes a variable having the given name.

Parameters:

name - The variable's name.

Since:

4.0

getStartnodesDefinableByUser

boolean getStartnodesDefinableByUser()

true if the startnodes are definable by the user, false otherwise (default)

Since:

4.0

setStartnodesDefinableByUser

void setStartnodesDefinableByUser(boolean value)

Provide true if the startnodes should be definable by the user, false otherwise (default).

Parameters:

value - true if the startnodes should be definable by the user, false otherwise (default)

Since:

4.0

getStartNodes

@NotNull
@NotNull List<IDProvider> getStartNodes()

Returns a modifyable list of start nodes for a partial generate.

You may clear the list, add, and remove elements. Only elements of Store.Type#SITESTORE and Store.Type#MEDIASTORE can be added.

Returns:

A modifyable list of start nodes, containing e.g. page refs or media nodes.

Since:

4.0

getCreateMediaFiles

boolean getCreateMediaFiles()

true if media files should be created, false otherwise.

Since:

4.0

setCreateMediaFiles

void setCreateMediaFiles(boolean value)

Provide true if media files should be created, false otherwise.

Parameters:

value - true if media files should be created, false otherwise.

Since:

4.0

getUrlCreatorClassName

@Deprecated
String getUrlCreatorClassName()

Deprecated.

since 5.0 - use getUrlCreatorSpecification().

The url creator class name

Since:

4.0

setUrlCreatorClassName

@Deprecated
void setUrlCreatorClassName(String value)

Deprecated.

since 5.0 - use setUrlCreatorSpecification(UrlCreatorSpecification).

Provide the url creator class name.

Parameters:

value - The url creator class name

Since:

4.0

getUrlCreatorSpecification

@NotNull
@NotNull UrlCreatorSpecification getUrlCreatorSpecification()

Get the url creator setting.

Returns:

The current url creator specification.

Throws:

IllegalStateException - If the specification could not be loaded.

Since:

5.0

See Also:

• setUrlCreatorSpecification(UrlCreatorSpecification)
• getAvailableUrlCreatorSpecifications()

setUrlCreatorSpecification

void setUrlCreatorSpecification(@NotNull
 @NotNull UrlCreatorSpecification value)

Set the url creator specifiaction.

Parameters:

value - the new url creator specification

Since:

5.0

See Also:

• getUrlCreatorSpecification()
• getAvailableUrlCreatorSpecifications()

getAvailableUrlCreatorSpecifications

List<UrlCreatorSpecification> getAvailableUrlCreatorSpecifications()

Get available url creators.

Returns:

List of available url creator specifications

Since:

5.0

See Also:

• getUrlCreatorSpecification()
• setUrlCreatorSpecification(UrlCreatorSpecification)

getCancelScheduleWhenNoChanges

boolean getCancelScheduleWhenNoChanges()

true if execution should be canceled if there are no changes, false otherwise.

Since:

4.0

setCancelScheduleWhenNoChanges

void setCancelScheduleWhenNoChanges(boolean value)

Provide true if execution should be canceled if there are no changes, false otherwise

Parameters:

value - true if execution should be canceled if there are no changes, false otherwise

Since:

4.0

getDeleteDirectory

boolean getDeleteDirectory()

true if directory should be deleted before generation, false otherwise

Since:

4.0

setDeleteDirectory

void setDeleteDirectory(boolean value)

Provide true if directory should be deleted before generation, false otherwise

Parameters:

value - true if directory should be deleted before generation, false otherwise

Since:

4.0

getUrlPrefix

String getUrlPrefix()

The url prefix

Since:

4.0

setUrlPrefix

void setUrlPrefix(String value)

Provide the url prefix

Parameters:

value - the url prefix

Since:

4.0

getSuccessCondition

GenerateTask.SuccessCondition getSuccessCondition()

GenerateTask.SuccessCondition

Since:

4.0.120

setSuccessCondition

void setSuccessCondition(GenerateTask.SuccessCondition value)

Provide a SuccessCondition

Since:

4.0.120

getErrorThreshold

long getErrorThreshold()

Returns the threshold of errors until generation should be canceled

Since:

4.0

See Also:

• getSuccessCondition()

setErrorThreshold

void setErrorThreshold(long value)

Provide the threshold of errors until generation should be canceled.

Parameters:

value - the threshold of errors until generation should be canceled

Since:

4.0

See Also:

• getSuccessCondition()

getWarningThreshold

long getWarningThreshold()

Returns the threshold of warnings until generation should be canceled.

Since:

4.0

See Also:

• getSuccessCondition()

setWarningThreshold

void setWarningThreshold(long value)

Set the threshold of warnings until generation should be canceled.

Parameters:

value - the threshold of warnings until generation should be canceled

Since:

4.0

See Also:

• getSuccessCondition()

setGenerateFlag

void setGenerateFlag(Language language,
 TemplateSet templateSet,
 boolean generate)

Set the generate flag for a specific language/template set combination.

Since:

4.0

See Also:

• getGenerateFlag(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.project.TemplateSet)
• getGenerateList()

getGenerateFlag

boolean getGenerateFlag(Language language,
 TemplateSet templateSet)

Get the generate flag for a specific language/template set combination.

Since:

4.0

See Also:

• setGenerateFlag(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.project.TemplateSet, boolean)
• getGenerateList()

getGenerateList

List<Pair<Language,TemplateSet>> getGenerateList()

Get a list of language/template set combinations which should be generated.

Since:

4.0

See Also:

• setGenerateFlag(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.project.TemplateSet, boolean)
• getGenerateFlag(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.project.TemplateSet)

useAclDb

boolean useAclDb()

Should the Access Control databse be used.

Since:

4.1

setUseAclDb

void setUseAclDb(boolean value)

Set Access Control databse usage.

Since:

4.1

setCreateGenerateTag

void setCreateGenerateTag(boolean createTag)

Should a tagged repository revision be created for this generation. If set to false no tagged repository revision will be created.

Parameters:

createTag - true if a tag should be generated

Since:

4.2.402

getCreateGenerateTag

boolean getCreateGenerateTag()

Should a tagged repository revision be created for this generation. Default value is true.

Returns:

true if a tag should be generated

Since:

4.2.402

createEntityEntry

GenerateTask.EntityEntry createEntityEntry(long entityId,
 long pageRefId)

Create an entry which may be added to the entity start node list. This is only possible for entities with numeric keys (entity.getKeyValue().getValue(0) instanceof Number).

Since:

5.0.4

See Also:

• getEntityStartNodes()

getEntityStartNodes

Collection<GenerateTask.EntityEntry> getEntityStartNodes()

Returns a modifyable Collection of entity start nodes. For partial generations all these combinations (of Entity and PageRef) will be generated.

You may clear the collection, add, and remove elements.

Warning: There is no persistence for this Collection. Initially this list is empty. If elements are added during a client session these elements will remain in the list until you call clear(). So to be safe you should always clear the list first.

Returns:

A modifiable collection of entity entries.

Since:

5.0.4

See Also:

• createEntityEntry(long, long)

getGenerationSource

@NotNull
@NotNull GenerateTask.GenerationSource getGenerationSource()

Get the generation source state. Default value is GenerateTask.GenerationSource.RELEASE for projects supporting release, GenerateTask.GenerationSource.CURRENT otherwise.

Returns:

The generation source state (never null).

Since:

5.2.1503

See Also:

• setGenerationSource(GenerationSource)

setGenerationSource

void setGenerationSource(@NotNull
 @NotNull GenerateTask.GenerationSource value)

Set the source version to use for generation.

Parameters:

value - New generation source state (never null).

Since:

5.2.1503

See Also:

• getGenerationSource()