Software Application Support Framework Grading Database Requirements Document Ongo8d

Transcription

1 Software Application Support Framework Grading Database Requirements Document Ongo8d Client: Ongo08 Sub Teams Faculty Advisors: Dr. John Lamont Professor Ralph Patterson CprE/EE 492 Team Members: Tim Adkisson, CprE Kevin Wendzel, CprE CprE/EE 491 Team Members: Mark Klein, CprE Jason Wilkinson, CprE/ComS 28 September 2004

2 Table of Contents INTRODUCTION...1 PROBLEM STATEMENT...1 General Problem Statement...1 General Solution-Approach Statement...1 CONSTRUCTOR DEFINITIONS...2 Administrator...2 Coordinator...2 Parent...2 ParentToStudent...2 ProblemAnswered...2 QuizRecord...2 School...2 Section...2 SectionQuiz...2 SectionStudent...2 Student...2 Teacher...3 FUNCTION DEFINITIONS...4 SCHOOL FUNCTIONS...4 getschoolsbycriteria...4 getschool...4 addschool...4 updateschool...4 deleteschool...5 ADMINISTRATOR FUNCTIONS...6 getadministratorsbycriteria...6 getadministrator...6 addadministrator...6 updateadministrator...6 deleteadministrator...6 COORDINATOR FUNCTIONS...7 getcoordinatorsbycriteria...7 getcoordinator...7 addcoordinator...7 updatecoordinator...7 deletecoordinator...7 TEACHER FUNCTIONS...8 getteachersbycriteria...8 getteacher...8 addteacher...8 updateteacher...8 deleteteacher...8 PARENT FUNCTIONS...9 getparentsbycriteria...9 getparent...9 addparent...9 updateparent...9 deleteparent...9 PARENTSTOSTUDENTS FUNCTIONS...10 getstudentsofparent...10 ii

3 getparentsofstudent...10 deleteparenttostudent...10 addparenttostudent...10 STUDENT FUNCTIONS...11 getstudentsbycriteria...11 getstudent...11 addstudent...11 updatestudent...11 deletestudent...11 SECTIONSTOSTUDENTS FUNCTIONS...12 getstudentsinsection...12 getsectionsofstudent...12 deletesectionstostudents...12 addsectionstostudents...12 SECTION FUNCTIONS...13 getsectionsbycriteria...13 getsection...13 addsection...13 updatesection...13 deletesection...13 SECTION QUIZZES FUNCTIONS...14 getsectionquiz...14 getsectionquizzesbycriteria...14 deletesectionquiz...14 addsectionquiz...14 updatesectionquiz...14 QUIZ RECORDS FUNCTIONS...15 getquizrecord...15 getquizrecordsbycriteria...15 deletequizrecord...15 addquizrecord...15 updatequizrecord...15 PROBLEMS ANSWERED FUNCTIONS...16 getproblemanswered...16 getproblemsansweredbycriteria...16 deleteproblemanswered...16 addproblemanswered...16 updateproblemanswered...16 TABLE DEFINITIONS...17 SCHOOLS TABLE...18 SchoolID...18 Name...18 Address...18 City...18 State...18 Zip...18 Description...18 TEACHERS TABLE...19 TeacherID...19 SchoolID...19 Username...19 PARENTS TABLE...20 ParentID...20 Username...20 PhoneNumber...20 iii

4 PARENTSTOSTUDENTS TABLE...21 ParentsToStudentsID...21 ParentID...21 StudentID...21 SECTIONS TABLE...22 SectionID...22 TeacherID...22 Subject...22 Name...22 Classification...22 STUDENTS TABLE...23 StudentID...23 Username...23 Classification...23 ADMINISTRATORS TABLE...24 AdministratorID...24 SchoolID...24 Username...24 COORDINATORS TABLE...25 CoordinatorID...25 SchoolID...25 Subject...25 Username...25 SECTIONSTOSTUDENTS TABLE...26 SectionStudentID...26 StudentID...26 SectionID...26 SECTIONQUIZZES TABLE...27 SectionQuizID...27 QuizID...27 SectionID...27 DateTimeAvailable...27 DateTimeDue...27 QuizNumber...27 RetryQuiz...27 RetryProblems...28 QuizFeedback...28 ProblemFeedback...28 QUIZRECORDS TABLE...29 QuizRecordID...29 StudentID...29 QuizID...29 SectionID...29 Timestamp...29 PointsAwarded...29 PROBLEMSANSWERED TABLE...30 ProblemAnsweredID...30 QuizRecordID...30 ProblemChoiceID...30 ProblemID...30 AnswerGiven...30 Correct...30 PointsAwarded...30 TABLE DIAGRAM...31 iv

