Package com.xwiki.task

Interface TaskReferenceGenerator

@Role
@Unstable
public interface TaskReferenceGenerator

Handles the reference generation for the tasks.

Since:

3.0

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.DocumentReference	generate(org.xwiki.model.reference.DocumentReference parent)	Generate a reference for a task, relative to its parent.

Method Details

generate

org.xwiki.model.reference.DocumentReference generate(org.xwiki.model.reference.DocumentReference parent)
                                              throws TaskException

Generate a reference for a task, relative to its parent.

Parameters:

parent - the parent of the task.

Returns:

a reference to the task. It can be either a child of the parent, a sibling or it can be a child to the default TaskManager home, depending on the rights of the current user.

Throws:

TaskException