Class Applicant

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.DatabaseBlobBean

org.deltava.beans.Person

org.deltava.beans.Applicant

All Implemented Interfaces:

Serializable, Comparable<Object>, Principal, EMailAddress, FormattedEMailRecipient, IDBean, ViewEntry, Cacheable

public class Applicant
extends Person

A class for storing Applicant entries.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from class Person

_networkIDs, _notifyOptions, AUTH_EMAIL, HIDE_EMAIL, SHOW_EMAIL

Modifier and Type	Field	Description
protected final Map<OnlineNetwork, String>	_networkIDs
protected final Collection<Notification>	_notifyOptions
static final int	AUTH_EMAIL	Hide e-mail address from unauthenticated users.
static final int	HIDE_EMAIL	Hide e-mail address from all non-staff users.
static final int	SHOW_EMAIL	Show e-mail address to all users.

Fields inherited from class DatabaseBlobBean

_buffer

Modifier and Type	Field	Description
protected byte[]	_buffer	The buffer for the image/file data.

Fields inherited from interface EMailAddress

VALID_ADDR_REGEXP

Modifier and Type	Field	Description
static final String	VALID_ADDR_REGEXP	E-mail address validation regular expression.

Constructor Summary

Constructors

Constructor	Description
Applicant(String firstName, String lastName)	Create an Applicant object with a given first and last name, converted to "proper case".

Method Summary

Modifier and Type	Method	Description
void	addHRComment(String c)	Appends an HR comment to this Applicant.
void	addRole(String roleName)	Add a security role to the Person's list of roles.
boolean	getAutoReject()	Returns if this Applicant was automatically rejected due to CAPTCHA issues.
String	getComments()	Returns any additional Applicant comments.
boolean	getHasCAPTCHA()	Returns whether the CAPTCHA has been verified.
String	getHRComments()	Returns any HR comments.
String	getLegacyURL()	Returns the URL for legacy hours verification.
boolean	getLegacyVerified()	Returns legacy hours verification status.
int	getPilotID()	Returns the Database ID of this Applicant's Pilot record.
String	getRegisterAddress()	Returns the address this Applicant registered from.
String	getRegisterHostName()	Returns the host name this Applicant registered from.
Collection<String>	getRoles()	Returns a list of security roles this Person belongs to.
String	getRowClassName()	Returns the CSS class for this object if rendered in a view table.
Simulator	getSimVersion()	Returns the Simulator preferred by this Applicant.
ApplicantStatus	getStatus()	Returns the Applicant's status.
Map<Long,String>	getTypeChoices()	Returns the stage equipment type choices.
boolean	isInRole(String roleName)	Queries if a Person is a member of a particular role.
void	setAutoReject(boolean isAutoReject)	Updates whether this Applicant was automatically rejected due to CAPTCHA issues.
void	setComments(String comments)	Updates the Applicant comments.
void	setHasCAPTCHA(boolean hasCaptchaVerified)	Updates whether this Applicant has passed tha CAPTCHA check.
void	setHRComments(String comments)	Updates the HR comments.
void	setLegacyURL(String url)	Sets the URL for legacy hours verification
void	setLegacyVerified(boolean verified)	Sets the legacy hours verification flag.
void	setPilotID(int pilotID)	Updates the Database ID of this Applicant's Pilot record.
void	setRegisterAddress(String addr)	Sets the remote address this Applicant registered from.
void	setRegisterHostName(String hostName)	Sets the host name this Applicant registered from.
void	setSimVersion(Simulator s)	Set the Simulator used by this Applicant.
void	setStatus(ApplicantStatus s)	Updates the Applicant's status.
void	setTypeChoice(int stage, String eqName)	Sets the preferred equipment program for a stage.

Methods inherited from class Person