5 CONCLUSION...32 PROJECT TEAM INFORMATION...32 Client Information...32 Faculty Advisor Information...32 CprE/EE 492 Member Information...32 CprE/EE 491 Member Information...32 SUMMARY...33 v

6 Introduction The purpose of the document is to give a general understanding of the implementation and methods used by the framework team (Ongo 08d) in their PHP library code. All questions should be directed to the framework team, and all assumptions made by non-framework teams (Ongo 08a, Ongo 08b, and Ongo 08c) should be checked with by Ongo 08d team representatives before implementation of said assumptions. This document will be updated each term when new functionality is added to the framework. After agreeing upon the contents of this document, the framework will then begin creating code to meet these objectives. Once the code is ready for implementation, the contents of this document will become part of the framework cookbook. The cookbook should be used by the other teams as a guide to implementing the framework. Problem Statement This section contains the general problem and the solution decided upon, by the framework team. General Problem Statement The Ongoing 08 team consists of a series of applications and a framework. The framework is to be a library of calls, functions, and tables the applications can call to do basic routines shared by all of the applications. Since most of the applications were built by different sub-teams and different developers, each application is a little different. It is the framework s responsibility to make the applications uniform in how they access the database, call specified routines, and respond to errors. General Solution-Approach Statement The Ongoing 08 team needs a list of set functions and tables to construct their applications around. In order to facilitate their needs, the framework team (Ongo 08d) has met and gathered information from each team including, but not limited to: application design, external file usage, method handling, and question types. From the meetings, a list of functions and SQL tables has been compiled. Contained within this document are the tables and functions to be considered for review by the application sub-teams. The Ongoing 08 sub-teams (MTSS, Uncle Sam s America, and Globey s World) can now utilize this document by looking at the functions, tables, and definitions under proposal. Each function and table entry definition should help a team member to understand both why and how to use it. 1

7 Constructor definitions The grading portion of the framework uses objects to pass data. This section describes the constructors used to create these objects. This section is closely related to the database diagram on page 31. When a field is not known, such as the AdministratorID when creating an Administrator for the first time, place a null in its field. All calls to the constructor must have the correct number of parameters. Administrator Call: $obj = new Administrator($AdministratorID, $SchoolID, $Username); Coordinator Call: $obj = new Coordinator($CoordinatorID, $SchoolID, $Subject, $Username); Parent Call: $obj = new Parent($ParentID, $Username, $PhoneNumber); ParentToStudent Call: $obj = new ParentToStudent($ParentToStudentID, $ParentID, $StudentID); ProblemAnswered Call: $obj = new ProblemAnswered($ProblemAnsweredID, $ProblemChoiceID, $QuizRecordID, $AnswerGiven, $Correct, $PointsAwarded, $ProblemID) QuizRecord Call: $obj = new QuizRecord($QuizRecordID, $QuizID, $StudentID, $Timestamp, $PointsAwarded, $SectionID); School Call: $obj = new School($SchoolID, $Name, $Address, $City, $State, $Zip, $Description); Section Call: $obj = new Section($SectionID, $TeacherID, $Subject, $Name, $Classification); SectionQuiz Call: $obj = new SectionQuiz($SectionQuizID, $QuizID, $SectionID, $DateTimeAvailable, $DateTimeDue, $QuizNumber, $RetryQuiz, $RetryProblems, $QuizFeedback, $ProblemFeedback); SectionStudent Call: $obj = new SectionStudent($SectionStudentID, $StudentID, $SectionID); Student Call: $obj = new Student($StudentID, $Username, $Classification); 2

