|
__________________________________________________________ |
name | availability |
alias | none |
description | The times when an employee is available for work. |
definition | availability = {time ranges}7 |
supplementary | none |
__________________________________________________________ |
name | color |
alias | none |
description | used solely in skill class to associate a skill with a color |
definition | color = a Java Color |
supplementary | color is displayed in the background of a shift |
__________________________________________________________ |
name | day |
alias | day of the week |
description | an enumerated type used to specify a day of the week |
definition | day = 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday' |
supplementary | 3-letter abbreviations are used as labels in certain user interface elements |
__________________________________________________________ |
name | desired hours |
alias | none |
description | the desired number of hours that an employee would like to work in a week |
definition | desired hours = a non-negative float |
supplementary | This number will be rounded to the nearest hour |
__________________________________________________________ |
name |
alias | none |
description | an employee's e-mail address |
definition | email = String |
supplementary | null string designates no e-mail address |
__________________________________________________________ |
name | employee |
alias | Employees (class name) |
description | a person who is a candidate to be scheduled |
definition | employee = Personal Information + availability + scheduled |
supplementary | none |
__________________________________________________________ |
name | employees |
alias | ListOfEmployees (class name) |
description | a list of employees |
definition | employees = {employee}n |
supplementary | none |
__________________________________________________________ |
name | filename |
alias | none |
description | the name of a file in the platform O/S file system. |
definition | filename = String |
supplementary |
__________________________________________________________ |
name | initials |
alias | none |
description | Employee Initials (first and last). Used to mark a generated schedule to indicate which employee has been assigned to a shift. |
definition | initials = first initial + last initial |
first initial = alphabetic character |
last initial = alphabetic character |
supplementary | The system doesn't verify that initials are unique. It allows Joe Doe and Jane Doe to both use JD as their initials. |
__________________________________________________________ |
name | name |
alias | none |
description | Employee name, displayed in employee list for selecting people from the database. |
definition | name = String |
supplementary | The program will not allow duplicate names to be entered. |
__________________________________________________________ |
name | Personal Information |
alias | Employee Info |
description | Employee contact information |
definition | Personal Information = name + initials + phone + skills + email + |
desired hours + scheduled hours |
supplementary | none |
__________________________________________________________ |
name | phone |
alias | none |
description | phone number |
definition | phone = String |
supplementary | none |
__________________________________________________________ |
name | schedule |
alias | Schedules (class name) |
description | the schedule for a week |
definition | schedule = {Templates}7 |
supplementary | none |
__________________________________________________________ |
name | scheduled |
alias | none |
description | the times when an employee has been assigned to work |
definition | scheduled = {time ranges}7 |
supplementary | used to prevent scheduling an employee twice in the same time period |
__________________________________________________________ |
name | scheduled hours |
alias | none |
description | the number of hours an employee has been scheduled. |
definition | scheduled hours = float |
supplementary | none |
__________________________________________________________ |
name | settings |
alias | Preferences |
description | program configuration parameters specified by the user |
definition | settings = start day + start time + skills + tasklist toggle | |
supplementary | none |
__________________________________________________________ |
name | shift |
alias | Shifts (class name) |
description | a shift represents a period of time when a person with a particular skill is needed to work. |
definition | shift = time range + skill + [initials] |
supplementary | When unassigned the shift has no initials. Once an employee has been assigned to the shift, that person's initials will be associated with the shift. |
__________________________________________________________ |
name | skill |
alias | Skills (class name) |
description | a task or role that is performed, the job description |
definition | skill = skill name + skill abbreviation + color |
supplementary | none |
__________________________________________________________ |
name | skill name |
alias |
description | a unique name identifying a kind of job the employee performs. |
definition | skill name = String |
supplementary | none |
__________________________________________________________ |
name | skill abbreviation |
alias |
description | a three letter abbreviation of skill name |
definition | skill abbreviation = {character}3 |
supplementary | none |
__________________________________________________________ |
name | skills |
alias | ListOfSkills (class name) |
description | a list of skills |
definition | skills = {skill}n | |
supplementary | none |
__________________________________________________________ |
name | task list |
alias |
description | a list of the tasks or steps necessary for the user to generate a schedule using the scheduler software. |
definition | task list = {String}n | |
supplementary | none |
__________________________________________________________ |
name | template |
alias | Templates (class name), saved template, working template |
description | represents a collection of shifts for an entire day |
definition | template = {shift}n |
supplementary | named templates have only unfilled shifts |
__________________________________________________________ |
name | time range(s) |
alias | DayTimeRanges (class name) |
description | a range or ranges of times. There are 24 hours in the day, each of which could be included or excluded. |
definition | time range = {boolean}24 |
supplementary | none |
__________________________________________________________ |
name | time |
alias | Times (class name) |
description | a standard clock time, in hours and minutes |
definition | time = hours + minutes |
0
<= hours (int)<= 24
0 <= minutes (int) <= 59 |
supplementary | a military style clock time is used, with 0:00 = midnight |
__________________________________________________________ |