com.whitestein.lsps.human.entity

Class Todo

java.lang.Object

com.whitestein.lsps.common.AbstractEntity

com.whitestein.lsps.human.entity.Todo

All Implemented Interfaces:

EntityWithId<Long>

@Entity
public class Todo
extends com.whitestein.lsps.common.AbstractEntity

Persistent domain object representing a todo.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT_PERSONAL_TODOS_WITH_NULL_PRIORITY Query name.
static String	COUNT_PERSONAL_TODOS_WITH_PRIORITY Query name.
static String	FIND_BY_TASK Query name.
static String	FIND_OPEN_ALLOCATED_TODO_IDS Query name.
static String	FIND_PERSONAL_TODOS_WITH_NULL_PRIORITY Query name.
static String	FIND_PERSONAL_TODOS_WITH_PRIORITY Query name.
static String	GET_STATUS_COUNTS Query name.

Fields inherited from class com.whitestein.lsps.common.AbstractEntity

SEQUENCE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Todo() Default constructor.
	Todo(Long modelInstanceId, Long elementId, Long taskId, String title, String type, Date issuedDate, String taskNamespace, String taskName, byte[] content, Date escalationDate, String implementationType) Creates new instance of Todo.

Method Summary

Modifier and Type	Method and Description
void	accomplish(Date submittedDate) Sets status to TodoStatus.ACCOMPLISHED.
void	addPerformer(TodoPerformer performer) Adds a todo performer.
void	addPerformers(Collection<TodoPerformer> performers) Adds a collection of todo performers.
void	addRejection(TodoRejection rejection) Adds a rejection.
String	getAllocatedTo() Returns the id of the user for which todo is allocated.
TodoAuthorization	getAuthorization(Person person) Returns the reason why the person can see the to-do in his to-do list.
byte[]	getContent() Returns the todo content.
int	getCurrentDelegationLevel() Gets current delegation level of the todo.
String	getDelegatedBy() Returns the person who delegated the todo (the current delegation) or null if the todo is not delegated.
Long	getElementId() Returns the element id.
Date	getEscalationDate() Returns the escalation date.
String	getImplementationType() Returns implementation type.
String	getInterruptionReason() Returns reason for which the todo was interrupted.
Date	getIssuedDate() Returns the date when the todo was issued.
Long	getModelInstanceId() Returns the model instance id.
String	getNotes() Returns notes attached to the todo.
Collection<TodoPerformer>	getPerformers() Returns a collection of performers for this todo.
Integer	getPriority() Returns priority of todo in personal todo list.
Collection<String>	getRejectingPersons() Returns a collection of rejecting persons.
TodoRejection	getRejectionBy(Person person) Returns a todo rejection for the specified person.
Collection<TodoRejection>	getRejections() Returns a collection of rejections.
TodoStatus	getStatus() Returns status of the todo.
Date	getSubmittedDate() Returns the date when the todo was submitted.
Long	getTaskId() Returns the task id.
String	getTaskName() Returns the name of the task which generated the todo.
String	getTaskNamespace() Returns the name of the namespace of the context for the task which generated the todo.
String	getTitle() Returns title for todo.
String	getType() Returns type of the todo.
boolean	hasInitialPerformer(Person person) Checks if given person is one of the todo's performers.
void	interrupt(Date submittedDate, String interruptionReason) Sets status to TodoStatus.INTERRUPTED.
boolean	isAlive() Returns true if the todo is alive (its status equals to TodoStatus.ALIVE), otherwise returns false.
boolean	isAllocated() Returns true if the todo is allocated.
boolean	isAllocatedTo(Person person) Returns true if this todo is assigned to given person.
boolean	isDelegated() Returns true if the todo is delegated.
boolean	isDelegatedTo(Person person) Checks if the todo is delegated to person.
boolean	isOrphaned() Return true if the todo is orphaned.
boolean	isPersonPermitted(Person person) Returns true if the given person is permitted to see this todo.
boolean	isPersonPermitted(Person person, boolean checkSubstitution, boolean checkAllocation) Returns true if the given person is permitted to see this todo.
boolean	isRejectedBy(Person person) Checks if the todo is rejected by person
boolean	isVisibleTo(Person person) Returns true if isPersonPermitted(person) is true and the person has not rejected the todo.
void	removePerformer(TodoPerformer performer) Removes a performer.
void	removeRejection(TodoRejection rejection) Removes a rejection.
void	resume() Sets status to TodoStatus.SUSPENDED.
void	setContent(byte[] content) Sets the todo content..
void	setNotes(String notes) Sets notes attached to the todo.
void	setOrphaned(boolean orphaned) Sets todo orphaned property.
void	setPriority(Integer priority) Sets priority of the todo in personal todo list.
void	suspend() Sets status to TodoStatus.SUSPENDED.