8 Teacher Call: $obj = new Teacher($TeacherID, $Username, $SchoolID); 3

9 Function Definitions The following are a list of tentative desired functions for the framework. Included within each function is a listing of the prototype, description, and what the call will return. No distinction over whether to use objects or arrays has been made yet. School Functions The functions below are associated with the School table and will allow the programs to retrieve school information based upon certain search criteria or by a known SchoolID. They will also allow the addition of new schools as well as modifying and deleting existing schools. getschoolsbycriteria Call: array getschoolsbycriteria(object SchoolInfo) Description: The getschoolsbycriteria function can be called as the above notation describes. Additionally, the getschoolsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the school you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of School objects. getschool Call: object getschool(int SchoolID) Description: The getschool function can be called as the above notation describes. Unlike, the getschoolsbycriteria function. The SchoolID must be passed in order to find a matching table entry. Return: A row from School table as an object. addschool Call: int addschool(object SchoolInfo) Description: The addschool function can be called as the above notation describes. The addschool function will add a school to the SQL table when invoked. During the call the object of SchoolInfo is required. Return: The SchoolID of the school just created, or NULL if unsuccessful. updateschool Call: boolean updateschool(object SchoolInfo) Description: By passing the SchoolID and the SchoolInfo, you can call the updateschool function. The updateschool function will find the proper school by use of the SchoolID and add the new information contained in the object SchoolInfo that was passed. 4

10 deleteschool Call: boolean deleteschool(int SchoolID) Description: When passed the SchoolID, the deleteschool will search through the table and erase the row corresponding to that SchoolID. Once the school has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted school information from the weekly sd6 backup file stored offsite. 5

11 Administrator Functions The functions below are associated with the Administrator table and will allow the programs to retrieve administrator information based upon certain search criteria or by a known AdministratorID. They will also allow the addition of new administrators as well as modifying and deleting existing administrators. getadministratorsbycriteria Call: array getadministratorsbycriteria(object AdministratorInfo) Description: The getadministratorsbycriteria function can be called as the above notation describes. Additionally, the getadministratorsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the administrator you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Administrator objects. getadministrator Call: object getadministrator(int AdministratorID) Description: The getadministrator function can be called as the above notation describes. Unlike, the getadministratorsbycriteria function. The AdministratorID must be passed in order to find a matching table entry. Return: A row from Administrator table as an object. addadministrator Call: int addadministrator(object AdministratorInfo) Description: The addadministrator function can be called as the above notation describes. The addadministrator function will add a administrator to the SQL table when invoked. During the call the object of AdministratorInfo is required. Return: The AdministratorID of the administrator just created, or NULL if unsuccessful. updateadministrator Call: boolean updateadministrator(object AdministratorInfo) Description: By passing the AdministratorID and the AdministratorInfo, you can call the updateadministrator function. The updateadministrator function will find the proper administrator by use of the AdministratorID and add the new information contained in the object AdministratorInfo that was passed. deleteadministrator Call: boolean deleteadministrator(int AdministratorID) Description: When passed the AdministratorID, the deleteadministrator will search through the table and erase the row corresponding to that AdministratorID. Once the administrator has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted administrator information from the weekly sd6 backup file stored offsite. 6

