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 org.deltava.beans.fleet.FleetEntry

getLastModified, getMajorVersion, getMinorVersion, getSubVersion, setLastModified

Methods inherited from class org.deltava.beans.fleet.LibraryEntry

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deltava.beans.Auditable

getAuditType, isCrossApp

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()