getAirportCodeType, getCreatedOn, getDateFormat, getDistanceType, getDN, getEmail, getEmailAccess, getEmailDomain, getEquipmentType, getExternalID, getExternalIDs, getFirstName, getHomeAirport, getLastLogin, getLastLogoff, getLastName, getLegacyHours, getLocation, getLoginCount, getLoginHost, getName, getNetworkID, getNetworks, getNotifyCode, getNotifyOptions, getNumberFormat, getPassword, getRank, getTimeFormat, getTZ, getUIScheme, getViewCount, getWeightType, hasID, hasNetworkID, hasNotifyOption, isInvalid, setAirportCodeType, setCreatedOn, setDateFormat, setDistanceType, setDN, setEmail, setEmailAccess, setEmailInvalid, setEquipmentType, setExternalID, setFirstName, setHomeAirport, setLastLogin, setLastLogoff, setLastName, setLegacyHours, setLocation, setLoginCount, setLoginHost, setNetworkID, setNotificationCode, setNotifyOption, setNumberFormat, setPassword, setRank, setTimeFormat, setTZ, setUIScheme, setViewCount, setWeightType, toString

Modifier and Type	Method	Description
Airport.Code	getAirportCodeType()	Returns the Person's preferred airport code type (IATA/ICAO).
Instant	getCreatedOn()	Return the date/time this Person registered.
String	getDateFormat()	Returns the Person's preferred date format pattern.
DistanceUnit	getDistanceType()	Returns the Person's preferred distance unit.
String	getDN()	Return this Person's LDAP/JNDI Directory Name.
String	getEmail()	Return the Person's e-mail address.
int	getEmailAccess()	Returns the access to a Person's e-mail address.
String	getEmailDomain()	Returns this person's e-mail domain.
String	getEquipmentType()	Return the Person's equipment type program.
String	getExternalID(ExternalID service)	Returns the Person's external IDs.
Map<ExternalID, String>	getExternalIDs()	Returns a Map containing this Person's external IDs.
String	getFirstName()	Return this Person's First Name.
String	getHomeAirport()	Return the Person's home airport code.
Instant	getLastLogin()	Return the Person's latest login date/time.
Instant	getLastLogoff()	Return the Person's last logoff date/time.
String	getLastName()	Return this Person's Last Name.
double	getLegacyHours()	Return this Person's legacy flight hours.
String	getLocation()	Return the Person's location.
int	getLoginCount()	Return the number of times this Person has logged into the system.
String	getLoginHost()	Return the hostname or IP address that this Person last logged in from.
String	getName()	Returns this Person's Full name.
String	getNetworkID(OnlineNetwork net)	Returns this Person's online network ID
Collection<OnlineNetwork>	getNetworks()	Returns the Online Networks this used has provided an ID for.
int	getNotifyCode()	Returns the aggregated notification code.
Collection<Notification>	getNotifyOptions()	Returns all selected notification options.
String	getNumberFormat()	Returns the Person's preferred number format pattern.
String	getPassword()	Return the Person's password.
Rank	getRank()	Return the Person's rank.
String	getTimeFormat()	Returns the Person's preferred time format pattern.
TZInfo	getTZ()	Return this Person's Time Zone.
String	getUIScheme()	Returns the Person's preferred web site UI scheme.
int	getViewCount()	Returns the Person's preferred view window size.
WeightUnit	getWeightType()	Returns the Person's preferred weight unit.
boolean	hasID(ExternalID svc)	Returns whether a Person has a specific Instant Messenger handle.
boolean	hasNetworkID(OnlineNetwork net)	Retuns if this Person is a memebr of an online network.
boolean	hasNotifyOption(Notification notifyType)	Return a particular e-mail notification option for this Person.
boolean	isInvalid()	Returns whether this recipient has an invalid e-mail address.
void	setAirportCodeType(Airport.Code code)	Updates the Person's preferred airport code type (IATA/ICAO).
void	setCreatedOn(Instant cd)	Update this Person's createdOn date/time
void	setDateFormat(String pattern)	Updates the Person's preferred date format.
void	setDistanceType(DistanceUnit un)	Updates the Person's preferred distance units.
void	setDN(String dn)	Update the Person's directory name.
void	setEmail(String email)	Update the Person's e-mail address.
void	setEmailAccess(int accessLevel)	Update the Person's e-mail address acess level.
void	setEmailInvalid(boolean isInvalid)	Marks the email address as invalid.
void	setEquipmentType(String eqType)	Update the Person's Equipment Type.
void	setExternalID(ExternalID svc, String handle)	Update this Person's Instant Messaging handle.
void	setFirstName(String name)	Updates the Person's first (given) name.
void	setHomeAirport(String aCode)	Update this Person's home airport
void	setLastLogin(Instant lld)	Update this Person's last Login date/time.
void	setLastLogoff(Instant lld)	Update the Person's last Logoff date/time.
void	setLastName(String name)	Updates the Person's last (family) name.
void	setLegacyHours(double legacyHours)	Update this Person's legacy flight hours.
void	setLocation(String location)	Update this Person's location.
void	setLoginCount(int count)	Update this person's login count
void	setLoginHost(String hostName)	Updates the hostname or IP address that this Person last logged in from
void	setNetworkID(OnlineNetwork network, CharSequence id)	Update the Person's network ID for a given online network.
void	setNotificationCode(int code)	Sets the notification options for a user from a single bitmap value.
void	setNotifyOption(Notification option, boolean notify)	Update this Person's notification option for a given notificaiton type.
void	setNumberFormat(String pattern)	Updates the Person's preferred number format.
void	setPassword(String pwd)	Update the Person's password.
void	setRank(Rank rank)	Update the person's Rank.
void	setTimeFormat(String pattern)	Updates the Person's preferred time format.
void	setTZ(TZInfo tz)	Sets the Time Zone for this Person.
void	setUIScheme(String schemeName)	Updates this Person's preferred web site UI scheme.
void	setViewCount(int size)	Sets the size of the Person's preferred view window.
void	setWeightType(WeightUnit un)	Updates the Person's preferred weight units.
String	toString()	Returns the person's full name.