12 Coordinator Functions The functions below are associated with the Coordinator table and will allow the programs to retrieve course coordinator information based upon certain search criteria or by a known CoordinatorID. They will also allow the addition of new course coordinators as well as modifying and deleting existing course coordinators. getcoordinatorsbycriteria Call: array getcoordinatorsbycriteria(object CoordinatorInfo) Description: The getcoordinatorsbycriteria function can be called as the above notation describes. Additionally, the getcoordinatorsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the coordinator you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Coordinator objects. getcoordinator Call: object getcoordinator(int CoordinatorID) Description: The getcoordinator function can be called as the above notation describes. Unlike, the getcoordinatorsbycriteria function. The CoordinatorID must be passed in order to find a matching table entry. Return: A row from Coordinator table as an object. addcoordinator Call: int addcoordinator(object CoordinatorInfo) Description: The addcoordinator function can be called as the above notation describes. The addcoordinator function will add a coordinator to the SQL table when invoked. During the call the object of CoordinatorInfo is required. Return: The CoordinatorID of the coordinator just created, or NULL if unsuccessful. updatecoordinator Call: boolean updatecoordinator(object CoordinatorInfo) Description: By passing the CoordinatorID and the CoordinatorInfo, you can call the updatecoordinator function. The updatecoordinator function will find the proper coordinator by use of the CoordinatorID and add the new information contained in the object CoordinatorInfo that was passed. deletecoordinator Call: boolean deletecoordinator(int CoordinatorID) Description: When passed the CoordinatorID, the deletecoordinator will search through the table and erase the row corresponding to that CoordinatorID. Once the coordinator has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted coordinator information from the weekly sd6 backup file stored offsite. 7

13 Teacher Functions The functions below are associated with the Teacher table and will allow the programs to retrieve teacher information based upon certain search criteria or by a known TeacherID. They will also allow the addition of new teachers as well as modifying and deleting existing teachers. getteachersbycriteria Call: array getteachersbycriteria(object TeacherInfo) Description: The getteachersbycriteria function can be called as the above notation describes. Additionally, the getteachersbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the teacher you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Teacher objects. getteacher Call: object getteacher(int TeacherID) Description: The getteacher function can be called as the above notation describes. Unlike, the getteachersbycriteria function. The TeacherID must be passed in order to find a matching table entry. Return: A row from Teacher table as an object. addteacher Call: int addteacher(object TeacherInfo) Description: The addteacher function can be called as the above notation describes. The addteacher function will add a teacher to the SQL table when invoked. During the call the object of TeacherInfo is required. Return: The TeacherID of the teacher just created, or NULL if unsuccessful. updateteacher Call: boolean updateteacher(object TeacherInfo) Description: By passing the TeacherID and the TeacherInfo, you can call the updateteacher function. The updateteacher function will find the proper teacher by use of the TeacherID and add the new information contained in the object TeacherInfo that was passed. deleteteacher Call: boolean deleteteacher(int TeacherID) Description: When passed the TeacherID, the deleteteacher will search through the table and erase the row corresponding to that TeacherID. Once the teacher has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted teacher information from the weekly sd6 backup file stored offsite. 8

14 Parent Functions The functions below are associated with the Parent table and will allow the programs to retrieve parent information based upon certain search criteria or by a known ParentID. They will also allow the addition of new parents as well as modifying and deleting existing parents. getparentsbycriteria Call: array getparentsbycriteria(object ParentInfo) Description: The getparentsbycriteria function can be called as the above notation describes. Additionally, the getparentsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the parent you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Parent objects. getparent Call: object getparent(int ParentID) Description: The getparent function can be called as the above notation describes. Unlike, the getparentsbycriteria function. The ParentID must be passed in order to find a matching table entry. Return: A row from Parent table as an object. addparent Call: int addparent(object ParentInfo) Description: The addparent function can be called as the above notation describes. The addparent function will add a parent to the SQL table when invoked. During the call the object of ParentInfo is required. Return: The ParentID of the parent just created, or NULL if unsuccessful. updateparent Call: boolean updateparent(object ParentInfo) Description: By passing the ParentID and the ParentInfo, you can call the updateparent function. The updateparent function will find the proper parent by use of the ParentID and add the new information contained in the object ParentInfo that was passed. deleteparent Call: boolean deleteparent(int ParentID) Description: When passed the ParentID, deleteparent will search through the table and erase the row corresponding to that ParentID. Once the parent has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted parent information from the weekly sd6 backup file stored offsite. 9

