org.apache.wiki.tasks

Interface TasksManager

All Known Implementing Classes:

DefaultTasksManager

public interface TasksManager

Manager responsible of creation of the different JSPWiki Steps. Instances of classes generated by this TasksManager are assumed to have been added to an approval workflow via org.apache.wiki.workflow.WorkflowBuilder#buildApprovalWorkflow(Principal, String, Task, String, org.apache.wiki.workflow.Fact[], Task, String); they will not function correctly otherwise.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_PROFILE_SAVE_TASK_MESSAGE_KEY The message key of the text to finally approve a user profile save.
static String	WIKIPAGE_PRESAVE_TASK_MESSAGE_KEY The message key for storing the text for the presave task.
static String	WIKIPAGE_SAVE_TASK_MESSAGE_KEY The message key of the text to finally approve a page save.

Method Summary

Modifier and Type	Method and Description
Step	buildPreSaveWikiPageTask(WikiContext context, String proposedText) Builds a pre-save WikiPage task.
Step	buildSaveUserProfileTask(WikiEngine engine, Locale loc) Builds a save user profile task.
Step	buildSaveWikiPageTask() Builds a save WikiPage task.

Field Detail

WIKIPAGE_PRESAVE_TASK_MESSAGE_KEY

static final String WIKIPAGE_PRESAVE_TASK_MESSAGE_KEY

The message key for storing the text for the presave task. Value is "task.preSaveWikiPage".

See Also:

Constant Field Values

WIKIPAGE_SAVE_TASK_MESSAGE_KEY

static final String WIKIPAGE_SAVE_TASK_MESSAGE_KEY

The message key of the text to finally approve a page save. Value is "task.saveWikiPage".

See Also:

Constant Field Values

USER_PROFILE_SAVE_TASK_MESSAGE_KEY

static final String USER_PROFILE_SAVE_TASK_MESSAGE_KEY

The message key of the text to finally approve a user profile save. Value is "task.createUserProfile".

See Also:

Constant Field Values

Method Detail

buildPreSaveWikiPageTask

Step buildPreSaveWikiPageTask(WikiContext context,
                              String proposedText)

Builds a pre-save WikiPage task.

Parameters:

context - associated wiki context.

proposedText - text proposed to be saved on the wiki page.

Returns:

a pre-save WikiPage task.

buildSaveWikiPageTask

Step buildSaveWikiPageTask()

Builds a save WikiPage task.

Returns:

a save WikiPage task.

buildSaveUserProfileTask

Step buildSaveUserProfileTask(WikiEngine engine,
                              Locale loc)

Builds a save user profile task.

Parameters:

engine - associated wiki context.

loc - text proposed to be saved on the wiki page.

Returns:

a save user profile task.