public interface GenerateTask extends ScheduleTask
Modifier and Type | Interface and Description |
---|---|
static interface |
GenerateTask.EntityEntry
|
static class |
GenerateTask.SuccessCondition
The condition the generate task should be marked as "finished successful"
|
static class |
GenerateTask.Type
The generation
Type used for this generate task |
Modifier and Type | Method and 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.
|
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.Type |
getType()
The generation
used for this GenerateTask |
String |
getUrlCreatorClassName()
Deprecated.
since 5.0 - use
getUrlCreatorSpecification() . |
UrlCreatorSpecification |
getUrlCreatorSpecification()
Get the url creator setting.
|
String |
getUrlPrefix()
The url prefix
|
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(String 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 |
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(GenerateTask.Type type)
Provide the
used for this GenerateTask . |
void |
setUrlCreatorClassName(String value)
Deprecated.
since 5.0 - use
setUrlCreatorSpecification(UrlCreatorSpecification) . |
void |
setUrlCreatorSpecification(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(String name,
String value) |
void |
setWarningThreshold(long value)
Set the threshold of warnings until generation should be canceled.
|
boolean |
useAclDb()
Should the Access Control databse be used.
|
checkParams, getClusterNodeName, getDescription, getExecuteInFault, getExecuteParallel, getName, getRemoteTaskType, getScheduleEntry, getTemplate, hasTemplate, isActive, isExecuteOnClusterNode, isProjectTask, setActive, setClusterNodeName, setDescription, setExecuteInFault, setExecuteOnClusterNode, setExecuteParallel, setName, setTemplate, test
@NotNull GenerateTask.Type getType()
type
used for this GenerateTask
void setType(@NotNull GenerateTask.Type type)
Type
used for this GenerateTask
.type
- the Type
used for this GenerateTask
@NotNull List<Map.Entry<String,String>> getVariables()
GenerateTask
boolean getStartnodesDefinableByUser()
true
if the startnodes are definable by the user, false
otherwise (default)void setStartnodesDefinableByUser(boolean value)
true
if the startnodes should be definable by the user, false
otherwise (default).value
- true
if the startnodes should be definable by the user, false
otherwise (default)@NotNull List<IDProvider> getStartNodes()
partial
generate.
You may clear
the list, List#add(Object)add
, and remove
elements.
Only elements of Store.Type#SITESTORE
andStore.Type#MEDIASTORE
can be added.
page refs
ormedia nodes
.boolean getCreateMediaFiles()
true
if media files should be created, false
otherwise.void setCreateMediaFiles(boolean value)
true
if media files should be created, false
otherwise.value
- true
if media files should be created, false
otherwise.@Deprecated String getUrlCreatorClassName()
getUrlCreatorSpecification()
.@Deprecated void setUrlCreatorClassName(String value)
setUrlCreatorSpecification(UrlCreatorSpecification)
.value
- The url creator class name@NotNull UrlCreatorSpecification getUrlCreatorSpecification()
IllegalStateException
- If the specification could not be loaded.setUrlCreatorSpecification(UrlCreatorSpecification)
,
getAvailableUrlCreatorSpecifications()
void setUrlCreatorSpecification(@NotNull UrlCreatorSpecification value)
value
- the new url creator specificationgetUrlCreatorSpecification()
,
getAvailableUrlCreatorSpecifications()
List<UrlCreatorSpecification> getAvailableUrlCreatorSpecifications()
getUrlCreatorSpecification()
,
setUrlCreatorSpecification(UrlCreatorSpecification)
boolean getCancelScheduleWhenNoChanges()
true
if execution should be canceled if there are no changes, false
otherwise.void setCancelScheduleWhenNoChanges(boolean value)
true
if execution should be canceled if there are no changes, false
otherwisevalue
- true
if execution should be canceled if there are no changes, false
otherwiseboolean getDeleteDirectory()
true
if directory should be deleted before generation, false
otherwisevoid setDeleteDirectory(boolean value)
true
if directory should be deleted before generation, false
otherwisevalue
- true
if directory should be deleted before generation, false
otherwiseString getUrlPrefix()
void setUrlPrefix(String value)
value
- the url prefixGenerateTask.SuccessCondition getSuccessCondition()
void setSuccessCondition(GenerateTask.SuccessCondition value)
SuccessCondition
long getErrorThreshold()
getSuccessCondition()
void setErrorThreshold(long value)
value
- the threshold of errors until generation should be canceledgetSuccessCondition()
long getWarningThreshold()
getSuccessCondition()
void setWarningThreshold(long value)
value
- the threshold of warnings until generation should be canceledgetSuccessCondition()
void setGenerateFlag(Language language, TemplateSet templateSet, boolean generate)
boolean getGenerateFlag(Language language, TemplateSet templateSet)
List<Pair<Language,TemplateSet>> getGenerateList()
boolean useAclDb()
void setUseAclDb(boolean value)
void setCreateGenerateTag(boolean createTag)
false
no tagged
repository revision will be created.createTag
- true
if a tag should be generatedboolean getCreateGenerateTag()
true
.true
if a tag should be generatedGenerateTask.EntityEntry createEntityEntry(long entityId, long pageRefId)
entity
start node list
. This is only possible for entities
with numeric keys
(entity.getKeyValue()
.getValue(0)
instanceofNumber
).getEntityStartNodes()
Collection<GenerateTask.EntityEntry> getEntityStartNodes()
partial
generations all these
combinations (of Entity
and PageRef
) will be generated.
You may clear
the collection, Collection#add(Object)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.
entity entries
.createEntityEntry(long,long)
Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408