15 ParentsToStudents Functions These functions will access the ParentsToStudents table and allow the ability to get the students associated with a particular parent. The students are chosen from exiting students in the Students table and the parents are chosen from existing parents in the Parents table. The addition and deletion of students to a particular parent is also supported. getstudentsofparent Call: array getstudentsofparent(int ParentID) Description: When passed the ParentID, the getstudentsofparents function will return the Student objects of all the students who are children of the parent. Return: An array of Student objects. getparentsofstudent Call: array getparentsofstudent(int StudentID) Description: When passed the StudentID the getparentsofstudents function will return an array of Parent objects corresponding to the parents that the student is a child of. Return: An array of Parent objects. deleteparenttostudent Call: boolean deletestudentfromsection(int ParentID, int StudentID) Description: Implemented if you are attempting to remove a ParentToStudent relationship. If either field is set to NULL, then all matches of the other field will be removed. addparenttostudent Call: boolean addstudenttosection(int ParentID, int StudentID) Description: Adds a ParentToStudent relationship. 10

16 Student Functions The functions below are associated with the Student table and will allow the programs to retrieve student information based upon certain search criteria or by a known StudentID. They will also allow the addition of new students as well as modifying and deleting existing students. getstudentsbycriteria Call: array getstudentsbycriteria(object StudentInfo) Description: The getstudentsbycriteria function can be called as the above notation describes. Additionally, the getstudentsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the student you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Student objects. getstudent Call: object getstudent(int StudentID) Description: The getstudent function can be called as the above notation describes. Unlike, the getstudentsbycriteria function. The StudentID must be passed in order to find a matching table entry. Return: A row from Student table as an object. addstudent Call: int addstudent(object StudentInfo) Description: The addstudent function can be called as the above notation describes. The addstudent function will add a student to the SQL table when invoked. During the call the object of StudentInfo is required. Return: The StudentID of the student just created, or NULL if unsuccessful. updatestudent Call: boolean updatestudent(object StudentInfo) Description: By passing the StudentID and the StudentInfo, you can call the updatestudent function. The updatestudent function will find the proper student by use of the StudentID and add the new information contained in the object StudentInfo that was passed. deletestudent Call: boolean deletestudent(int StudentID) Description: When passed the StudentID, deletestudent will search through the table and erase the row corresponding to that StudentID. Once the student has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted student information from the weekly sd6 backup file stored offsite. 11

17 SectionsToStudents Functions These functions will access the SectionToStudents table and allow the ability to get the students associated with a particular section. The students are chosen from exiting students in the Students table and the sections are chosen from existing sections in the Sections table. The addition and deletion of students to a particular section is also supported. getstudentsinsection Call: array getstudentsinsection(int SectionID) Description: When passed the SectionID, the getstudentsinsection function will return an array of Student objects consisting of all the students in the section. Return: An array of Student objects. getsectionsofstudent Call: array getsectionsofstudent(int StudentID) Description: When passed the StudentID the getsectionsofstudent function will return an array of Section objects corresponding to the sections that the student is a member of. Return: An array of Section objects. deletesectionstostudents Call: boolean deletesectionstostudents(int SectionID, int StudentID) Description: Implemented if you are attempting to remove a student from a section. If either field is set to NULL, then all matches of the other field will be removed. addsectionstostudents Call: boolean addsectionstostudents(int SectionID, int StudentID) Description: Adds a student to a section. 12

18 Section Functions The functions below are associated with the Section table and will allow the programs to retrieve section information based upon certain search criteria or by a known SectionID. They will also allow the addition of new sections as well as modifying and deleting existing sections. getsectionsbycriteria Call: array getsectionsbycriteria(object SectionInfo) Description: The getsectionsbycriteria function can be called as the above notation describes. Additionally, the getsectionsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the subject of the section you may omit the subject field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Section objects. getsection Call: object getsection(int SectionID) Description: The getsection function can be called as the above notation describes. Unlike, the getsectionsbycriteria function. The SectionID must be passed in order to find a matching table entry. Return: A row from Section table as an object. addsection Call: int addsection(object SectionInfo) Description: The addsection function can be called as the above notation describes. The addsection function will add a section to the SQL table when invoked. During the call the object of SectionInfo is required. Return: The SectionID of the section just created, or NULL if unsuccessful. updatesection Call: boolean updatesection(object SectionInfo) Description: By passing the SectionID and the SectionInfo, you can call the updatesection function. The updatesection function will find the proper section by use of the SectionID and add the new information contained in the object SectionInfo that was passed. deletesection Call: boolean deletesection(int SectionID) Description: When passed the SectionID, the deletesection will search through the table and erase the row corresponding to that SectionID. Once the section has been erased, there is no method of retrieving it. It may be possible, but not guaranteed, to retrieve deleted section information from the weekly sd6 backup file stored offsite. 13