Methods inherited from class DatabaseBlobBean

clear, getInputStream, getSize, isLoaded, load, load

Modifier and Type	Method	Description
void	clear()	Clears the buffer.
InputStream	getInputStream()	Returns the content of the buffer.
int	getSize()	Returns the size of the image/file data.
boolean	isLoaded()	Returns whether the buffer has been populated.
void	load(byte[] buffer)	Replaces the buffer data.
void	load(InputStream is)	Loads the contents of a stream into the buffer.

Methods inherited from class DatabaseBean

cacheKey, compareTo, equals, getHexID, getID, hashCode, setID, validateID, validateID

Modifier and Type	Method	Description
Object	cacheKey()	Returns the cache key for this object.
int	compareTo(Object o)
boolean	equals(Object o)
String	getHexID()	Returns the hexadecimal database ID of this object.
int	getID()	Returns the database ID of this object.
int	hashCode()
void	setID(int id)	Update the database row ID of this bean.
static void	validateID(int oldID, int newID)	Validates a database ID.
static void	validateID(int oldID, int newID, boolean allowZero)	Validates a database ID.

Methods inherited from class Object

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

Methods inherited from interface Principal

equals, hashCode, implies

Constructor Details

Applicant

public Applicant(String firstName,
 String lastName)

Create an Applicant object with a given first and last name, converted to "proper case".

Parameters:

firstName - the Applicant's first (given) name

lastName - the Applicant's last (family) name

Throws:

NullPointerException - if either name is null

See Also:

• StringUtils.properCase(String)

Method Details

getStatus

public ApplicantStatus getStatus()

Returns the Applicant's status.

Returns:

an ApplicantStatus enum

getLegacyURL

public String getLegacyURL()

Returns the URL for legacy hours verification.

Returns:

the URL for legacy hours verification, null if not available

See Also:

• setLegacyURL(String)

getLegacyVerified

public boolean getLegacyVerified()

Returns legacy hours verification status.

Returns:

TRUE if legacy hours have been verified

See Also:

• setLegacyVerified(boolean)

getAutoReject

public boolean getAutoReject()

Returns if this Applicant was automatically rejected due to CAPTCHA issues.

Returns:

TRUE if automatically rejected, otherwise FALSE

See Also:

• setAutoReject(boolean)

getPilotID

public int getPilotID()

Returns the Database ID of this Applicant's Pilot record.

Returns:

the Database ID if hired as a Pilot

See Also:

• setPilotID(int)

getComments

public String getComments()

Returns any additional Applicant comments.

Returns:

the comments

See Also:

• setComments(String)
• getHRComments()

getHRComments

public String getHRComments()

Returns any HR comments.

Returns:

the comments

See Also:

• setHRComments(String)
• getComments()

getRegisterHostName

public String getRegisterHostName()

Returns the host name this Applicant registered from.

