Package org.deltava.beans.help

Class Issue

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.help.Issue

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Object>, Auditable, AuthoredBean, IDBean, ViewEntry, Cacheable

public class Issue
extends DatabaseBean
implements Auditable, AuthoredBean, ViewEntry

A bean to store Help Desk Issues.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Issue(String subj)	Creates a new Issue bean.

Method Summary

Modifier and Type	Method	Description
void	addComment(IssueComment ic)	Adds a Comment to this Issue.
int	getAssignedTo()	Returns the database ID of the Person this Issue is assigned to.
String	getAuditID()	Returns the object ID for this auditable object.
int	getAuthorID()	Returns the Author of this bean.
String	getBody()	Returns the Issue body text.
int	getCommentCount()	Returns the number of Comments for this Issue.
Collection<IssueComment>	getComments()	Returns all comments for this Issue.
Instant	getCreatedOn()	Returns the date/time the Issue was created on.
boolean	getFAQ()	Returns whether the Issue is in the FAQ.
Instant	getLastComment()	Returns the date of the last comment.
int	getLastCommentAuthorID()	Returns the database ID of the author of the last comment on this Issue.
int	getLinkedIssueID()	Returns the database ID of a linked Development Issue.
boolean	getPublic()	Returns whether the Issue is Public.
Instant	getResolvedOn()	Returns the date/time the Issue was resolved on.
String	getRowClassName()	Returns the CSS class for this object if rendered in a view table.
IssueStatus	getStatus()	Returns the Issue status.
String	getSubject()	Returns the Issue subject.
boolean	isCrossApp()	Returns whether this object is within multiple web applications.
void	setAssignedTo(int id)	Updates the database ID of the Issue assignee.
void	setAuthorID(int id)	Updates the author of this bean.
void	setBody(String body)	Updates the Issue body text.
void	setCommentCount(int comments)	Updates the number of Comments for this Issue.
void	setCreatedOn(Instant dt)	Updates the creation date of this Issue.
void	setFAQ(boolean isFAQ)	Marks the Issue as part of the FAQ.
void	setLastComment(Instant dt)	Updates the date of the last comment on this Issue.
void	setLastCommentAuthorID(int id)	Updates the database ID of the author of the last Comment on this Issue.
void	setLinkedIssueID(int id)	Updates the database ID of a linked Development issue.
void	setPublic(boolean isPublic)	Marks the Issue as Public.
void	setResolvedOn(Instant dt)	Updates the resolution date of this Issue.
void	setStatus(IssueStatus status)	Updates this Issue's status.
void	setSubject(String sbj)	Updates the Issue subject.

Methods inherited from class org.deltava.beans.DatabaseBean

cacheKey, compareTo, equals, getHexID, getID, hashCode, setID, validateID, validateID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deltava.beans.Auditable

getAuditType

Constructor Details

Issue

public Issue(String subj)

Creates a new Issue bean.

Parameters:

subj - the Issue subject

Throws:

NullPointerException - if subj is null

Method Details

getAuthorID

public int getAuthorID()

Description copied from interface: AuthoredBean

Returns the Author of this bean.

Specified by:

getAuthorID in interface AuthoredBean

Returns:

the author's database ID

See Also:

• AuthoredBean.setAuthorID(int)

getAssignedTo

public int getAssignedTo()

Returns the database ID of the Person this Issue is assigned to.

Returns:

the Assignee's database ID

See Also:

• setAssignedTo(int)
• getAuthorID()

getLastCommentAuthorID

public int getLastCommentAuthorID()

Returns the database ID of the author of the last comment on this Issue.

Returns:

the last comment author's datbase ID

See Also:

• setLastCommentAuthorID(int)
• getAuthorID()

getLinkedIssueID

public int getLinkedIssueID()

Returns the database ID of a linked Development Issue.

Returns:

the database ID

See Also:

• setLinkedIssueID(int)

getStatus

public IssueStatus getStatus()

Returns the Issue status.

Returns:

the IssueStatus

See Also:

• setStatus(IssueStatus)

getPublic

public boolean getPublic()

Returns whether the Issue is Public.

Returns:

TRUE if the Issue is Public, otherwise FALSE

See Also:

• setPublic(boolean)

getFAQ

public boolean getFAQ()

Returns whether the Issue is in the FAQ.

Returns:

TRUE if the Issue is in the FAQ, otherwise FALSE

See Also:

• setFAQ(boolean)

getSubject

public String getSubject()

Returns the Issue subject.

Returns:

the subject

See Also:

• setSubject(String)

getBody

public String getBody()

Returns the Issue body text.

Returns:

the body text

See Also:

• setBody(String)

getCreatedOn

public Instant getCreatedOn()

Returns the date/time the Issue was created on.

Returns:

the Issue creation date/time

See Also:

• setCreatedOn(Instant)

getResolvedOn

public Instant getResolvedOn()

Returns the date/time the Issue was resolved on.

Returns:

the Issue resolution date/time

See Also:

• setResolvedOn(Instant)

getLastComment

public Instant getLastComment()

Returns the date of the last comment. This may be null if no comments have been entered.

Returns:

the date/time of the last comment

See Also:

• setLastComment(Instant)

getCommentCount

public int getCommentCount()

Returns the number of Comments for this Issue.

Returns:

the number of Comments

See Also:

• setCommentCount(int)
• addComment(IssueComment)

getComments

public Collection<IssueComment> getComments()

Returns all comments for this Issue.

Returns:

a Collection of IssueComment beans

See Also:

• addComment(IssueComment)
• IssueComment

addComment

public void addComment(IssueComment ic)

Adds a Comment to this Issue.

Parameters:

ic - the IssueComment bean to add

See Also:

• getComments()

setSubject

public void setSubject(String sbj)

Updates the Issue subject.

Parameters:

sbj - the subject

Throws:

NullPointerException - if sbj is null

See Also:

• getSubject()

setBody

public void setBody(String body)

Updates the Issue body text.

Parameters:

body - the body text

See Also:

• getBody()

setAuthorID

public void setAuthorID(int id)

Description copied from interface: AuthoredBean

Updates the author of this bean.

Specified by:

setAuthorID in interface AuthoredBean

Parameters:

id - the author's database ID.

See Also:

• AuthoredBean.getAuthorID()

setAssignedTo

public void setAssignedTo(int id)

Updates the database ID of the Issue assignee.

Parameters:

id - the assignee's database ID

Throws:

IllegalArgumentException - if id is negative

See Also:

• getAssignedTo()
• setAuthorID(int)

setLastCommentAuthorID

public void setLastCommentAuthorID(int id)

Updates the database ID of the author of the last Comment on this Issue.

Parameters:

id - the author's database ID

Throws:

IllegalArgumentException - if id is negative

See Also:

• getLastCommentAuthorID()
• setAuthorID(int)

setLinkedIssueID

public void setLinkedIssueID(int id)

Updates the database ID of a linked Development issue.

Parameters:

id - the Development Issue database ID

Throws:

IllegalArgumentException - if id is negative

See Also:

• getLinkedIssueID()

setCreatedOn

public void setCreatedOn(Instant dt)

Updates the creation date of this Issue.

Parameters:

dt - the date/time the Issue was created

See Also:

• getCreatedOn()

setLastComment

public void setLastComment(Instant dt)

Updates the date of the last comment on this Issue.

Parameters:

dt - the date/time of the last comment

See Also:

• getLastComment()

setResolvedOn

public void setResolvedOn(Instant dt)

Updates the resolution date of this Issue.

Parameters:

dt - the date/time the Issue was resolved

See Also:

• getResolvedOn()

setStatus

public void setStatus(IssueStatus status)

Updates this Issue's status.

Parameters:

status - the IssueStatus

See Also:

• getStatus()

setPublic

public void setPublic(boolean isPublic)

Marks the Issue as Public.

Parameters:

isPublic - TRUE if the Issue is public, otherwise FALSE

See Also:

• getPublic()

setFAQ

public void setFAQ(boolean isFAQ)

Marks the Issue as part of the FAQ.

Parameters:

isFAQ - TRUE if the Issue is part of the FAQ, otherwise FALSE

See Also:

• getFAQ()

setCommentCount

public void setCommentCount(int comments)

Updates the number of Comments for this Issue.

Parameters:

comments - the number of Comments

Throws:

IllegalArgumentException - if comments are already populated or negative

See Also:

• getCommentCount()

getAuditID

public String getAuditID()

Description copied from interface: Auditable

Returns the object ID for this auditable object.

Specified by:

getAuditID in interface Auditable

Returns:

the ID

isCrossApp

public boolean isCrossApp()

Description copied from interface: Auditable

Returns whether this object is within multiple web applications. Objects where this is false will need additional data appended to the audit ID to prevent information leakage across applications where the audit IDs are identical between apps.

Specified by:

isCrossApp in interface Auditable

Returns:

TRUE if cross-application, otherwise FALSE

getRowClassName

public String getRowClassName()

Description copied from interface: ViewEntry

Returns the CSS class for this object if rendered in a view table.

Specified by:

getRowClassName in interface ViewEntry

Returns:

the CSS class name, or NULL if none