19 Section Quizzes Functions These functions will access the SectionQuizzes table and allow the ability to get the quizzes associated with a particular section. The quizzes are chosen from exiting quizzes in the Quiz table. The addition and deletion of quizzes to a particular section is also supported. See the Quizzes Functions sections for information on modifying a quiz. getsectionquiz Call: object getsectionquiz (int SectionID) Description: When passed the SectionID, the getsectionquiz function will search through the table and return the Section Quiz objects associated with a SectionID. Return: A row from the Section Quiz table as an object. getsectionquizzesbycriteria Call: object getsectionquizbycriteria(object SectionQuizInfo) Description: The getsectionquizbycriteria function can be called as the above notation describes. Additionally, the getsectionquizbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the date the quiz will be available you may omit that field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of Section objects. deletesectionquiz Call: boolean deletesectionquiz(int SectionQuizID) Description: Implemented if you are attempting to remove a section quiz from a section. addsectionquiz Call: boolean addsectionquiz(object SectionQuizInfo) Description: If an addition of a quiz to a section is necessary, call this function. Be sure to pass all values in the call. A new row will be created in the Section Quiz Table. updatesectionquiz Call: boolean addsectionquiz(object SectionQuizInfo) Description: If an addition of a quiz to a section is necessary, call this function. Be sure to pass all values in the call. A new row will be created in the Section Quiz Table. 14

20 Quiz Records Functions These functions will access the QuizRecords table and allow the ability to get the results of a quiz that a student took. The quizzes are chosen from existing quizzes in the Quiz table and the students are chosen from the existing students in the Student table. getquizrecord Call: object getquizrecord(int QuizRecordID) Description: When passed the QuizRecordID, the getquizrecord function will search through the table and return the row associated with that QuizRecordID. Return: An object of QuizRecordInfo corresponding to a QuizRecordID. getquizrecordsbycriteria Call: array getquizrecordsbycriteria(object QuizRecordInfo) Description: The getquizrecordsbycriteria function can be called as the above notation describes. Additionally, the getquizrecordsbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the Timestamp of the section you may omit the Timestamp field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of QuizRecordInfo objects. deletequizrecord Call: boolean deletequizrecord(int QuizRecordID) Description: Implemented if you are attempting to remove a quiz record. addquizrecord Call: boolean addquizrecord(object QuizRecordInfo) Description: Adds the results of a taken quiz to the database. Be sure to pass all values in the call. A new row will be created in the QuizRecords Table. updatequizrecord Call: boolean updatequizrecord(object QuizRecordInfo) Description: If an update to a quiz record is necessary, call this function. Be sure to pass all values in the call. 15

21 Problems Answered Functions These functions will access the ProblemsAnswered table and allow the ability to get the results of a quiz that a student took. The problems are chosen from existing problems in the Problems table and the quiz records are chosen from existing quiz records in the Quiz Records table. getproblemanswered Call: object getproblemanswered(int ProblemAnsweredID) Description: When passed the ProblemAnsweredID, the getproblemanswered function will search through the table and return the row associated with that ProblemAnsweredID. Return: An object of ProblemAnsweredInfo corresponding to a ProblemAnsweredID. getproblemsansweredbycriteria Call: array getproblemsansweredbycriteria(object ProblemAnsweredInfo) Description: The getproblemsansweredbycriteria function can be called as the above notation describes. Additionally, the getproblemsansweredbycriteria function will allow for fields to be omitted, if your call does not know the information specified. For example, if you are unaware of the correct answer you may omit the Corrent field indicating it is a wildcard. The same can be done for all other parameters. Return: Array of ProblemAnsweredInfo objects. deleteproblemanswered Call: boolean deleteproblemanswer(int ProblemAnswerID) Description: Implemented if you are attempting to remove a problem answer. addproblemanswered Call: boolean addproblemanswered(object ProblemAnswerInfo) Description: Adds the results of an answered problem to the database. Be sure to pass all values in the call. A new row will be created in the ProblemsAnswered Table. updateproblemanswered Call: boolean updateproblemanswered(object ProblemAnswerInfo) Description: If an update to a problem answer is necessary, call this function. Be sure to pass all values in the call. 16

