Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
A
C
D
E
G
I
L
M
N
O
P
R
S
T
W
A
abbreviation
- Variable in class
Skills
A skill's abbreviation
AddAvailability(int, DayTimeRanges)
- Method in class
Employees
Adds to the employee's availability
AddEmployee(Employees)
- Method in class
ListOfEmployees
Adds an employee to the list
AddScheduled(int, DayTimeRanges)
- Method in class
Employees
Adds already scheduled hours to the employee
AddShift(int, Shifts)
- Method in class
Schedules
Adds a shift to the schedule on a specific day
AddShift(Shifts)
- Method in class
Templates
Adds a shift to a template
AddSkill(Skills)
- Method in class
Employees
Adds a skill to the employee
AddSkill(Skills)
- Method in class
ListOfSkills
Add a skill to the list.
AddSkill(Skills)
- Method in class
Settings
Adds a skill to the settings
assignedEmployee
- Variable in class
Shifts
Assigned employee
availability
- Variable in class
Employees
Availability of the employee
C
ChangeEmployee(Shifts, Employees)
- Method in class
Templates
Change the employee associated with a shift
ChangeSkill(Shifts, Skills)
- Method in class
Templates
Change a skill associated with a shift
ChangeTime(Shifts, DayTimeRanges)
- Method in class
Templates
Change the time associated with a shift
Clear()
- Method in class
DayTimeRanges
Clears the entire time range
Clear()
- Method in class
Templates
Clears the entire template
Clear()
- Method in class
Weeks
Clears the week
clone()
- Method in class
DayTimeRanges
Makes a copy of the current object
clone()
- Method in class
Employees
Creates a copy of the current object
clone()
- Method in class
ListOfEmployees
Creates a copy of the current object
clone()
- Method in class
ListOfSkills
Creates a copy of the current object
clone()
- Method in class
Shifts
Makes a copy of the current object
clone()
- Method in class
Skills
Create a copy of the current object
clone()
- Method in class
Times
Makes a copy of the current object
clone()
- Method in class
Weeks
Makes a copy of the current object
color
- Variable in class
Skills
The color associated with the skill (stored as an int)
Compare(boolean[])
- Method in class
DayTimeRanges
Compares two times to see where they overlap
D
data
- Variable in class
ListOfEmployees
A vector of employees
data
- Variable in class
ListOfSkills
A vector of skills
daysOfWeek
- Variable in class
Schedules
Seven templates that make up all of the days of the week
dayTimeRanges
- Variable in class
DayTimeRanges
Contains time range information (Consult data dictionary for more information on how our time ranges are being represented)
DayTimeRanges
- class
DayTimeRanges
.
Represents a range or ranges of time(s) in a day
DayTimeRanges()
- Constructor for class
DayTimeRanges
Constructs a day with no time ranges designated
DayTimeRanges(Times, Times)
- Constructor for class
DayTimeRanges
Constructs a day with one time range designated
desiredHours
- Variable in class
Employees
Desired number of hours of work per week
E
email
- Variable in class
Employees
E-Mail address of the employee
employees
- Variable in class
EmployeeScheduler
All of the employees
Employees
- class
Employees
.
Is a representation of any employee used throughout the employee scheduler.
Employees(String, String, String, float, Weeks, ListOfSkills)
- Constructor for class
Employees
Constructs a new employee with given data
EmployeeScheduler
- class
EmployeeScheduler
.
Application class
EmployeeScheduler()
- Constructor for class
EmployeeScheduler
G
Generate(ListOfEmployees)
- Method in class
Schedules
The Generate() function consists of two passes: During the first pass, the list of employees is traversed linearly.
Get()
- Method in class
DayTimeRanges
Gets the day's time ranges as a boolean array
Get()
- Method in class
Weeks
Gets the week as an array of seven times
GetAbbreviation()
- Method in class
Skills
Get an abbreviaton for manipulation
GetAvailability()
- Method in class
Employees
Gets a copy of the availability of the employee
GetColor()
- Method in class
Skills
Check what color is assigned to this skill
GetDay(int)
- Method in class
Weeks
Gets the times from a specific day (1=Monday...)
GetDesiredHours()
- Method in class
Employees
Gets the number of hours that the employee would like to work per week
GetEmail()
- Method in class
Employees
Gets the employee's e-mail address
GetEmployee()
- Method in class
Shifts
Gets the employee that is assigned to this shift, null if no employee is assigned.
GetEmployee(String)
- Method in class
ListOfEmployees
Pre-conditions: A valid variable of type String is passed.
GetEmployeeNames()
- Method in class
ListOfEmployees
Pre-conditions: none Post-conditions: Returns the vector of employees.
GetEmployeeShifts(Employees)
- Method in class
Templates
Get the shifts assigned to a particular employee
GetListOfSkills()
- Method in class
Settings
Gets the names of the list of skills defined in the settings
GetName()
- Method in class
Employees
Gets the employee's name
GetName()
- Method in class
Skills
Get a name for manipulation
GetPhone()
- Method in class
Employees
Gets the employee's phone number
GetScheduled()
- Method in class
Employees
Gets a copy of the scheduled hours of the employee in a week
GetShifts()
- Method in class
Templates
Gets all of the shifts in a template
GetShifts(int)
- Method in class
Schedules
Gets all of the shifts on a particular day
GetShowTasklist()
- Method in class
Settings
Gets whether or not the Show Task List is active
GetSkill()
- Method in class
Shifts
Gets the skill required for the shift
GetSkill(String)
- Method in class
ListOfSkills
Get a particular skill from a list.
GetSkillNames()
- Method in class
ListOfSkills
Gets the names of all the skills in the list
GetSkills()
- Method in class
Employees
Gets a copy of the list of skills that the employee has learned
GetStartDay()
- Method in class
Settings
Gets the day to start the schedule
GetStartStopTimes()
- Method in class
DayTimeRanges
Gets the day's time ranges as a vector of start and stop Times This function goes through the private boolean array.
GetStartTime()
- Method in class
Settings
Gets time to start the scheduling day, from 0-23.5 (ie.
GetTime()
- Method in class
Shifts
Gets the time of the shift
GetTimes()
- Method in class
Times
Returns the time of the class
I
Insert(Times, Times)
- Method in class
DayTimeRanges
Inserts a time range or ranges into the current object
isFilled
- Variable in class
Shifts
True if shift has been filled, false otherwise
IsIn(Employees)
- Method in class
ListOfEmployees
Pre-conditions: A valid variable of type of Employees is passed.
IsIn(Skills)
- Method in class
ListOfSkills
Checks to see if a skill is in the list
L
ListOfEmployees
- class
ListOfEmployees
.
Is a representation of a list of employees.
ListOfEmployees()
- Constructor for class
ListOfEmployees
Constructs an empty list of employees
ListOfEmployees(Vector)
- Constructor for class
ListOfEmployees
Constructs the list of employees from a vector of employees
ListOfSkills
- class
ListOfSkills
.
Represents a list of employee skills.
ListOfSkills()
- Constructor for class
ListOfSkills
Constructs an empty list of skills
ListOfSkills(Vector)
- Constructor for class
ListOfSkills
Construct a list of skills from a vector of skills
LoadTemplate(int, String)
- Method in class
Schedules
Loads a template into a specific day
M
main(String[])
- Static method in class
EmployeeScheduler
Main function
mainSchedule
- Variable in class
EmployeeScheduler
Main schedule
mainSettings
- Variable in class
EmployeeScheduler
Main settings
N
name
- Variable in class
Employees
Name of the employee
name
- Variable in class
Skills
A name of a skill
O
Optimize(ListOfEmployees)
- Method in class
Schedules
The function Optimize is called in the Generate function.
P
phone
- Variable in class
Employees
Phone number of the employee
R
Remove(Times, Times)
- Method in class
DayTimeRanges
Removes a time range or ranges from the current object
RemoveAvailability(Weeks)
- Method in class
Employees
Removes a whole week's worth of time ranges from an employee's availability
RemoveEmployees(Vector)
- Method in class
ListOfEmployees
Removes employees from the list
RemoveScheduled(Weeks)
- Method in class
Employees
Removes a scheduled time from the employee
RemoveShift(int, Shifts)
- Method in class
Schedules
Removes a shift from the schedule on a specific day
RemoveShift(Shifts)
- Method in class
Templates
Removes a shift from a template
RemoveSkill(Skills)
- Method in class
Employees
Removes a skill from the employee
RemoveSkills(ListOfSkills)
- Method in class
ListOfSkills
Removes skills from the list
RemoveSkills(ListOfSkills)
- Method in class
Settings
Removes skills from the settings
S
SaveTemplate(int, String)
- Method in class
Schedules
Saves a template from a specific day into a specific file
scheduled
- Variable in class
Employees
Hours that the employee has been scheduled for already
Schedules
- class
Schedules
.
Contains seven templates to represent an entire week
Schedules()
- Constructor for class
Schedules
Constructs an empty schedule
Schedules(String)
- Constructor for class
Schedules
Constructs a schedule from a file
Set(DayTimeRanges[])
- Method in class
Weeks
Set new times for the whole week
SetAbbreviation(String)
- Method in class
Skills
Modify abbreviation
SetColor(int)
- Method in class
Skills
Modify the color
SetDay(int, DayTimeRanges)
- Method in class
Weeks
Set times to a specific day
SetDesiredHours(float)
- Method in class
Employees
Changes the employee's desired number of hours to work per week
SetEmail(String)
- Method in class
Employees
Changes the employee's e-mail address
SetEmployee(Employees)
- Method in class
Shifts
Modifies or sets the employee assigned to a shift
SetEmployee(int, Shifts, Employees)
- Method in class
Schedules
Sets an employee to a shift on a specified day
SetName(String)
- Method in class
Employees
Changes the employee's name
SetName(String)
- Method in class
Skills
Modify the name
SetPhone(String)
- Method in class
Employees
Changes the employee's phone number
SetShowTasklist(boolean)
- Method in class
Settings
Sets whether or not to show the task list
SetSkill(Skills)
- Method in class
Shifts
Changes the skill assigned to a shift
SetStartDay(int)
- Method in class
Settings
Sets the start day of the schedule
SetStartTime(Times)
- Method in class
Settings
Sets the start time for the schedule
SetTime(DayTimeRanges)
- Method in class
Shifts
Changes the time of the shift
SetTimes(float)
- Method in class
Times
Sets a times using the passed float variable, which must be from 0 to 23.5
Settings
- class
Settings
.
Represents all of the settings that are a part of the employee scheduler.
Settings()
- Constructor for class
Settings
Constructs configuration based on an external file
ShiftIsFilled()
- Method in class
Shifts
Checks to see if the shift has been filled already
shifts
- Variable in class
Templates
A Vector of shifts for the entire day (templates cover the whole day)
Shifts
- class
Shifts
.
Represents an employee's shift (either filled already or to be filled in later)
Shifts(Times, Times, Skills)
- Constructor for class
Shifts
Constructs a shift that hasn't been filled yet
Shifts(Times, Times, Skills, Employees)
- Constructor for class
Shifts
Constructs a shift that has been filled already
shiftSkill
- Variable in class
Shifts
Required skill
shiftTime
- Variable in class
Shifts
Shift durration
showTaskList
- Variable in class
Settings
True if Show Task List is active, false otherwise
skills
- Variable in class
Employees
Skills of the employee
skills
- Variable in class
Settings
List of skills in the settings
Skills
- class
Skills
.
Represents an employee skill
Skills(String, String, int)
- Constructor for class
Skills
Construct a skill
startDay
- Variable in class
Settings
Day to start scheduling (i.e.
startTime
- Variable in class
Settings
Time to start the scheduling day, from 0-23.5
T
Templates
- class
Templates
.
A template contains all of the information for a single day of the schedule, templates may either be loaded from a file or created new
Templates()
- Constructor for class
Templates
Constructs an empty template
Templates(String)
- Constructor for class
Templates
Constructs a template from a given file
time
- Variable in class
Times
a time of a day
timeRanges
- Variable in class
Weeks
An array of seven times (each element in the array corresponds to a differnt day of the week and therefore makes up the entire week)
Times
- class
Times
.
Is a time which is by half hour (ex.
Times()
- Constructor for class
Times
Constructs an empty time
Times(float)
- Constructor for class
Times
Constructs a times using the passed float variable, which must be from 0 to 23.5
W
Weeks
- class
Weeks
.
Contains the seven sets of times that make up a week
Weeks()
- Constructor for class
Weeks
Constructs an empty week
Weeks(DayTimeRanges[])
- Constructor for class
Weeks
Constructs a week based on pre-determined days
A
C
D
E
G
I
L
M
N
O
P
R
S
T
W
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES