Class SetHelp

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.SetHelp

public class SetHelp
extends DAO

A Data Access Object to update Online Help entries and Help Desk Issues.

Since:

1.0

Version:

11.0

Author:

Luke

Field Summary

Fields inherited from class DAO

_queryMax, _queryStart, _queryTimeout, WGS84_SRID

Modifier and Type	Field	Description
protected int	_queryMax	The maximum number of rows to return.
protected int	_queryStart	The row number at which to start returning results.
protected int	_queryTimeout	The query timeout, in seconds.
protected static final int	WGS84_SRID	The SRID used for geolocation queries.

Constructor Summary

Constructors

Constructor	Description
SetHelp(Connection c)	Initializes the Data Access Object.

Method Summary

Modifier and Type	Method	Description
void	delete(int id)	Deletes a Help Desk Issue from the database.
void	deleteComment(int issueID, Instant createdOn)	Deletes a Help Desk Issue comment.
void	deleteTemplate(String title)	Deletes a Help Desk response template from the database.
void	link(Issue i, int devIssueID)	Links a Help Desk Issue to a Development Issue.
void	markFAQ(int id, Instant createdOn)	Marks a Help Desk Issue as part of the FAQ.
void	write(Issue i)	Updates a Help Desk Issue in the database.
void	write(IssueComment ic)	Adds an Issue Comment to the database.
void	write(ResponseTemplate rsp)	Writes a Help Desk response template to the database.

Methods inherited from class DAO

commitTransaction, createTimestamp, executeIDs, executeUpdate, executeUpdate, expandDate, formatDBName, formatLocation, getNewID, getQueryCount, prepare, prepareWithoutLimits, rollbackTransaction, setQueryMax, setQueryStart, setQueryTimeout, startTransaction, toID, toID, toInstant

Modifier and Type	Method	Description
protected void	commitTransaction()	Commits a multi-step transaction to the database.
protected static Timestamp	createTimestamp(Instant i)	Null-safe conversion of an Instant to a Timestamp.
protected static List<Integer>	executeIDs(PreparedStatement ps)	Helper method to extract database ID data from the result set.
protected static int	executeUpdate(PreparedStatement ps, int minUpdateCount)	Executes an UPDATE transaction on a prepared statement, and throws a SQLExceptionif less than the expected number of rows were updated.
protected static int	executeUpdate(PreparedStatement ps, int minPerUpdate, int minTotal)	Executes an batched UPDATE transaction on a prepared statement, and throws a SQLExceptionif less than the expected number of rows were updated per batch entry.
protected static Instant	expandDate(Date dt)	Converts a date-only JDBC value into a full timestamp.
protected static String	formatDBName(String db)	Formats a database name by converting to lowercase.
protected static String	formatLocation(GeoLocation loc)	Converts a geographic location into a MySQL WKT formatted point.
protected int	getNewID()	Returns the AUTO_INC column value generated by the previous JDBC transaction.
static final long	getQueryCount()	Returns the total number of queries executed since the JVM was started.
protected PreparedStatement	prepare(String sql)	Initialize the prepared statement with an arbitrary SQL statement.
protected PreparedStatement	prepareWithoutLimits(String sql)	Initialize the prepared statement with an abitrary SQL statement, without applying the DAO's query result limitations.
protected void	rollbackTransaction()	Rolls back a multi-step transaction before it is completed.
final void	setQueryMax(int maxRows)	Sets the maximum number of rows in the returned result set.
final void	setQueryStart(int rowStart)	Sets the first row of the results to return.
void	setQueryTimeout(int timeout)	Sets the timeout for any SQL operations.
protected void	startTransaction()	Marks the start of a multi-step database transaction.
protected static Integer	toID(Object o)	Converts a Database bean or an Integer into an Integer.
protected static Collection<Integer>	toID(Collection<?> ids)	Converts a collection of Objects into Integer IDs.
protected static Instant	toInstant(Timestamp dt)	Null-safe conversion of a Timestamp to an Instant.

Methods inherited from class Object

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

Constructor Details

SetHelp

public SetHelp(Connection c)

Initializes the Data Access Object.

Parameters:

c - the JDBC connection to use

Method Details

write

public void write(ResponseTemplate rsp)
           throws DAOException

Writes a Help Desk response template to the database.

Parameters:

rsp - the ResponseTemplate bean

Throws:

DAOException - if a JDBC error occurs

write

public void write(Issue i)
           throws DAOException

Updates a Help Desk Issue in the database.

Parameters:

i - the Issue bean

Throws:

DAOException - if a JDBC error occurss

write

public void write(IssueComment ic)
           throws DAOException

Adds an Issue Comment to the database.

Parameters:

ic - the IssueComment bean

Throws:

DAOException - if a JDBC error occurss

markFAQ

public void markFAQ(int id,
 Instant createdOn)
             throws DAOException

Marks a Help Desk Issue as part of the FAQ.

Parameters:

id - the Issue database ID

createdOn - the creation date of the Comment to mark as the answer, or null to remove from the FAQ

Throws:

DAOException - if a JDBC error occurs

delete

public void delete(int id)
            throws DAOException

Deletes a Help Desk Issue from the database.

Parameters:

id - the Issue database ID

Throws:

DAOException - if a JDBC error occurss

deleteTemplate

public void deleteTemplate(String title)
                    throws DAOException

Deletes a Help Desk response template from the database.

Parameters:

title - the template title

Throws:

DAOException - if a JDBC error occurss

link

public void link(Issue i,
 int devIssueID)
          throws DAOException

Links a Help Desk Issue to a Development Issue.

Parameters:

i - the Issue

devIssueID - the Development Issue ID

Throws:

DAOException - if a JDBC error occurs

deleteComment

public void deleteComment(int issueID,
 Instant createdOn)
                   throws DAOException

Deletes a Help Desk Issue comment.

Parameters:

issueID - the Issue's database ID

createdOn - the Comment's creation date/time

Throws:

DAOException - if a JDBC error occurs