22 Table Definitions This section specifically deals with defining the MySQL tables and the table variables within them. The tables include: Schools, Teachers, Parents, ParentsToStudents, Students, Sections, Administrators, CourseCoordinators, SectionStudents, SectionQuizzes, QuizRecords, and ProblemsAnswered. A description of the Users table can be found in the Authentication and Registration documentation, and a description of the Quizzes, QuizProblems, Problems, ProblemChoices, and Files tables can be found in the quizzing documentation. Each table is listed by name and then the fields are listed with short descriptions of each field and their accepted values. Each table represents a different object, with the same name as the table. To create a new object, you would either call the constructor for that object, or call the setname method where Name is the name of the table field you want to set. In the same way, to retrieve values from an object, you would call the getname method where Name is the name of the table field you want to retrieve. 17

23 Schools Table The schools table will hold information about individual schools. Sections, grades, students, etc. will be tied to schools through this table s SchoolID number. SchoolID The unique ID number of the school. This is used to identify which teachers, students, etc. belong to which school. Name The school s name. Type: String Address The school s address. Type: String City The school s city. Type: String State The school s state. Type: String Zip The school s zip code. Description A short description of the school Type: Text 18

24 Teachers Table The teachers table will hold information about individual teachers. Sections, students, etc. will be tied to teachers through this table s TeacherID number. TeacherID The unique ID number for this teacher. This allows sections to be tied back to individual teachers. SchoolID Which school this teacher belongs to. Username The username used by this teacher to log in. Type: String 19

25 Parents Table The parents table will hold information about the parents of students. ParentID The unique numeric ID assigned to this parent. Username The username used by this parent to log in. Type: String PhoneNumber The phone number of this parent. Type: String 20

26 ParentsToStudents Table The ParentsToStudents table will hold information which students have which parents. This table structure allows for a many-to-many relationship of students to parents (ie, one student can have multiple parents, and one parent can have multiple children). ParentsToStudentsID A unique numeric ID for this parent-child relationship. ParentID The numeric ID of the parent. StudentID The numeric ID of the student. 21

27 Sections Table The sections table will hold information about individual sections. A section is analogous to a class in a school setting; however, the word section was used to avoid ambiguity. SectionID The unique numeric ID of this section. Students, quizzes, and grades can be tied to individual sections by this ID. TeacherID The numeric ID of the teacher teaching this section. Subject The subject of this section. Type: Global: MTSS_sub, Globey_sub, USA_sub Name The name of this section. Type: String Classification The classification (grade) of the students in the section. 22

28 Students Table The school table will hold information about individual students. A student s grades will be tied to back to him or her through this table s StudentID number. StudentID The unique ID number assigned to this student. Grades can be tied back to individual students by this ID number. Username The username used by the student when logging in. Type: String Classification The classification of the student (the grade the student is in). 23

29 Administrators Table The Administrators table will hold information about administrators. AdministratorID The unique ID number assigned to this administrator. SchoolID The ID number of the school to which this administrator belongs. Username The username used by this administrator to log in. Type: String 24

30 Coordinators Table The Coordinators table will hold information about course coordinators. CoordinatorID The unique ID number assigned to this coordinator. SchoolID The ID number of the school to which this coordinator belongs. Subject The subject this coordinator coordinates. Type: Global: MTSS_sub, Globey_sub, USA_sub Username The username used by this coordinator to log in. Type: String 25