Returns:

the host name

See Also:

• setRegisterHostName(String)
• getRegisterAddress()

getRegisterAddress

public String getRegisterAddress()

Returns the address this Applicant registered from.

Returns:

the IP address

See Also:

• setRegisterAddress(String)
• getRegisterHostName()

getHasCAPTCHA

public boolean getHasCAPTCHA()

Returns whether the CAPTCHA has been verified.

Returns:

TRUE if CAPTCHA verified, otherwise FALSE

See Also:

• setHasCAPTCHA(boolean)

getSimVersion

public Simulator getSimVersion()

Returns the Simulator preferred by this Applicant.

Returns:

the Simulator

See Also:

• setSimVersion(Simulator)

addHRComment

public void addHRComment(String c)

Appends an HR comment to this Applicant.

Parameters:

c - the comment

setLegacyURL

public void setLegacyURL(String url)

Sets the URL for legacy hours verification

Parameters:

url - the URL for legacy hours verification

See Also:

• getLegacyURL()

setLegacyVerified

public void setLegacyVerified(boolean verified)

Sets the legacy hours verification flag.

Parameters:

verified - TRUE if hours have been verified, FALSE otherwise

See Also:

• getLegacyVerified()

setAutoReject

public void setAutoReject(boolean isAutoReject)

Updates whether this Applicant was automatically rejected due to CAPTCHA issues.

Parameters:

isAutoReject - TRUE if automatically rejected, otherwise FALSE

See Also:

• getAutoReject()

setTypeChoice

public void setTypeChoice(int stage,
 String eqName)

Sets the preferred equipment program for a stage.

Parameters:

stage - the stage number

eqName - the equipment program

setSimVersion

public void setSimVersion(Simulator s)

Set the Simulator used by this Applicant.

Parameters:

s - the Simulator

See Also:

• getSimVersion()

setRegisterHostName

public void setRegisterHostName(String hostName)

Sets the host name this Applicant registered from.

Parameters:

hostName - the host name

See Also:

• getRegisterHostName()
• setRegisterAddress(String)

setRegisterAddress

public void setRegisterAddress(String addr)

Sets the remote address this Applicant registered from.

Parameters:

addr - the IP address

See Also:

• getRegisterAddress()
• setRegisterHostName(String)

setComments

public void setComments(String comments)

Updates the Applicant comments.

Parameters:

comments - the comments

See Also:

• getComments()
• setHRComments(String)

setHRComments

public void setHRComments(String comments)

Updates the HR comments.

Parameters:

comments - the comments

See Also:

• getHRComments()
• setComments(String)

setPilotID

public void setPilotID(int pilotID)

Updates the Database ID of this Applicant's Pilot record.

Parameters:

pilotID - the database ID, if hired as a Pilot

Throws:

IllegalArgumentException - if pilotID is negative

IllegalStateException - if the Applicant has not been Approved

See Also:

• getPilotID()

setStatus

public void setStatus(ApplicantStatus s)

Updates the Applicant's status.

Parameters:

s - an ApplicantStatus

setHasCAPTCHA

public void setHasCAPTCHA(boolean hasCaptchaVerified)

Updates whether this Applicant has passed tha CAPTCHA check.

Parameters:

hasCaptchaVerified - TRUE if CAPTCHA verified, othersie FALSE

addRole

public void addRole(String roleName)

Description copied from class: Person

Add a security role to the Person's list of roles.

Specified by:

addRole in class Person

Parameters:

roleName - the name of the role

isInRole

public boolean isInRole(String roleName)

Description copied from class: Person

Queries if a Person is a member of a particular role.

Specified by:

isInRole in class Person

Parameters:

roleName - the role name

Returns:

TRUE if the Person is a member of this role, otherwise FALSE

getRoles

public Collection<String> getRoles()

Description copied from class: Person

Returns a list of security roles this Person belongs to.

Specified by:

getRoles in class Person

Returns:

a Collection of role names

getTypeChoices

public Map<Long,String> getTypeChoices()

Returns the stage equipment type choices.

Returns:

a Map of choices, keyed by stage

getRowClassName

public String getRowClassName()

Description copied from interface: ViewEntry

Returns the CSS class for this object if rendered in a view table.

Returns:

the CSS class name, or NULL if none