Class InstructionSession

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.academy.InstructionSession

All Implemented Interfaces:

Serializable, Comparable<Object>, Instruction, InstructorBean, CalendarEntry, IDBean, TimeSpan, ViewEntry, Cacheable

public class InstructionSession
extends DatabaseBean
implements ViewEntry, Instruction, InstructorBean, TimeSpan

A bean used to store Flight Academy instruction session information.

Since:

1.0

Version:

7.0

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CANCELED
static final int	COMPLETE
static final int	SCHEDULED
static final String[]	STATUS_NAMES

Constructor Summary

Constructors

Constructor	Description
InstructionSession(int id, int courseID)	Creates a new Instruction Session bean.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object o)	Comapres two sessions by comparing their start times.
String	getComments()	Returns any remarks about the Session.
int	getCourseID()	Returns the Flight Academy Course ID.
Instant	getDate()	Returns the date if rendered within a calendar view.
Instant	getEndTime()	Returns the end time of this Session.
int	getInstructorID()	Returns the Instructor assigned to this Session.
String	getName()	Returns the Course name.
boolean	getNoShow()	Returns whether the Pilot missed the Session.
int	getPilotID()	Returns the Pilot participating in this Session.
String	getRowClassName()	Returns the CSS row class name if displayed in a view table.
Instant	getStartTime()	Returns the start time of this Session.
int	getStatus()	Returns the status of this Session.
String	getStatusName()	Returns the status of this Session.
void	setComments(String txt)	Updates the remarks for this Session.
void	setCourseID(int id)	Updates the Flight Academy Course..
void	setEndTime(Instant dt)	Updates the end time for this Session.
void	setInstructorID(int id)	Updates the Instructor assigned to this session.
void	setName(String name)	Updates the Course name.
void	setNoShow(boolean noShow)	Marks the Pilot as a "no-show".
void	setPilotID(int id)	Updates the Pilot participating in this session.
void	setStartTime(Instant dt)	Updates the start time for this Session.
void	setStatus(int status)	Updates the Session's status.

Methods inherited from class DatabaseBean

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

Methods inherited from class Object

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

Methods inherited from interface TimeSpan

getDuration, hasTimes

Field Details

SCHEDULED

public static final int SCHEDULED

See Also:

• Constant Field Values

CANCELED

public static final int CANCELED

See Also:

• Constant Field Values

COMPLETE

public static final int COMPLETE

See Also:

• Constant Field Values

STATUS_NAMES

public static final String[] STATUS_NAMES

Constructor Details

InstructionSession

public InstructionSession(int id,
 int courseID)

Creates a new Instruction Session bean.

Parameters:

id - the database ID

courseID - the database ID of the Course

Throws:

IllegalArgumentException - if id is negative or courseID is zero or negative

Method Details

getName

public String getName()

Returns the Course name. This may not be populated.

Returns:

the course name

See Also:

• setName(String)

getInstructorID

public int getInstructorID()

Returns the Instructor assigned to this Session.

Specified by:

getInstructorID in interface Instruction

Specified by:

getInstructorID in interface InstructorBean

Returns:

the Instructor's database ID

See Also:

• setInstructorID(int)
• getPilotID()

getPilotID

public int getPilotID()

Returns the Pilot participating in this Session.

Specified by:

getPilotID in interface Instruction

Returns:

the Pilot's database ID

See Also:

• setPilotID(int)
• getInstructorID()

getCourseID

public int getCourseID()

Returns the Flight Academy Course ID.

Specified by:

getCourseID in interface Instruction

Returns:

the database ID of the Course

See Also:

• setCourseID(int)

getStatus

public int getStatus()

Returns the status of this Session.

Returns:

the status code

See Also:

• setStatus(int)
• getStatusName()

getStatusName

public String getStatusName()

Returns the status of this Session.

Returns:

the status name

See Also:

• setStatus(int)
• getStatusName()

getStartTime

public Instant getStartTime()

Returns the start time of this Session.

Specified by:

getStartTime in interface TimeSpan

Returns:

the start date/time

See Also:

• setStartTime(Instant)
• CalendarEntry.getDate()
• getEndTime()

getEndTime

public Instant getEndTime()

Returns the end time of this Session.

Specified by:

getEndTime in interface TimeSpan

Returns:

the end date/time

See Also:

• setEndTime(Instant)
• getStartTime()

getNoShow

public boolean getNoShow()

Returns whether the Pilot missed the Session.

Returns:

TRUE if the Pilot did not attend, otherwise FALSE

See Also:

• setNoShow(boolean)

getComments

public String getComments()

Returns any remarks about the Session.

Specified by:

getComments in interface Instruction

Returns:

the remarks

See Also:

• setComments(String)

setName

public void setName(String name)

Updates the Course name.

Parameters:

name - the name

Throws:

NullPointerException - if name is null

See Also:

• getName()

setInstructorID

public void setInstructorID(int id)

Updates the Instructor assigned to this session.

Parameters:

id - the Instructor database ID

Throws:

IllegalArgumentException - if id is zero or negative

See Also:

• getInstructorID()
• setPilotID(int)

setPilotID

public void setPilotID(int id)

Updates the Pilot participating in this session.

Parameters:

id - the Pilot database ID

Throws:

IllegalArgumentException - if id is zero or negative

See Also:

• getPilotID()
• setInstructorID(int)

setCourseID

public void setCourseID(int id)

Updates the Flight Academy Course..

Parameters:

id - the Course database ID

Throws:

IllegalArgumentException - if id is zero or negative

See Also:

• getCourseID()

setStatus

public void setStatus(int status)

Updates the Session's status.

Parameters:

status - the status code

Throws:

IllegalStateException - if status is negative or invalid

See Also:

• getStatus()
• getStatusName()

setNoShow

public void setNoShow(boolean noShow)

Marks the Pilot as a "no-show".

Parameters:

noShow - TRUE if the Pilot did not show up, otherwise FALSE

See Also:

• getNoShow()

setStartTime

public void setStartTime(Instant dt)

Updates the start time for this Session.

Parameters:

dt - the start date/time

See Also:

• getStartTime()
• CalendarEntry.getDate()
• setEndTime(Instant)

setEndTime

public void setEndTime(Instant dt)

Updates the end time for this Session.

Parameters:

dt - the end date/time

Throws:

IllegalArgumentException - if dt is before startDate

See Also:

• getEndTime()
• setStartTime(Instant)

setComments

public void setComments(String txt)

Updates the remarks for this Session.

Parameters:

txt - the remarks

See Also:

• getComments()

compareTo

public int compareTo(Object o)

Comapres two sessions by comparing their start times.

Specified by:

compareTo in interface Comparable<Object>

Overrides:

compareTo in class DatabaseBean

See Also:

• Comparable.compareTo(Object)

getRowClassName

public String getRowClassName()

Returns the CSS row class name if displayed in a view table.

Specified by:

getRowClassName in interface ViewEntry

Returns:

the CSS class name

getDate

public Instant getDate()

Returns the date if rendered within a calendar view.

Specified by:

getDate in interface CalendarEntry

Returns:

the start date/time

See Also:

• getStartTime()