Package com.xwiki.task.model
Class Task
- java.lang.Object
-
- com.xwiki.task.model.Task
-
@Unstable public class Task extends Object
The model of a Task.- Since:
- 3.0
- Version:
- $Id$
-
-
Field Summary
Fields Modifier and Type Field Description static StringASSIGNEEThe name of the ASSIGNEE field.static StringCOMPLETE_DATEThe name of the COMPLETE_DATE field.static StringCREATE_DATEThe name of the CREATE_DATE field.static StringDUE_DATEThe name of the DUE_DATE field.static StringMACRO_NAMEThe name of the model.static StringNAMEThe name of the NAME field.static StringNUMBERThe name of the NUMBER field.static StringOWNERThe name of the OWNER field.static StringPROGRESSThe name of the PROGRESS field.static StringPROJECTThe name of the PROJECT field.static StringREFERENCEThe name of the ID field.static StringREPORTERThe name of the REPORTER field.static StringSEVERITYThe name of the SEVERITY field.static StringSTART_DATEThe name of the START_DATE field.static StringSTATUSThe name of the STATUS field.static StringSTATUS_DONEThe value of the STATUS field denoting that the task has been completed.static StringSTATUS_IN_PROGRESSThe value of the STATUS field denoting that the task is still in progress.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.xwiki.model.reference.DocumentReferencegetAssignee()DategetCompleteDate()DategetCreateDate()DategetDueDate()StringgetName()intgetNumber()org.xwiki.model.reference.DocumentReferencegetOwner()intgetProgress()StringgetProject()org.xwiki.model.reference.DocumentReferencegetReference()org.xwiki.model.reference.DocumentReferencegetReporter()StringgetSeverity()DategetStartDate()StringgetStatus()voidsetAssignee(org.xwiki.model.reference.DocumentReference assignee)voidsetCompleteDate(Date completeDate)voidsetCreateDate(Date createDate)voidsetDuedate(Date duedate)voidsetName(String name)voidsetNumber(int number)voidsetOwner(org.xwiki.model.reference.DocumentReference owner)voidsetProgress(int progress)voidsetProject(String project)voidsetReference(org.xwiki.model.reference.DocumentReference reference)voidsetReporter(org.xwiki.model.reference.DocumentReference reporter)voidsetSeverity(String severity)voidsetStartDate(Date startDate)voidsetStatus(String status)
-
-
-
Field Detail
-
MACRO_NAME
public static final String MACRO_NAME
The name of the model.- See Also:
- Constant Field Values
-
NAME
public static final String NAME
The name of the NAME field.- See Also:
- Constant Field Values
-
NUMBER
public static final String NUMBER
The name of the NUMBER field.- See Also:
- Constant Field Values
-
OWNER
public static final String OWNER
The name of the OWNER field.- See Also:
- Constant Field Values
-
REFERENCE
public static final String REFERENCE
The name of the ID field.- See Also:
- Constant Field Values
-
STATUS
public static final String STATUS
The name of the STATUS field.- See Also:
- Constant Field Values
-
STATUS_DONE
public static final String STATUS_DONE
The value of the STATUS field denoting that the task has been completed.- See Also:
- Constant Field Values
-
STATUS_IN_PROGRESS
public static final String STATUS_IN_PROGRESS
The value of the STATUS field denoting that the task is still in progress.- See Also:
- Constant Field Values
-
REPORTER
public static final String REPORTER
The name of the REPORTER field.- See Also:
- Constant Field Values
-
ASSIGNEE
public static final String ASSIGNEE
The name of the ASSIGNEE field.- See Also:
- Constant Field Values
-
CREATE_DATE
public static final String CREATE_DATE
The name of the CREATE_DATE field.- See Also:
- Constant Field Values
-
START_DATE
public static final String START_DATE
The name of the START_DATE field.- See Also:
- Constant Field Values
-
DUE_DATE
public static final String DUE_DATE
The name of the DUE_DATE field.- See Also:
- Constant Field Values
-
COMPLETE_DATE
public static final String COMPLETE_DATE
The name of the COMPLETE_DATE field.- See Also:
- Constant Field Values
-
PROGRESS
public static final String PROGRESS
The name of the PROGRESS field.- See Also:
- Constant Field Values
-
PROJECT
public static final String PROJECT
The name of the PROJECT field.- See Also:
- Constant Field Values
-
SEVERITY
public static final String SEVERITY
The name of the SEVERITY field.- See Also:
- Constant Field Values
-
-
Method Detail
-
getOwner
public org.xwiki.model.reference.DocumentReference getOwner()
- Returns:
- the reference of the document where this task resides.
-
setOwner
public void setOwner(org.xwiki.model.reference.DocumentReference owner)
- Parameters:
owner- the reference of the document that contains this task.
-
getReference
public org.xwiki.model.reference.DocumentReference getReference()
- Returns:
- a unique identifier for the task within the document.
-
setReference
public void setReference(org.xwiki.model.reference.DocumentReference reference)
- Parameters:
reference- the Id of the task. Grouping the tasks by the document reference, their Ids have to be unique.
-
getStatus
public String getStatus()
- Returns:
- whether the task has been completed or not.
-
setStatus
public void setStatus(String status)
- Parameters:
status- the current state of the task - true: the task is completed; false: the task is not done.
-
getReporter
public org.xwiki.model.reference.DocumentReference getReporter()
- Returns:
- the reference to the user that created this task.
-
setReporter
public void setReporter(org.xwiki.model.reference.DocumentReference reporter)
- Parameters:
reporter- the reference to the user that created this task.
-
getAssignee
public org.xwiki.model.reference.DocumentReference getAssignee()
- Returns:
- a list of references to the users that are assigned to this task.
-
setAssignee
public void setAssignee(org.xwiki.model.reference.DocumentReference assignee)
- Parameters:
assignee- a list of references to the users that are assigned to this task.
-
getCreateDate
public Date getCreateDate()
- Returns:
- the timestamp for the creation of the task.
-
setCreateDate
public void setCreateDate(Date createDate)
- Parameters:
createDate- the moment the task was created.
-
getStartDate
public Date getStartDate()
- Returns:
- the timestamp for the start of the task.
-
setStartDate
public void setStartDate(Date startDate)
- Parameters:
startDate- the moment the task was started.
-
getDueDate
public Date getDueDate()
- Returns:
- the deadline of the task.
-
setDuedate
public void setDuedate(Date duedate)
- Parameters:
duedate- the deadline of the task.
-
getCompleteDate
public Date getCompleteDate()
- Returns:
- the date when the task was marked as completed.
-
setCompleteDate
public void setCompleteDate(Date completeDate)
- Parameters:
completeDate- the date when the task was completed.
-
getName
public String getName()
- Returns:
- the name/title given to this task.
-
setName
public void setName(String name)
- Parameters:
name- the name/title given to this task.
-
getNumber
public int getNumber()
- Returns:
- the unique number identifying this Task on the current wiki.
-
setNumber
public void setNumber(int number)
- Parameters:
number- the number that uniquely identifies the task.
-
getProgress
public int getProgress()
- Returns:
- the progress that was made to a specific task. Value from 0 to 100.
-
setProgress
public void setProgress(int progress)
- Parameters:
progress- seegetProgress().
-
getSeverity
public String getSeverity()
- Returns:
- the severity of the task.
-
setSeverity
public void setSeverity(String severity)
- Parameters:
severity- the severity of the task (Low,Medium,High).
-
getProject
public String getProject()
- Returns:
- the project the task is a part of.
-
setProject
public void setProject(String project)
- Parameters:
project- the project the task is a part of.
-
-