Class GetHelp

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.GetHelp

public class GetHelp
extends DAO

A Data Access Object to load Online Help and Help Desk entries.

Since:

1.0

Version:

11.0

Author:

Luke

Field Summary

Fields inherited from class org.deltava.dao.DAO

_queryMax, _queryStart, _queryTimeout, WGS84_SRID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Collection<Issue>	getActive()	Returns all active Help Desk Issues.
Collection<Issue>	getAll()	Returns all Help Desk Issues.
Collection<Integer>	getAssignees()	Returns all Help Desk Issue assignees.
Collection<Integer>	getAuthors()	Returns all Help Desk Issue authors.
Collection<Issue>	getByPilot(int authorID, int assigneeID, boolean showPublic, boolean activeOnly)	Returns all Help Desk Issues for a Pilot, or Public Issues.
Collection<Issue>	getFAQ()	Returns the Help Desk FAQ Issues.
IssueComment	getFile(int id, Instant createdOn)	Loads an attached File.
Issue	getIssue(int id)	Returns a particular Help Desk Issue.
List<Issue>	search(String searchStr, boolean includeComments)	Searches all Issues for a particular phrase.

Methods inherited from class org.deltava.dao.DAO

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

Methods inherited from class java.lang.Object

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

Constructor Details

GetHelp

public GetHelp(Connection c)

Initializes the Data Access Object.

Parameters:

c - the JDBC Connection to use

Method Details

getIssue

public Issue getIssue(int id)
               throws DAOException

Returns a particular Help Desk Issue. This loads the Issue Comments.

Parameters:

id - the database ID

Returns:

an Issue bean, or null if not found

Throws:

DAOException - if a JDBC error occurs

getAll

public Collection<Issue> getAll()
                         throws DAOException

Returns all Help Desk Issues.

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

getFile

public IssueComment getFile(int id,
 Instant createdOn)
                     throws DAOException

Loads an attached File.

Parameters:

id - the issue database ID

createdOn - the comment creation epoch timestamp

Returns:

the file data

Throws:

DAOException - if a JDBC error occurs

getAuthors

public Collection<Integer> getAuthors()
                               throws DAOException

Returns all Help Desk Issue authors.

Returns:

a Collection of Database IDs

Throws:

DAOException - if a JDBC error occurs

getAssignees

public Collection<Integer> getAssignees()
                                 throws DAOException

Returns all Help Desk Issue assignees.

Returns:

a Collection of Database IDs

Throws:

DAOException - if a JDBC error occurs

getByPilot

public Collection<Issue> getByPilot(int authorID,
 int assigneeID,
 boolean showPublic,
 boolean activeOnly)
                             throws DAOException

Returns all Help Desk Issues for a Pilot, or Public Issues.

Parameters:

authorID - the author's database ID

assigneeID - the assignee's database ID

showPublic - TRUE to show public issues, otherwise FALSE

activeOnly - TRUE to show active issues only, otherwise FALSE

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

getActive

public Collection<Issue> getActive()
                            throws DAOException

Returns all active Help Desk Issues.

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

getFAQ

public Collection<Issue> getFAQ()
                         throws DAOException

Returns the Help Desk FAQ Issues.

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

search

public List<Issue> search(String searchStr,
 boolean includeComments)
                   throws DAOException

Searches all Issues for a particular phrase.

Parameters:

searchStr - the search phrase

includeComments - TRUE if Issue Comments should be searched, otherwise FALSE

Returns:

a List of Issues

Throws:

DAOException - if a JDBC error occurs