Package com.xwiki.task.macro

Class TaskMacroParameters

java.lang.Object

com.xwiki.task.macro.TaskMacroParameters

@Unstable
public class TaskMacroParameters
extends Object

Since:

3.0

Version:

$Id$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TaskMacroParameters.IdDisplay	We define the values for the isDisplayed property as an enum in order to be able to detect when the property is not set.

Constructor Summary

Constructors

Constructor	Description
TaskMacroParameters()

Method Summary

Modifier and Type	Method	Description
String	getClassName()
String	getCompleteDate()
String	getCreateDate()
String	getReference()
String	getReporter()
String	getStatus()
TaskMacroParameters.IdDisplay	isIdDisplayed()
void	setClassName(String className)
void	setCompleteDate(String completeDate)
void	setCreateDate(String createDate)
void	setIdDisplayed(TaskMacroParameters.IdDisplay idDisplayed)
void	setReference(String reference)
void	setReporter(String reporter)
void	setStatus(String status)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TaskMacroParameters

public TaskMacroParameters()

Method Details

getReference

public String getReference()

Returns:

the id of the task.

setReference

public void setReference(String reference)

Parameters:

reference - the id of the task.

getReporter

public String getReporter()

Returns:

the creator of the task.

setReporter

public void setReporter(String reporter)

Parameters:

reporter - the creator of the task.

getCreateDate

public String getCreateDate()

Returns:

the creation date of the task.

setCreateDate

public void setCreateDate(String createDate)

Parameters:

createDate - the creation date of the task.

getStatus

public String getStatus()

Returns:

the status of the task.

setStatus

public void setStatus(String status)

Parameters:

status - the status of the task.

getCompleteDate

public String getCompleteDate()

Returns:

the date when the task has been completed.

setCompleteDate

public void setCompleteDate(String completeDate)

Parameters:

completeDate - the date when the task has been completed.

isIdDisplayed

public TaskMacroParameters.IdDisplay isIdDisplayed()

Returns:

whether the id and the link to the task page should be displayed.

Since:

3.8.0

setIdDisplayed

public void setIdDisplayed(TaskMacroParameters.IdDisplay idDisplayed)

Parameters:

idDisplayed - see isIdDisplayed().

Since:

3.8.0

getClassName

public String getClassName()

Returns:

the name of the class that should identify this macro.

Since:

3.8.0

setClassName

public void setClassName(String className)

Parameters:

className - see getClassName().

Since:

3.8.0