Index (MySTARS 1.0 API)

A B C D E F G H I L M N O P R S T U V W Y
All Classes|All Packages

A

acadUnits - Variable in class MySTARS.Course: Number of AUs credited for passing the course (default = 1).
accessLevel - Variable in class MySTARS.User: The AccessLevel of each User.
AccessLevel - Enum in MySTARS: Sets the Access permissions for application and ensures that the person is logging into the correct domain.
AccessLevel() - Constructor for enum MySTARS.AccessLevel
addAU(AU) - Method in class MySTARS.Student: Adds the specified number of AUs to the student's registered AUs.
addCourse(String, String) - Method in class MySTARS.Student: Adds a course to the Student's timetable.
addCourseFromWaitlist(CourseIndex) - Method in class MySTARS.Student: Registers the student from waitlist.
AddCourseView - Class in MySTARS: Create new Course object and fills in necessary information.
AddCourseView() - Constructor for class MySTARS.AddCourseView
addIndex(CourseIndex) - Method in class MySTARS.Course: Directly adds a particular CourseIndex to the current Course.
addIndices() - Method in class MySTARS.UpdateCourseView: Adds CourseIndexs to already existing Courses.
addIndices(int) - Method in class MySTARS.Course: Add a User defined number of CourseIndices to the course.
addLesson(Lesson) - Method in class MySTARS.CourseIndex: Add a single lesson slot to the index, if it doesn't already exist.
addLessons(ArrayList<Lesson>) - Method in class MySTARS.CourseIndex: Add multiple lessons to the index.
addStudent(Student) - Method in class MySTARS.CourseIndex: Directly adds a Student to the CourseIndex and bypasses all checks.
addToWaitlist(Student) - Method in class MySTARS.CourseIndex: Add student to the index waitlist.
AddUserView - Class in MySTARS: Adds a new Student or Admin to the Database.USERS.
AddUserView() - Constructor for class MySTARS.AddUserView
Admin - Class in MySTARS: The User class that defines the actions of a System Administator.
Admin(String) - Constructor for class MySTARS.Admin: Initialiser for Class.
Admin(String, String) - Constructor for class MySTARS.Admin: Initialiser for Class.
ADMIN - MySTARS.AccessLevel: Used to indicate a User on the Admin Domain.
adminAddCourse() - Method in class MySTARS.AddCourseView: Prints prompts for the admin user to key in so that the relevant information for a new Course is keyed in.
AdminMainView - Class in MySTARS: The main menu for the Student side of the Application.
AdminMainView() - Constructor for class MySTARS.AdminMainView
AU - Enum in MySTARS: An enum that keeps track of the numebr of Academic Units that each Course is worth.
AU(Integer) - Constructor for enum MySTARS.AU: Initialiser for the Enum that ensures each Enum value has a corresponding Integer value.

B

BLACK - Static variable in class MySTARS.ConsoleColours: Black text.
BLACK_BOLD - Static variable in class MySTARS.ConsoleColours: Black bold text.
BLACK_BRIGHT - Static variable in class MySTARS.ConsoleColours: Black bright text.
BLUE - Static variable in class MySTARS.ConsoleColours: Blue text.
BLUE_BOLD - Static variable in class MySTARS.ConsoleColours: Blue bold text.
BLUE_BRIGHT - Static variable in class MySTARS.ConsoleColours: Blue bright text.

C