Methods inherited from class com.whitestein.lsps.common.AbstractEntity

getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

FIND_OPEN_ALLOCATED_TODO_IDS

public static final String FIND_OPEN_ALLOCATED_TODO_IDS

Query name.

See Also:

Constant Field Values

FIND_PERSONAL_TODOS_WITH_PRIORITY

public static final String FIND_PERSONAL_TODOS_WITH_PRIORITY

Query name.

See Also:

Constant Field Values

FIND_PERSONAL_TODOS_WITH_NULL_PRIORITY

public static final String FIND_PERSONAL_TODOS_WITH_NULL_PRIORITY

Query name.

See Also:

Constant Field Values

COUNT_PERSONAL_TODOS_WITH_PRIORITY

public static final String COUNT_PERSONAL_TODOS_WITH_PRIORITY

Query name.

See Also:

Constant Field Values

COUNT_PERSONAL_TODOS_WITH_NULL_PRIORITY

public static final String COUNT_PERSONAL_TODOS_WITH_NULL_PRIORITY

Query name.

See Also:

Constant Field Values

GET_STATUS_COUNTS

public static final String GET_STATUS_COUNTS

Query name.

See Also:

Constant Field Values

FIND_BY_TASK

public static final String FIND_BY_TASK

Query name.

See Also:

Constant Field Values

Constructor Detail

Todo

protected Todo()

Default constructor.

Todo

public Todo(Long modelInstanceId,
            Long elementId,
            Long taskId,
            String title,
            String type,
            Date issuedDate,
            String taskNamespace,
            String taskName,
            byte[] content,
            Date escalationDate,
            String implementationType)

Creates new instance of Todo.

Parameters:

modelInstanceId -

elementId -

taskId -

title -

type -

issuedDate -

taskNamespace -

taskName -

content -

escalationDate -

implementationType -

Throws:

NullPointerException - if one of title, type, issuedDate, taskNamespace, taskName is null

Method Detail

getModelInstanceId

public Long getModelInstanceId()

Returns the model instance id.

Returns:

id

getElementId

public Long getElementId()

Returns the element id.

Returns:

the element id

getTitle

public String getTitle()

Returns title for todo.

Returns:

title

getType

public String getType()

Returns type of the todo.

Returns:

type

getStatus

public TodoStatus getStatus()

Returns status of the todo.

Returns:

status

suspend

public void suspend()

Sets status to TodoStatus.SUSPENDED.

resume

public void resume()

Sets status to TodoStatus.SUSPENDED.

accomplish

public void accomplish(Date submittedDate)

Sets status to TodoStatus.ACCOMPLISHED.

Parameters:

submittedDate -

Throws:

NullPointerException - if submittedDate is null

interrupt

public void interrupt(Date submittedDate,
                      String interruptionReason)

Sets status to TodoStatus.INTERRUPTED.

Parameters:

submittedDate -

interruptionReason -

Throws:

NullPointerException - if submittedDate is null

isAlive

public boolean isAlive()

Returns true if the todo is alive (its status equals to TodoStatus.ALIVE), otherwise returns false.

Returns:

true if the todo is alive, otherwise returns false

getIssuedDate

public Date getIssuedDate()

Returns the date when the todo was issued.

Returns:

date

getSubmittedDate

public Date getSubmittedDate()

Returns the date when the todo was submitted.

Returns:

date

getAllocatedTo

public String getAllocatedTo()

Returns the id of the user for which todo is allocated. If null, the todo should be visible to all its performers, else

Returns:

user id

getPerformers

public Collection<TodoPerformer> getPerformers()

Returns a collection of performers for this todo.

Returns:

performers

addPerformer

public void addPerformer(TodoPerformer performer)

Adds a todo performer.

Parameters:

performer -

Throws:

NullPointerException - if performer is null

addPerformers

public void addPerformers(Collection<TodoPerformer> performers)

Adds a collection of todo performers.

Parameters:

performers -

Throws:

NullPointerException - if performers is null or any element of performers is null

removePerformer

public void removePerformer(TodoPerformer performer)

Removes a performer.

Parameters:

performer -

getTaskNamespace

public String getTaskNamespace()

Returns the name of the namespace of the context for the task which generated the todo.

Returns:

namespace

getTaskName

public String getTaskName()

Returns the name of the task which generated the todo.

Returns:

task name

getTaskId

public Long getTaskId()

