Task (docdoku-api-java 2.5-SNAPSHOT API)

java.lang.Object
- com.docdoku.core.workflow.Task

All Implemented Interfaces:

Serializable, Cloneable
```
@Entity
public class Task
extends Object
implements Serializable, Cloneable
```
Task is the smallest unit of work in a workflow.

Since:

V1.0

Version:

2.5, 27/06/16

Author:

Florent Garin

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Task.Status
Enumeration for the possible status of a task.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Task.Status` Enumeration for the possible status of a task.

Constructor Summary

Constructors
Constructor and Description

Task()

Task(int pNum, String pTitle, String pInstructions, Collection<User> assignedU, Collection<UserGroup> assignedG)

Constructors
Constructor and Description
`Task()`
`Task(int pNum, String pTitle, String pInstructions, Collection<User> assignedU, Collection<UserGroup> assignedG)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`approve(User pWorker, String pComment, int pTargetIteration)`
`void`	`approve(User pWorker, String pComment, int pTargetIteration, String pSignature)`
`Task`	`clone()` perform a deep clone operation
`boolean`	`equals(Object o)`
`Activity`	`getActivity()`
`int`	`getActivityStep()`
`Set<UserGroup>`	`getAssignedGroups()`
`Set<User>`	`getAssignedUsers()`
`String`	`getClosureComment()`
`Date`	`getClosureDate()`
`int`	`getDuration()`
`String`	`getInstructions()`
`TaskKey`	`getKey()`
`int`	`getNum()`
`String`	`getSignature()`
`Date`	`getStartDate()`
`Task.Status`	`getStatus()`
`int`	`getTargetIteration()`
`String`	`getTitle()`
`User`	`getWorker()`
`int`	`getWorkflowId()`
`int`	`hashCode()`
`boolean`	`hasPotentialWorker()`
`boolean`	`isApproved()`
`boolean`	`isInProgress()`
`boolean`	`isNotStarted()`
`boolean`	`isNotToBeDone()`
`boolean`	`isPotentialWorker(User user)`
`boolean`	`isRejected()`
`void`	`reject(User pWorker, String pComment, int pTargetIteration)`
`void`	`reject(User pWorker, String pComment, int pTargetIteration, String pSignature)`
`void`	`reset(Task.Status status)`
`void`	`setActivity(Activity activity)`
`void`	`setAssignedGroups(Set<UserGroup> assignedGroups)`
`void`	`setAssignedUsers(Set<User> assignedUsers)`
`void`	`setClosureComment(String closureComment)`
`void`	`setClosureDate(Date closureDate)`
`void`	`setDuration(int duration)`
`void`	`setInstructions(String instructions)`
`void`	`setNum(int num)`
`void`	`setSignature(String signature)`
`void`	`setStartDate(Date startDate)`
`void`	`setStatus(Task.Status status)`
`void`	`setTargetIteration(int targetIteration)`
`void`	`setTitle(String title)`
`void`	`setWorker(User worker)`
`void`	`start()`
`void`	`stop()`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Task
```
public Task()
```

Task

public Task(int pNum,
            String pTitle,
            String pInstructions,
            Collection<User> assignedU,
            Collection<UserGroup> assignedG)

Method Detail

getKey
```
public TaskKey getKey()
```

getNum
```
public int getNum()
```

setNum
```
public void setNum(int num)
```

getWorkflowId
```
public int getWorkflowId()
```

getActivity
```
public Activity getActivity()
```

setActivity

public void setActivity(Activity activity)

getActivityStep
```
public int getActivityStep()
```

getStatus
```
public Task.Status getStatus()
```

setStatus

public void setStatus(Task.Status status)

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getInstructions
```
public String getInstructions()
```

setInstructions

public void setInstructions(String instructions)

getWorker
```
public User getWorker()
```

setWorker
```
public void setWorker(User worker)
```

getStartDate
```
public Date getStartDate()
```

setStartDate

public void setStartDate(Date startDate)

getDuration
```
public int getDuration()
```

setDuration

public void setDuration(int duration)

getClosureDate
```
public Date getClosureDate()
```

setClosureDate

public void setClosureDate(Date closureDate)

getClosureComment
```
public String getClosureComment()
```

setClosureComment

public void setClosureComment(String closureComment)

getTargetIteration
```
public int getTargetIteration()
```

setTargetIteration

public void setTargetIteration(int targetIteration)

getSignature
```
public String getSignature()
```

setSignature

public void setSignature(String signature)

reject

public void reject(User pWorker,
                   String pComment,
                   int pTargetIteration)

reject

public void reject(User pWorker,
                   String pComment,
                   int pTargetIteration,
                   String pSignature)

approve

public void approve(User pWorker,
                    String pComment,
                    int pTargetIteration)

approve

public void approve(User pWorker,
                    String pComment,
                    int pTargetIteration,
                    String pSignature)

start
```
public void start()
```

stop
```
public void stop()
```

reset

public void reset(Task.Status status)

hasPotentialWorker
```
public boolean hasPotentialWorker()
```

isPotentialWorker

public boolean isPotentialWorker(User user)

getAssignedUsers
```
public Set<User> getAssignedUsers()
```

setAssignedUsers

public void setAssignedUsers(Set<User> assignedUsers)

getAssignedGroups

public Set<UserGroup> getAssignedGroups()

setAssignedGroups

public void setAssignedGroups(Set<UserGroup> assignedGroups)

isNotStarted
```
public boolean isNotStarted()
```

isRejected
```
public boolean isRejected()
```

isApproved
```
public boolean isApproved()
```

isInProgress
```
public boolean isInProgress()
```

isNotToBeDone
```
public boolean isNotToBeDone()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

clone
```
public Task clone()
```
perform a deep clone operation

Overrides:

clone in class Object

Class Task

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Task

Task

Method Detail

getKey

getNum

setNum

getWorkflowId

getActivity

setActivity

getActivityStep

getStatus

setStatus

getTitle

setTitle

getInstructions

setInstructions

getWorker

setWorker

getStartDate

setStartDate

getDuration

setDuration

getClosureDate

setClosureDate

getClosureComment

setClosureComment

getTargetIteration

setTargetIteration

getSignature

setSignature

reject

reject

approve

approve

start

stop

reset

hasPotentialWorker

isPotentialWorker

getAssignedUsers

setAssignedUsers

getAssignedGroups

setAssignedGroups

isNotStarted

isRejected

isApproved

isInProgress

isNotToBeDone

hashCode

equals

toString

clone