Class Manual

java.lang.Object

org.deltava.beans.fleet.LibraryEntry

org.deltava.beans.fleet.FleetEntry

org.deltava.beans.fleet.Manual

All Implemented Interfaces:

Serializable, Cloneable, Comparable<LibraryEntry>, Auditable, ViewEntry, Cacheable

public class Manual
extends FleetEntry

A bean to store information about Manuals.

Since:

1.0

Version:

8.4

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Manual(File f)	Creates a new Manual bean.

Method Summary

Modifier and Type	Method	Description
void	addCertification(String cert)	Adds a Flight Academy Certification to this Manual.
void	addCertifications(Collection<String> certs)	Clears the list of Flight Academy Certifications and replaces it with a new list.
Collection<String>	getCertifications()	Returns all Certifications linked to this Manual.
boolean	getIgnoreCertifications()	Returns whether this Manual should be shown to users not enrolled in the Certifications.
boolean	getShowOnRegister()	Returns whether the Manual should be shown on the Registration page.
DocumentType	getType()	Returns the document type.
String	getVersion()	Returns this manual's version number.
void	setIgnoreCertifcations(boolean ignoreCerts)	Marks this Manual as visible to users not enrolled in the specified Courses.
void	setShowOnRegister(boolean show)	Marks this Manual as visible on the Registration page.
final void	setVersion(int major)	Sets the manual version number.
final void	setVersion(int major, int minor, int subVersion)	Updates the version number of this resource.

Methods inherited from class FleetEntry

getLastModified, getMajorVersion, getMinorVersion, getSubVersion, setLastModified

Modifier and Type	Method	Description
Instant	getLastModified()	Updates the date this entry was last modified.
int	getMajorVersion()	Returns the major version of the resource.
int	getMinorVersion()	Returns the minor version of the resource.
int	getSubVersion()	Returns the sub-minor version of the resource.
void	setLastModified(Instant dt)	Updates the date this entry was last modified.

Methods inherited from class LibraryEntry

cacheKey, compareTo, file, getAuditID, getDescription, getDownloadCount, getFileName, getFullName, getName, getOwner, getRowClassName, getSecurity, getSize, hashCode, setDescription, setDownloadCount, setName, setOwner, setSecurity, setSize, toString

Modifier and Type	Method	Description
final Object	cacheKey()	Returns the cache key for this object.
int	compareTo(LibraryEntry e2)
File	file()	Returns the underlying filesystem entry.
String	getAuditID()	Returns the object ID for this auditable object.
String	getDescription()	Returns a description of this resource.
int	getDownloadCount()	Returns the number of times this resource has been downloaded.
String	getFileName()	Returns the filename of the resource, without paths.
String	getFullName()	Gets the full pathname of the resource on the local filesystem.
final String	getName()	Returns the name of the resource.
AirlineInformation	getOwner()	Returns the owning Virtual Airline.
String	getRowClassName()	Returns the CSS class for this object if rendered in a view table.
Security	getSecurity()	Returns this resource's security level.
long	getSize()	Returns the size of the resource.
int	hashCode()
void	setDescription(String desc)	Updates the description of this resource.
void	setDownloadCount(int count)	Updates the number of times this resource has been downloaded.
void	setName(String name)	Updates the name of this resource.
void	setOwner(AirlineInformation ai)	Updates the owning Virtual Airline.
void	setSecurity(Security level)	Updates this resource's security level.
void	setSize(long size)	Updates the size of this resource.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getAuditType, isCrossApp

Modifier and Type	Method	Description
default String	getAuditType()	Returns the audit type for this auditable object.
default boolean	isCrossApp()	Returns whether this object is within multiple web applications.

Constructor Details

Manual

public Manual(File f)

Creates a new Manual bean.

Parameters:

f - the File

Method Details

getVersion

public String getVersion()

Returns this manual's version number. Manuals only have a major version number.

Specified by:

getVersion in class FleetEntry

Returns:

a version string

See Also:

• FleetEntry.getVersion()

getShowOnRegister

public boolean getShowOnRegister()

Returns whether the Manual should be shown on the Registration page.

Returns:

TRUE if the Manual should be shown, otherwise FALSE

getIgnoreCertifications

public boolean getIgnoreCertifications()

Returns whether this Manual should be shown to users not enrolled in the Certifications.

Returns:

TRUE if visible to all, otherwise FALSE

See Also:

• setIgnoreCertifcations(boolean)

getCertifications

public Collection<String> getCertifications()

Returns all Certifications linked to this Manual.

Returns:

a Collection of Certification names

See Also:

• addCertification(String)
• addCertifications(Collection)

getType

public DocumentType getType()

Returns the document type.

Returns:

a DocumentType

addCertification

public void addCertification(String cert)

Adds a Flight Academy Certification to this Manual.

Parameters:

cert - the Certification name

See Also:

• addCertifications(Collection)
• getCertifications()

addCertifications

public void addCertifications(Collection<String> certs)

Clears the list of Flight Academy Certifications and replaces it with a new list.

Parameters:

certs - a Collection of Certification names

See Also:

• addCertification(String)
• getCertifications()

setShowOnRegister

public void setShowOnRegister(boolean show)

Marks this Manual as visible on the Registration page.

Parameters:

show - TRUE if the manual should be displayed, otherwise FALSE

See Also:

• getShowOnRegister()

setIgnoreCertifcations

public void setIgnoreCertifcations(boolean ignoreCerts)

Marks this Manual as visible to users not enrolled in the specified Courses.

Parameters:

ignoreCerts - TRUE if visible to all users, otherwise FALSE

See Also:

• getIgnoreCertifications()

setVersion

public final void setVersion(int major)

Sets the manual version number.

Parameters:

major - the version number

setVersion

public final void setVersion(int major,
 int minor,
 int subVersion)

Description copied from class: FleetEntry

Updates the version number of this resource.

Overrides:

setVersion in class FleetEntry

Parameters:

major - the major version number

minor - the minor version number

subVersion - the sub-minor version number

See Also:

• FleetEntry.getMajorVersion()
• FleetEntry.getMinorVersion()
• FleetEntry.getSubVersion()