Class AbstractAuditFormCommand

java.lang.Object

org.deltava.commands.AbstractCommand

org.deltava.commands.AbstractFormCommand

org.deltava.commands.AbstractAuditFormCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AccomplishmentCommand, AircraftCommand, AirlineCommand, AirlineInformationCommand, AirportCommand, CertificationCommand, ChannelCommand, CheckRideScriptCommand, EliteLevelCommand, EliteLifetimeLevelCommand, EquipmentCommand, ExamProfileCommand, IMAPMailboxCommand, IssueCommand, IssueCommand, LibraryEditCommand, LiveryCommand, MessageTemplateCommand, PartnerInfoCommand, QuestionProfileCommand, ResourceCommand, RideScriptCommand, TourCommand

public abstract class AbstractAuditFormCommand
extends AbstractFormCommand

A class to support form operations on auditable objects.

Since:

7.4

Version:

10.0

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from interface Command

Command.Scope

Modifier and Type	Interface	Description
static enum	Command.Scope	Scope helper enumeration.

Field Summary

Fields inherited from interface Command

ID, OPERATION, PAGE, REQUEST, SESSION

Modifier and Type	Field	Description
static final int	ID
static final int	OPERATION
static final Command.Scope	PAGE
static final Command.Scope	REQUEST
static final Command.Scope	SESSION

Constructor Summary

Constructors

Constructor	Description
AbstractAuditFormCommand()

Method Summary

Modifier and Type	Method	Description
protected static void	readAuditLog(CommandContext ctx, Auditable a)	Loads the audit log for an object.
protected static void	writeAuditLog(CommandContext ctx, AuditLog ae)	Writes an audit log entry for an object.

Methods inherited from class AbstractFormCommand

execEdit, execRead, execSave, execute

Modifier and Type	Method	Description
protected abstract void	execEdit(CommandContext ctx)	Method called when editing the form.
protected abstract void	execRead(CommandContext ctx)	Method called when reading the form.
protected abstract void	execSave(CommandContext ctx)	Method called when saving the form.
final void	execute(CommandContext ctx)	Executes the command, and based on the operation calls an implementation method for the particular operation.

Methods inherited from class AbstractCommand

forgottenException, getID, getName, getRoles, init, notFoundException, notFoundException, parseDateTime, parseDateTime, securityException, setRoles

Modifier and Type	Method	Description
protected static CommandException	forgottenException()	Helper method to generate a content blocked exception.
final String	getID()	Return the ID of the command.
final String	getName()	Return the name of the command.
final Collection<String>	getRoles()	Return the roles authorized to execute this command.
void	init(String id, String cmdName)	Initialize the Command.
protected static CommandException	notFoundException(String msg, int id)	Helper method to generate an "item not found" exception for a given database ID.
protected static CommandException	notFoundException(String msg, Object id)	Helper method to generate an "item not found" exception for a given ID.
protected static Instant	parseDateTime(CommandContext ctx, String paramHdr)	Parses one or two HTTP request parameters into a date/time value, using the user's format patterns or the default format patterns if the user is not authenticated.
protected static Instant	parseDateTime(CommandContext ctx, String paramHdr, String dfmt, String tfmt)	Parses one or two HTTP request parameters into a date/time value.
protected static CommandException	securityException(String msg)	Helper method to generate a security exception.
final void	setRoles(Collection<String> roles)	Updates the roles authorized to execute this command.

Methods inherited from class Object

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

Constructor Details

AbstractAuditFormCommand

public AbstractAuditFormCommand()

Method Details

readAuditLog

protected static void readAuditLog(CommandContext ctx,
 Auditable a)
                            throws DAOException

Loads the audit log for an object.

Parameters:

ctx - the CommandContext

a - the Auditable object

Throws:

DAOException - if a JDBC error occurs

writeAuditLog

protected static void writeAuditLog(CommandContext ctx,
 AuditLog ae)
                             throws DAOException

Writes an audit log entry for an object.

Parameters:

ctx - the CommandContext

ae - the AuditLog entry

Throws:

DAOException - if a JDBC error occurs