Class AbstractLibraryCommand

java.lang.Object

org.deltava.commands.AbstractCommand

org.deltava.commands.fleet.AbstractLibraryCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

DocumentLibraryCommand, FleetLibraryCommand

public abstract class AbstractLibraryCommand
extends AbstractCommand

An abstract class to support Library-related Web Site Commands.

Since:

1.0

Version:

11.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
AbstractLibraryCommand()

Method Summary

Modifier and Type	Method	Description
protected static void	appendDB(Collection<? extends LibraryEntry> entries, String dbName)	Helper method to append the database name to the end of the entry names.

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

Methods inherited from interface Command

execute

Modifier and Type	Method	Description
void	execute(CommandContext ctx)	Execute the web Command.

Constructor Details

AbstractLibraryCommand

public AbstractLibraryCommand()

Method Details

appendDB

protected static void appendDB(Collection<? extends LibraryEntry> entries,
 String dbName)

Helper method to append the database name to the end of the entry names.

Parameters:

entries - a Collection of LibraryEntry beans

dbName - the database name to append