31 SectionsToStudents Table The SectionStudents table will hold information about which students are in which sections. This table structure allows for one student to be in multiple sections, and one section to contain multiple students. SectionStudentID A unique ID number for this section-student relationship. StudentID The student s numeric ID. SectionID The numeric ID of the section to which the student belongs. 26

32 SectionQuizzes Table The SectionQuizzes table will hold information about which students are able to take which quizzes. This table structure allows for one student to take multiple quizzes, and one quiz to be taken by multiple students. SectionQuizID A unique ID number for this section-student relationship. QuizID The numeric ID of the quiz. SectionID The numeric ID of the section to which the quiz belongs. DateTimeAvailable The date and time at which this section will be able to take the quiz. Type: String of form 'YYYY-MM-DD HH:MM:SS' DateTimeDue The date and time at which this quiz is due for this section. Type: String of form 'YYYY-MM-DD HH:MM:SS' QuizNumber The number that this quiz will be taken by this section in relation to other quizzes taken in this section. RetryQuiz Whether or not the quiz can be retaken by a student. Type: Boolean 27

33 RetryProblems Whether or not a student can retry a problem. Type: Boolean QuizFeedback Whether or not a student will get feedback once they complete a quiz. Type: Boolean ProblemFeedback Whether or not a student will get feedback once they complete a problem. Type: Boolean 28

34 QuizRecords Table The QuizRecords table will hold information about individual quizzes taken by students. This table structure will allow one quiz to be taken multiple times by the same student. Each time a quiz is taken, an entry is generated in this table. QuizRecordID The unique numeric ID assigned to this instance of a quiz being taken. StudentID The numeric ID of the student that took the quiz. QuizID The numeric ID of the quiz that was taken. SectionID The numeric ID of the section for which this quiz was taken. Timestamp The time and date at which this quiz was taken. Type: String of form 'YYYY-MM-DD HH:MM:SS' PointsAwarded The number of points awarded for this attempt at the quiz. Type: Unsigned Float 29

35 ProblemsAnswered Table The ProblemsAnswered table will hold information about the problems answered on a quiz. ProblemAnsweredID The unique numeric ID assigned to this problem-answer relationship. QuizRecordID The numeric ID of the quiz attempt on which this problem was answered. ProblemChoiceID The choice number chosen for the answer. ProblemID The numeric ID of the problem answered. AnswerGiven The text of the answer given, if not a multiple-choice question. Type: String Correct Whether or not this answer was counted as correct. Type: Bool PointsAwarded The number of points awarded for this answer. Type: Unsigned Float 30

36 Table Diagram This section contains a useful diagram describing the table relationships in the database. This diagram attempts to represent as fully as possible the relationships and fields within each table. 31

37 Conclusion Project Team Information Client Information Ames Community Schools Administrative Offices 1921 Ames High Drive Ames, IA Phone: Faculty Advisor Information Dr. John Lamont 324 Town Engineering Ames, IA Phone: Fax: CprE/EE 492 Member Information Michael Espeland Electrical Engineering 3324 Opal Dr. Ames, IA Professor Ralph Patterson, III 326 Town Engineering Ames, IA Phone: Fax: Sean Howard Computer Engineering 2862 Lincoln Way #3 Ames, IA Anthony Persaud Computer Engineering 4490 Friley Converse Ames, IA CprE/EE 491 Member Information Tim Adkisson Computer Engineering 4733 Toronto St. #101 Ames, IA Kevin Wendzel Computer Engineering 2136 Frederiksen Ct. Ames, IA

38 Summary This document highlights the necessary functions and tables the framework should create in order to provide the other ongoing teams with useful support. Since the sub teams have worked largely independent of each other it was necessary for the framework team to make the library of functions as dynamic as possible, allowing for a greater flexibility. This document will serve as a general guide for the present Ongoing 08 and future Ongoing 08 teams when they are constructing and utilizing the functions explained here in. If functions are found to be unnecessary and not useful to any Ongoing 08 team, it should be removed from this document and from the framework itself. As a reminder, this document is tentative and subject to change within the future. Presently, this is the course for which the framework team (Ongo 08d) will strive for. 33