changeAccessLevel(AccessLevel) - Method in class MySTARS.User: Changes the AccessLevel for the User.
changeClassLocation() - Method in class MySTARS.UpdateCourseView: Changes the location for a class.
changeClassSize() - Method in class MySTARS.UpdateCourseView: Changes the Course vacancies for Courses in the Database objects.
changeCourseCode() - Method in class MySTARS.UpdateCourseView: Changes the Course code for Courses in the Database and Student objects.
changeCourseDescription() - Method in class MySTARS.UpdateCourseView: Changes the Course Description for Courses in the Database and Student objects.
changeCourseSchool() - Method in class MySTARS.UpdateCourseView: Changes the Course school for Courses in the Database and Student objects.
changeEntryTiming() - Method in class MySTARS.AdminMainView: Changes MySTARS access start and end dates and times.
changeIndex(String, String, String) - Method in class MySTARS.Student: Puts the student in a different index of a registered course.
ChangeIndexView - Class in MySTARS: Changes the index of the Course selected by User.
ChangeIndexView() - Constructor for class MySTARS.ChangeIndexView
changePassword() - Method in class MySTARS.AdminMainView: Changes the Password for the Database.CURRENT_USER.
changePassword() - Method in class MySTARS.StudentMainView: Changes the Password for the Database.CURRENT_USER.
changePassword() - Method in class MySTARS.User: Changes the password for a User.
checkCourseCodeFormat(String) - Static method in class MySTARS.Course: A method to check the Course code to verify it matches a fixed pattern.
checkPassword(String) - Method in class MySTARS.User: Checks if the password entered by the User is the correct password.
chooseClassType() - Static method in class MySTARS.Lesson: Method to prompt user to choose the type of class
clashes(String, String) - Method in class MySTARS.Student: Checks if a course index of a course clashes with the student's timetable.
clashes(ArrayList<Lesson>) - Method in class MySTARS.Lesson
classSize - Variable in class MySTARS.CourseIndex: The total enrolment of the class.
classType - Variable in class MySTARS.Lesson: The type of class (lecture, tutorial etc.) which is an enum ClassType.
ClassType - Enum in MySTARS: An Enum that keeps track of the different class types.
ClassType(String) - Constructor for enum MySTARS.ClassType: Initialiser for ClassType Enum.
clearScreen(String) - Method in class MySTARS.View: ClearScreen function that prints a header as well as the current view that the User is in.
compareTo(Student) - Method in class MySTARS.Student: Compares this student with the specified student for order.
ConsoleColours - Class in MySTARS: ConsoleColours which are to be used in the MySTARS App.
ConsoleColours() - Constructor for class MySTARS.ConsoleColours
containsIndex(String) - Method in class MySTARS.Course: Check if the Course has a particular Index number.
Course - Class in MySTARS: Represents one course/module
Course(String, String, AU) - Constructor for class MySTARS.Course: Constructor for course object, to be created without a description, school and course status.
Course(String, String, AU, String, String) - Constructor for class MySTARS.Course: Constructor for course object, to be created with a description and school, but without course status.
Course(String, String, AU, String, String, CourseStatus) - Constructor for class MySTARS.Course: Constructor for course object, to be created with a description, school and course status.
Course(String, String, AU, String, String, CourseStatus, CourseIndex) - Constructor for class MySTARS.Course: Constructor for course object, creates course with description, school, course status, and an initial course index.
courseCode - Variable in class MySTARS.Course: The course code (eg.
courseCode - Variable in class MySTARS.CourseIndex: The course code for associated course (eg.
CourseIndex - Class in MySTARS: Represents one index of a particular course/module
CourseIndex(int, String, String) - Constructor for class MySTARS.CourseIndex: Constructor for course index, with no lessons at the start.
CourseIndex(int, String, String, ArrayList<Lesson>) - Constructor for class MySTARS.CourseIndex: Constructor for the course index, and including already existing lessons inside.
courseIndices - Variable in class MySTARS.Course: Hashmap of all available indices in the course.
CourseManager - Class in MySTARS: CourseManager that prints information regarding courses in the correct format.
CourseManager() - Constructor for class MySTARS.CourseManager
courseName - Variable in class MySTARS.Course: Full course name (eg.
courses - Variable in class MySTARS.Student: A list of courses the student is registered under or on waitlist for.
COURSES - MySTARS.FileType: File type corresponding to the Courses file.
COURSES - Static variable in class MySTARS.Database: A Hashmap<String, Course> that stores all Courses and its contained information.
courseStatus - Variable in class MySTARS.Course: Status of a the course in relation to a student (eg.
CourseStatus - Enum in MySTARS: An Enum that keeps track of the Status of a particular course.
CourseStatus(String) - Constructor for enum MySTARS.CourseStatus: Initialiser for CourseStatus with label value.
CURRENT_ACCESS_LEVEL - Static variable in class MySTARS.Database: The current AccessLevel of the currently logged in User.
CURRENT_USER - Static variable in class MySTARS.Database: A User object that keeps track of the currently logged in User.
CYAN - Static variable in class MySTARS.ConsoleColours: Cyan text.
CYAN_BOLD - Static variable in class MySTARS.ConsoleColours: Cyan bold text.
CYAN_BRIGHT - Static variable in class MySTARS.ConsoleColours: Cyan bright text.

D

Database - Class in MySTARS: The Class that interacts with the files and handles reading and writing of information.
Database() - Constructor for class MySTARS.Database: The initialiser for the Database class.
dayOfWeek - Variable in class MySTARS.Lesson: The day of the week when the lesson occurs (Monday - Sunday).
DayOfWeek - Enum in MySTARS: An Enum that keeps track of the day of the week to simplify time tracking.
DayOfWeek(Integer, String) - Constructor for enum MySTARS.DayOfWeek: Initialiser for Enum DayOfWeek to ensure that all values have a label and a value.
decryptPassword() - Method in class MySTARS.User: Decrypts the password stored as byte data, using the Base 64 encoding scheme as specified in RFC 4648 and RFC 2045.
description - Variable in class MySTARS.Course: Course description.
deserialise(FileType) - Static method in class MySTARS.Database: Reads files into its respective Hashmap.
dropCourse() - Method in class MySTARS.StudentMainView: Removes the User from the selected Course.
dropCourse(String) - Method in class MySTARS.Student: Drops a course from the student's timetable.

E

encryptPassword(String) - Method in class MySTARS.User: Encrypts the raw password string using the Base64 encoding scheme as specified in RFC 4648 and RFC 2045.
endTime - Variable in class MySTARS.Lesson: The end time of the lesson in 24h time (4 digit integer).
enrolledStudents - Variable in class MySTARS.CourseIndex: Hashmap of currently enrolled students.
enrollNextInWaitlist() - Method in class MySTARS.CourseIndex: Removes the student next in line in the waitlist, and enrolls object to course register.
enrollStudent(Student) - Method in class MySTARS.CourseIndex: Enrolls a specified student object into the index.

F

FEMALE - MySTARS.Gender: Enum value corresponding to Female persons.
fileName - Variable in enum MySTARS.FileType: A String value for the FileType so that it is easy to retrieve.
filePath - Static variable in class MySTARS.Database: The path to the directory where the data files are stored.
FileType - Enum in MySTARS: FileType Enum that corresponds to the different files that the Application will use.
FileType(String) - Constructor for enum MySTARS.FileType: Initialiser for the FileType Enum.
firstName - Variable in class MySTARS.Student: The student's first name.
formatTime(DayOfWeek, int, int) - Static method in class MySTARS.Helper: A date formatter that takes in the current day and time and returns a DateTime object.
FOUR - MySTARS.AU: An enum representing 4 Academic Units.
FRIDAY - MySTARS.DayOfWeek: Enum value representing Friday.

G

gender - Variable in class MySTARS.Student: The student's Gender.
Gender - Enum in MySTARS: Gender Enum that keeps track of the different Genders of the students.
Gender(String, int) - Constructor for enum MySTARS.Gender: An initialiser for each Gender Enum.
getAccessLevel() - Method in class MySTARS.User: Getter method that retireves the AccessLevel of the User.
getAU() - Method in class MySTARS.Student: Returns the student's current number of registered Academic Units (AUs).
getAU(int) - Static method in enum MySTARS.AU: A helper method that converts an input integer value to the appropriate AU value.
getClassSize() - Method in class MySTARS.CourseIndex: Returns the class size for the index.
getClassType(String) - Static method in enum MySTARS.ClassType: Takes in a string indicating the class type, and returns the corresponding ClassType enum.
getCourse(String) - Method in class MySTARS.Student: Returns a Course object that the Student has registered for.
getCourseAU() - Method in class MySTARS.Course: Return the number of AUs credited upon completion of the Course.
getCourseCode() - Method in class MySTARS.Course: Returns the courseCode.
getCourseCode() - Method in class MySTARS.CourseIndex: Return the course code as a string (eg.
getCourseIndex() - Method in class MySTARS.CourseIndex: Return the index number of the course index as a string (eg.
getCourseName() - Method in class MySTARS.Course: Return the courseName.
getCourses(CourseStatus) - Method in class MySTARS.Student: Returns a list of the student's courses, based on the desired course status.
getDayOfWeek(int) - Static method in enum MySTARS.DayOfWeek: Helper function that returns the corresponding DayOfWeek value for a given day in integer format.
getDescription() - Method in class MySTARS.Course: Return the Course description.
getEndTime() - Method in class MySTARS.Lesson: Returns end time of the lesson slot, in JodaTime DateTime object (year, month, day of week, hour, minute).
getEndTime() - Method in class MySTARS.LoginView: Getter method for the currently set log in end time.
getFirstName() - Method in class MySTARS.Student: Returns the student's first name.
getGender() - Method in class MySTARS.Student: Returns the student's gender.
getGender(int) - Static method in enum MySTARS.Gender: A helper method to get the Gender from a String input.
getGender(String) - Static method in enum MySTARS.Gender: A helper method to get the Gender from a String input.
getIndex(String) - Method in class MySTARS.Course: Returns a CourseIndex object by taking the index number as a parameter.
getIndices() - Method in class MySTARS.Course: Returns an array of all indices registered under the Course.
getIndices(CourseStatus) - Method in class MySTARS.Student: Returns a list of the student's course indices, based on the desired course status.
getIndicesString() - Method in class MySTARS.Course: Return an array all index numbers registered the Course.
getLastName() - Method in class MySTARS.Student: Returns the student's last name.
getLesson(Integer) - Method in class MySTARS.CourseIndex: Returns the Lesson object based on the key value lessonID
getLessonID() - Method in class MySTARS.Lesson: Returns Lesson ID for current lesson.
getLessons() - Method in class MySTARS.CourseIndex: Return all the lesson slots in the index.
getLocation() - Method in class MySTARS.Lesson: Returns location of lesson as a string.
getMatricNumber() - Method in class MySTARS.Student: Returns the student's matriculation number.
getNationality() - Method in class MySTARS.Student: Returns the student's nationality.
getPasswordInput() - Static method in class MySTARS.Helper: A method to read passwords from Console without displaying the characters on the screen.
getRemarks() - Method in class MySTARS.Lesson: Returns the remarks for this lesson slot.
getSchool() - Method in class MySTARS.Course: Return the school offering this course.
getStartTime() - Method in class MySTARS.Lesson: Returns starting time of the lesson slot, in JodaTime DateTime object (year, month, day of week, hour, minute).
getStartTime() - Method in class MySTARS.LoginView: Getter method for the currently set log in start time.
getStatus() - Method in class MySTARS.Course: Return the CourseStatus of a Student's enrollment in the Course.
getStudents() - Method in class MySTARS.CourseIndex: Returns an array of students currently enrolled in the index.
getTime() - Method in class MySTARS.Lesson: Returns the interval of time where the lesson occurs, as a JodaTime Interval object.
getType() - Method in class MySTARS.Lesson: Returns a ClassType enum specifying the type of the specified lesson.
getUsername() - Method in class MySTARS.User: Getter method that retrieves the Username of the User.
getVacancies() - Method in class MySTARS.CourseIndex: Return the number of remaining vacancies.
getWaitlistLength() - Method in class MySTARS.CourseIndex: Return the length of the waitlist for the index.
getWaitlistStudents() - Method in class MySTARS.CourseIndex: Return an array of Students that are on Waitlist.
GREEN - Static variable in class MySTARS.ConsoleColours: Green text.
GREEN_BOLD - Static variable in class MySTARS.ConsoleColours: Green bold text.
GREEN_BRIGHT - Static variable in class MySTARS.ConsoleColours: Green bright text.

H

Helper - Class in MySTARS: A Helper Class with all properties and methods that are generally needed across the application.
Helper() - Constructor for class MySTARS.Helper

I

indexNumber - Variable in class MySTARS.CourseIndex: The index number used to refer to this index by (eg.
isValidLoginDate() - Method in class MySTARS.LoginView: Checks if the current time is within the allocated time for Students to log in.
isValidMatricNo(String) - Static method in class MySTARS.Student: Checks if a String can be used as a matriculation number.
isValidNewMatricNo(String) - Static method in class MySTARS.Student: Checks if a String can be used as a new matriculation number.

L

LAB - MySTARS.ClassType: Enum value for Labs.
label - Variable in enum MySTARS.ClassType: String label that is associated with each Enum value.
label - Variable in enum MySTARS.CourseStatus: String value corresponding to each Enum value.
label - Variable in enum MySTARS.DayOfWeek: The String value of the day of the week to 3 Characters.
label - Variable in enum MySTARS.Gender: A String value corresponding to each Gender Enum.
lastName - Variable in class MySTARS.Student: The student's last name.
LECTURE - MySTARS.ClassType: Enum value for Lectures.
Lesson - Class in MySTARS: Represents one lesson timeslot
Lesson(ClassType, DayOfWeek, int, int, String) - Constructor for class MySTARS.Lesson: Lesson constructor, creates new lesson of specified ClassType on a certain day of the week.
lessonID - Variable in class MySTARS.Lesson: Lesson ID, used to identify and update lessons.
lessons - Variable in class MySTARS.CourseIndex: Hashmap of lessons, to be accessed using LessonID
load() - Static method in class MySTARS.Helper: A load function that prints progress bars across the screen at 500ms intervals.
location - Variable in class MySTARS.Lesson: Location of the lesson
loginEnd - Static variable in class MySTARS.LoginView
loginStart - Static variable in class MySTARS.LoginView
LoginView - Class in MySTARS: Initial View seen by User.
LoginView() - Constructor for class MySTARS.LoginView: Constructor method that checks if the Student login period has been set.
LogoutView - Class in MySTARS: The log out page before being redirected to the LoginView.
LogoutView() - Constructor for class MySTARS.LogoutView

M

main(String[]) - Static method in class MySTARS.MySTARSApp: Main function that is the starting point of the application.
MALE - MySTARS.Gender: Enum value corresponding to Male persons.
matricNumber - Variable in class MySTARS.Student: The student's unique, 9-character matriculation number.
maxAUs - Static variable in class MySTARS.Student: The maximum number of AUs that a Student can take.
MISC - MySTARS.FileType: File type corresponding to the Miscellaneous file.
MONDAY - MySTARS.DayOfWeek: Enum value representing Monday.
MySTARS - package MySTARS
MySTARSApp - Class in MySTARS: This is the starting point of the application
MySTARSApp() - Constructor for class MySTARS.MySTARSApp

N

nationality - Variable in class MySTARS.Student: The student's nationality.
NONBINARY - MySTARS.Gender: Enum value corresponding to Non-Binary persons.
NONE - MySTARS.AccessLevel: Used to indicate that no user is logged in.
NONE - MySTARS.CourseStatus: Enum value corresponding to a course not affiliated with a Student.
NOT_REGISTERED - MySTARS.CourseStatus: Enum value corresponding to a Not Registered Course.

O

ONE - MySTARS.AU: An enum representing 1 Academic Unit.
ONLINE - MySTARS.ClassType: Enum value for Online lessons.

P

password - Variable in class MySTARS.User: The encrypted password of each user.
pause() - Static method in class MySTARS.Helper: A pause function that waits for the user to press the Enter key to proceed on with the next task.
planCourse(Course, CourseIndex) - Method in class MySTARS.Student: Adds Courses to the Student's plan.
PREFER_NOT_TO_SAY - MySTARS.Gender: Enum value corresponding Persons that prefer not to say their Genders.
print() - Method in class MySTARS.AddCourseView: Required method from View.
print() - Method in class MySTARS.AddUserView: Required method from View.
print() - Method in class MySTARS.AdminMainView: Prints menu options for the User to select from.
print() - Method in class MySTARS.ChangeIndexView: Required method from View.
print() - Method in class MySTARS.LoginView: Displays Login view for User, checks the credentials and then logs in the User if the credentials are valid.
print() - Method in class MySTARS.LogoutView: Required method from View.
print() - Method in class MySTARS.PrintStudentListView: Displays the a list of Students.
print() - Method in class MySTARS.PrintTimeTableView: The main print function of the view, which prints out the timetable in the correct formatting.
print() - Method in class MySTARS.StudentMainView: Prints menu options for the User to select from.
print() - Method in class MySTARS.SwapIndexView: Required method from View.
print() - Method in class MySTARS.UpdateCourseView: Prints prompts for the User to key in so that the relevant information to update a Course is keyed in.
print() - Method in class MySTARS.VacanciesView: Displays the number of vacancies in a particular Course or CourseIndex to the user.
print() - Method in class MySTARS.View: Necessary print functions that will be used as the start point of every view.
printAllStudents() - Method in class MySTARS.AddUserView: Prints a list of students in the Database.
printCourseDetails(Course) - Static method in class MySTARS.CourseManager: Prints the full details of a course.
printCourseList(CourseStatus) - Static method in class MySTARS.CourseManager: Prints a list of courses based on the CourseStatus from Database.
printCourseList(CourseStatus, Student) - Static method in class MySTARS.CourseManager: Prints a list of courses based on the CourseStatus from a Student's courses.
printIndexList(Course, boolean) - Static method in class MySTARS.CourseManager: Prints a list of CourseIndex for a particular Course with the option to print the number of vacanices.
printInformation(CourseStatus, Student) - Static method in class MySTARS.PrintTimeTableView: Displays all the relevant information for courses that are of a particular CourseStatus for a Student.
printLargeSpace() - Static method in class MySTARS.Helper: Prints 7 lines of space
printLesson(CourseIndex) - Static method in class MySTARS.CourseManager: Prints a list of Lesson for a given CourseIndex.
printLesson(Lesson) - Static method in class MySTARS.CourseManager: Prints a lesson information for a given Lesson.
printLine() - Static method in class MySTARS.CourseManager: Prints a horizontal line across the screen.
printLine() - Static method in class MySTARS.PrintTimeTableView: Method that prints a horizontal line across the screen.
printLine(int) - Static method in class MySTARS.Helper: Method that prints a horizontal line across the screen.
printMediumSpace() - Static method in class MySTARS.Helper: Prints 5 lines of space
printSmallSpace() - Static method in class MySTARS.Helper: Prints 3 lines of space
printStudentListByCourse(Course, boolean) - Static method in class MySTARS.CourseManager: Prints a list of students in a given Course with the option to have the list sorted.
printStudentListByIndex(CourseIndex, boolean) - Static method in class MySTARS.CourseManager: Prints a list of students in a given CourseIndex.
PrintStudentListView - Class in MySTARS: Class to handle the admin function of printing the list of students.
PrintStudentListView() - Constructor for class MySTARS.PrintStudentListView
PrintTimeTableView - Class in MySTARS: A view that prints the Timetable for the currently logged in User.
PrintTimeTableView() - Constructor for class MySTARS.PrintTimeTableView
PURPLE - Static variable in class MySTARS.ConsoleColours: Purple text.
PURPLE_BOLD - Static variable in class MySTARS.ConsoleColours: Purple bold text.
PURPLE_BRIGHT - Static variable in class MySTARS.ConsoleColours: Purple bright text.

R

readLine() - Static method in class MySTARS.Helper: Reads standard input using the Scanner.
readTime() - Static method in class MySTARS.Helper: Reads time input using Scanner.
RED - Static variable in class MySTARS.ConsoleColours: Red text.
RED_BOLD - Static variable in class MySTARS.ConsoleColours: Red bold text.
RED_BRIGHT - Static variable in class MySTARS.ConsoleColours: Red bright text.
REGISTERED - MySTARS.CourseStatus: Enum value corresponding to a Registered Course.
registeredAUs - Variable in class MySTARS.Student: The student's number of registered Academic Units.
remarks - Variable in class MySTARS.Lesson: Additional remarks (eg.
removeAU(AU) - Method in class MySTARS.Student: Removes the specified number of AUs from the student's registered AUs.
removeCourse(String) - Method in class MySTARS.Student: Directly removes a Course from the courses Hashmap.
removeFromWaitlist(String) - Method in class MySTARS.CourseIndex: Removes a specified student's username from the index waitlist.
removeIndex(String) - Method in class MySTARS.Course: Directly removes a particular CourseIndex to the current Course.
removeIndex(String, String) - Method in class MySTARS.Student: Directly removes a CourseIndex from a Course in the courses Hashmap.
removeStudent(String) - Method in class MySTARS.CourseIndex: Directly removes a Student from the CourseIndex.
RESET - Static variable in class MySTARS.ConsoleColours: Reset the color.
resetUsers() - Method in class MySTARS.Database: Resets Admin users if they have been deleted.
restoreSettings() - Method in class MySTARS.Database: Reads and restores key settings from file.

S

SATURDAY - MySTARS.DayOfWeek: Enum value representing Saturday.
sc - Static variable in class MySTARS.Helper: A single Scanner object that reads input from console so that memory resources are efficiently used.
school - Variable in class MySTARS.Course: The school that offers this course.
SEMINAR - MySTARS.ClassType: Enum value for Seminars.
sendMailNotification(Student, String) - Static method in class MySTARS.Helper: A method that sends an email from the Administrative Gmail Account to the user if their course has been registered.
serialise(FileType) - Static method in class MySTARS.Database: Writes Hashmaps into the respective files.
serialVersionUID - Static variable in class MySTARS.Admin: Unique identifier for Serialisation.
serialVersionUID - Static variable in class MySTARS.Course: For Java serializable.
serialVersionUID - Static variable in class MySTARS.CourseIndex: For java serializable
serialVersionUID - Static variable in class MySTARS.Lesson: For java serializable
serialVersionUID - Static variable in class MySTARS.Student: The unique ID of the class for Serialisation.
serialVersionUID - Static variable in class MySTARS.User: The unique ID of the class for Serialisation.
setClassSize(int) - Method in class MySTARS.CourseIndex: Set the classSize
setCourse(Course) - Method in class MySTARS.Student: Directly adds a Course to the Hashmap.
setCourseAU(AU) - Method in class MySTARS.Course: Set the number of AUs to be credited upon completion of the Course.
setCourseCode(String) - Method in class MySTARS.Course: Sets courseCode.
setCourseName(String) - Method in class MySTARS.Course: Set courseName.
setDescription(String) - Method in class MySTARS.Course: Set the Course description.
setIndex(String, CourseIndex) - Method in class MySTARS.Student: Directly Adds a CourseIndex to a Course in the courses Hashmap.
setLocation(String) - Method in class MySTARS.Lesson: Sets the location of the lesson.
setLoginTime(DateTime, DateTime) - Static method in class MySTARS.LoginView: Assigns the period of time that the Student can log in.
setRemarks(String) - Method in class MySTARS.Lesson: Sets any relevant remarks for the lesson slot.
setSchool(String) - Method in class MySTARS.Course: Sets school.
setStatus(CourseStatus) - Method in class MySTARS.Course: Set the CourseStatus of a Student's enrollment in the Course.
setTime(int, int) - Method in class MySTARS.Lesson: Set start and end time of lesson slot.
SETTINGS - Static variable in class MySTARS.Database: A Hashmap<String, Object> that stores all Miscellaneous settings so that the application can return to its previous state after shutdown.
simpleCopy() - Method in class MySTARS.CourseIndex: Creates a simple copy of this course index, with same parameters except for 0 vacancies.
simpleCopy() - Method in class MySTARS.Student: Creates a copy of this student object with minimal information.
simpleCopy(CourseStatus, CourseIndex) - Method in class MySTARS.Course: Make a simple copy of the course to be stored under the Student object.
startTime - Variable in class MySTARS.Lesson: The start time of the lesson in 24h time (4 digit integer).
Student - Class in MySTARS: Represents one Student
Student(String, String, String, String, String, Gender, String) - Constructor for class MySTARS.Student: The constructor with all possible parameters.
Student(String, String, String, String, Gender, String) - Constructor for class MySTARS.Student: The constructor with the minimum required number of parameters.
STUDENT - MySTARS.AccessLevel: Used to indicate a User on the Student Domain.
studentAddCourse() - Method in class MySTARS.AddCourseView: Displays all available course information.
StudentMainView - Class in MySTARS: The main menu for the Student side of the Application.
StudentMainView() - Constructor for class MySTARS.StudentMainView
SUNDAY - MySTARS.DayOfWeek: Enum value representing Sunday.
SwapIndexView - Class in MySTARS: Verifies a second User from Database.USERS and swaps the indices for both the Users.
SwapIndexView() - Constructor for class MySTARS.SwapIndexView

T

THREE - MySTARS.AU: An enum representing 3 Academic Units.
THURSDAY - MySTARS.DayOfWeek: Enum value representing Thursday.
time - Variable in class MySTARS.Lesson: The allocated block of time for the lesson, of type Interval.
TUESDAY - MySTARS.DayOfWeek: Enum value representing Tuesday.
TUTORIAL - MySTARS.ClassType: Enum value for Tutorials.
TWO - MySTARS.AU: An enum representing 2 Academic Units.

U

unenrollStudent(Student) - Method in class MySTARS.CourseIndex: Removes student from the enrolled register.
UpdateCourseView - Class in MySTARS: Updates Course object and with new information.
UpdateCourseView() - Constructor for class MySTARS.UpdateCourseView
User - Class in MySTARS: The superclass of all User classes in the application.
User(String, String, AccessLevel) - Constructor for class MySTARS.User: Initialiser for the User Class with a new username, password and AccessLevel.
User(String, AccessLevel) - Constructor for class MySTARS.User: Initialiser for the User Class with a default password and a new username and AccessLevel.
username - Variable in class MySTARS.User: The username associated with each network User.
USERS - MySTARS.FileType: File type corresponding to the Users file.
USERS - Static variable in class MySTARS.Database: A Hashmap<String, User> that stores all Users and their contained information.

V

vacancies - Variable in class MySTARS.CourseIndex: The number of vacancies for this index (initially set to the maximum class size).
VacanciesView - Class in MySTARS: Gives the User the ability to check vacancies in a Course.
VacanciesView() - Constructor for class MySTARS.VacanciesView
value - Variable in enum MySTARS.AU: An Integer value that is associated with each Enum value.
value - Variable in enum MySTARS.DayOfWeek: The Integer value corresponding to the DayOfWeek in DateTime.
value - Variable in enum MySTARS.Gender: A integer value corresponding to each Gender Enum.
valueOf(String) - Static method in enum MySTARS.AccessLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum MySTARS.AU: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum MySTARS.ClassType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum MySTARS.CourseStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum MySTARS.DayOfWeek: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum MySTARS.FileType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum MySTARS.Gender: Returns the enum constant of this type with the specified name.
values() - Static method in enum MySTARS.AccessLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum MySTARS.AU: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum MySTARS.ClassType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum MySTARS.CourseStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum MySTARS.DayOfWeek: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum MySTARS.FileType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum MySTARS.Gender: Returns an array containing the constants of this enum type, in the order they are declared.
verifySecondUser(String) - Method in class MySTARS.SwapIndexView: For swapping index with a peer, this method checks if peer is a valid user that is registered for the relevant course.
View - Class in MySTARS: The abstract superclass of all views in the application.
View() - Constructor for class MySTARS.View
viewWaitlistedCourses() - Method in class MySTARS.StudentMainView: Displays the Courses that are on CourseStatus.WAITLIST.

W

waitlist - Variable in class MySTARS.CourseIndex: The current waitlist for the index.
WAITLIST - MySTARS.CourseStatus: Enum value corresponding to a course on Waitlist.
waitlistedStudents - Variable in class MySTARS.CourseIndex: Hashmap of currently waitlisted students.
WEDNESDAY - MySTARS.DayOfWeek: Enum value representing Wednesday.
WHITE - Static variable in class MySTARS.ConsoleColours: White text.
WHITE_BOLD - Static variable in class MySTARS.ConsoleColours: White bold text.
WHITE_BRIGHT - Static variable in class MySTARS.ConsoleColours: White bright text.

Y

YELLOW - Static variable in class MySTARS.ConsoleColours: Yellow text.
YELLOW_BOLD - Static variable in class MySTARS.ConsoleColours: Yellow bold text.
YELLOW_BRIGHT - Static variable in class MySTARS.ConsoleColours: Yellow bright text.

A B C D E F G H I L M N O P R S T U V W Y
All Classes|All Packages