Returns the task id.

Returns:

the task id

getContent

public byte[] getContent()

Returns the todo content. This is where the task stores (optional) informations for the clients to render the todo.

Returns:

content

setContent

public void setContent(byte[] content)

Sets the todo content..

Parameters:

content -

getInterruptionReason

public String getInterruptionReason()

Returns reason for which the todo was interrupted.

Returns:

reason for which the todo was interrupted

isPersonPermitted

public boolean isPersonPermitted(Person person)

Returns true if the given person is permitted to see this todo. This is based on this todo allocator, status, delegation, substitution and initial performers.

Parameters:

person -

Returns:

true if the given person is permitted to see this todo

Throws:

NullPointerException - if person is null

isVisibleTo

public boolean isVisibleTo(Person person)

Returns true if isPersonPermitted(person) is true and the person has not rejected the todo.

Parameters:

person -

Returns:

the visibility

Throws:

NullPointerException - if person is null

isPersonPermitted

public boolean isPersonPermitted(Person person,
                                 boolean checkSubstitution,
                                 boolean checkAllocation)

Returns true if the given person is permitted to see this todo. This is based on this todo allocator, status, delegation, substitution (optional) and initial parameters.

Parameters:

person -

checkSubstitution -

checkAllocation -

Returns:

true if the given person is permitted to see this todo

Throws:

NullPointerException - if person is null

hasInitialPerformer

public boolean hasInitialPerformer(Person person)

Checks if given person is one of the todo's performers. That may happen if the person is directly assigned in todo, or if the person is in role assigned in todo.

Parameters:

person -

Returns:

true, only if person is one of todo's initial performers.

isAllocatedTo

public boolean isAllocatedTo(Person person)

Returns true if this todo is assigned to given person.

Parameters:

person -

Returns:

true if this todo is assigned to given person

Throws:

NullPointerException - if person is null

getCurrentDelegationLevel

public int getCurrentDelegationLevel()

Gets current delegation level of the todo.

Returns:

delegation level of the todo. Returns 0 if the todo not delegated

isAllocated

public boolean isAllocated()

Returns true if the todo is allocated.

Returns:

true if the todo is allocated

isDelegated

public boolean isDelegated()

Returns true if the todo is delegated.

Returns:

true if the todo is delegated

isDelegatedTo

public boolean isDelegatedTo(Person person)

Checks if the todo is delegated to person.

Parameters:

person - person being checked

Returns:

true if person is one of delegates

getDelegatedBy

public String getDelegatedBy()

Returns the person who delegated the todo (the current delegation) or null if the todo is not delegated.

Returns:

the person who delegated the todo

getRejections

public Collection<TodoRejection> getRejections()

Returns a collection of rejections.

Returns:

a collection of rejections

getRejectingPersons

public Collection<String> getRejectingPersons()

Returns a collection of rejecting persons.

Returns:

a collection of rejecting persons

addRejection

public void addRejection(TodoRejection rejection)

Adds a rejection.

Parameters:

rejection -

Throws:

NullPointerException - if rejection is null

removeRejection

public void removeRejection(TodoRejection rejection)

Removes a rejection.

Parameters:

rejection -

Throws:

NullPointerException - if rejection is null

isRejectedBy

public boolean isRejectedBy(Person person)

Checks if the todo is rejected by person

Parameters:

person - person being checked

Returns:

true if person rejects the todo.

getRejectionBy

public TodoRejection getRejectionBy(Person person)

Returns a todo rejection for the specified person.

Parameters:

person -

Returns:

a todo rejection for the specified person

getPriority

public Integer getPriority()

Returns priority of todo in personal todo list.

Returns:

todo priority

setPriority

public void setPriority(Integer priority)

Sets priority of the todo in personal todo list.

Parameters:

priority - todo priority

getNotes

public String getNotes()

Returns notes attached to the todo.

Returns:

notes for the todo

setNotes

public void setNotes(String notes)

Sets notes attached to the todo.

Parameters:

notes - notes for the todo

getEscalationDate

public Date getEscalationDate()

Returns the escalation date.

Returns:

the escalation date

getAuthorization

public TodoAuthorization getAuthorization(Person person)

Returns the reason why the person can see the to-do in his to-do list.

Parameters:

person -

Returns:

the reason

isOrphaned

public boolean isOrphaned()

Return true if the todo is orphaned.

Returns:

true if the todo is orphaned

setOrphaned

public void setOrphaned(boolean orphaned)

Sets todo orphaned property.

Parameters:

orphaned -

getImplementationType

public String getImplementationType()

Returns implementation type.

Returns:

implementation type