Updated DB Models as reqested in #57

Author: mbillow

conditional/models/docs.md

@@ -3,13 +3,17 @@
 ## FreshmanAccount table ##
 This table stores the basic metadata associated with a freshman before they pass
 their 10-week evaluation.
+
 * `id`: Autoincrementing primary key.
 * `name`: The freshman's name
 * `eval_date`: The date of the freshman's 10-week evaluation
+* `onfloor_status`: Tracks whether they have been granted on-floor status.
+* `signatures_missed`: Allows for members who do not get an account to have their missed signatures tracked.
 
 ## FreshmanEvalData table ##
 This table stores the evaluations data for freshmen before they pass their
 10-week evaluations.
+
 * `id`: Autoincrementing primary key.
 * `uid`: The freshman's LDAP uid (if they pass their packet)
 * `freshman_project`: Their status on the freshman project (pending, passed,
@@ -19,9 +23,12 @@ This table stores the evaluations data for freshmen before they pass their
   evals form)
 * `other_notes`: Any other notes the freshman has attended (part of the fall
   evals form)
+* `freshmen_eval_result`: The result of introductory evaluations.
+* `active`: Determines whether the freshman account is currently active / displayed.
 
 ## CommitteeMeeting table ##
 This table stores a list of committee meetings.
+
 * `id`: Autoincrementing primary key.
 * `committee`: The committee the meeting belongs to.
 * `timestamp`: The date and time of the meeting.
@@ -30,13 +37,15 @@ This table stores a list of committee meetings.
 ## MmeberCommitteeAttendance table ##
 This table stores attendance for committee meetings for full members (i.e.
 non-freshmen).
+
 * `id`: Autoincrementing primary key.
 * `uid`: The LDAP uid (i.e. username) of the member who attended the meeting
 * `meeting_id`: Foreign key referencing the meeting that was attended
   (`committee_meetings.id`)
 
 ## FreshmanCommitteeAttendance table ##
 This table stores attendance for committee meetings for freshmen.
+
 * `id`: Autoincrementing primary key.
 * `fid`: Foreign key referencing the freshman account for the freshman who
   attended (`freshman_accounts.id`).
@@ -45,19 +54,22 @@ This table stores attendance for committee meetings for freshmen.
 
 ## TechnicalSeminar table ##
 This table stores a list of technical seminars.
+
 * `id`: Autoincrementing primary key.
 * `name`: The name of the seminar
 * `active`: Whether or not the seminar applies to the current year.
 
 ## MemberSeminarAttendance table ##
 Stores seminar attendance for full members.
+
 * `id`: Autoincrementing primary key.
 * `uid`: The LDAP uid of the member who atended the seminar
 * `seminar_id`: Foreign key referencing the seminar attended
   (`technical_seminars.id`)
 
 ## FreshmanSeminarAttendance table ##
 Stores seminar attendance for freshmen.
+
 * `id`: Autoincrementing primary key.
 * `fid`: Foreign key referencing the freshman who attended the seminar
   (`freshman_accounts.id`)
@@ -66,14 +78,17 @@ Stores seminar attendance for freshmen.
 
 ## MajorProject table ##
 Stores major projects through their entire lifetime.
+
 * `id`: Autoincrementing primary key.
 * `uid`: LDAP uid of the member the project belongs to
 * `name`: Name of the major project
 * `description`: Description of the project
 * `status`: Status of the project (pending, passed, failed)
+* `active`: Determines if the project is relevent to the current evaluations period.
 
 ## HouseMeeting table ##
 Stores occurrences of house meeting.
+
 * `id`: Autoincrementing primary key.
 * `date`: Date the meeting occurred
 * `active`: Whether or not the meeting applies to the current year
@@ -82,31 +97,72 @@ Stores occurrences of house meeting.
 Stores house meeting attendance data for full members. If a member does not have
 an entry for a given house meeting, that means they were not required to attend
 that house meeting.
+
 * `id`: Autoincrementing primary key.
 * `uid`: LDAP uid of the member the attendance record is for
 * `meeting_id`: Foreign key referencing the house meeting attended
   (`house_meetings.id`)
+* `excuse`: Reason for not attending.
+* `attendance_status`: Differenciates between storing an absent, excused, or present status.
 
 ## FreshmanHouseMeetingAttendance table ##
 Stores house meeting attendance data for freshmen.
+
 * `id`: Autoincrementing primary key.
 * `fid`: Foreign key referencing the freshman the attendance record is for
   (`freshman_accounts.id`)
 * `meeting_id`: Foreign key referencing the house meeting attended
   (`house_meetings.id`)
+* `excuse`: Reason for not attending.
+* `attendance_status`: Differenciates between storing an absent, excused, or present status.
 
 ## CurrentCoops table ##
 Used to store members who are inactive and on co-op, to distinguish them from
 members who are inactive but could potentially become active later in the
 semester/year.
+
 * `id`: Autoincrementing primary key.
 * `username`: LDAP uid of the member on coop.
+* `active`: Is the co-op still in progress?
+
+## OnFloorStatusAssigned table ##
+When members are granted on-floor status plays a role in how they are ranked in the housing queue, making it important to store this information.
+
+* `uid`: LDAP uid of the member.
+* `onfloor_granted`: Date of on-floor vote.
+
+## Conditional table ##
+Conditional, so we can store conditionals on Conditional.
+
+* `id`: Autoincrementing primary key.
+* `uid`: LDAP uid of the member in the conditional
+* `date_created`: Date conditional assigned.
+* `date_due`: Date conditional has to be completed by.
+* `active`: Whether or not the conditional is currently relevent. 
+* `status`: Current completion status of the task assigned.
+
+## SpringEval table ##
+Records the yearly results of member's spring evaluations.
+
+* `id`: Autoincrementing primary key.
+* `uid`: LDAP uid of the member being evaluated.
+* `active`: Is this evaluation for the current year?
+* `date_created`: The date of the evaluation.
+* `status`: Result of the evaluation.
+
+
+
 
 ### Member state ###
-* ldap:active = 0; ldap:alumni = 1: Alumni. Don't track attendance.
-* ldap:active = 0; ldap:alumni = 0; in coop table: On coop. Track committee
+* Not in LDAP Current Student group: 
+  * Alumni. Don't track attendance.
+* In LDAP Current Student group and in Co-Op Table: 
+  * On coop. Track committee
   meeting attendance, but not house meeting.
-* ldap:active = 0; ldap:alumni = 0; not in coop table: Present but not active
+* In LDAP Current Student group but not in LDAP Active Group: 
+  * Present but not active
   yet. Track attendance as normal.
-* ldap:active = 1; ldap:alumni = 0: Active member. Track attendance as normal.
-* ldap:active = 1; ldap:alumni = 1: Invalid. Should not occur.
+* In LDAP Current Student group and in LDAP Active group: 
+  * Active member. Track attendance as normal.
+* In LDAP Active group but not in LDAP Current Student Group: 
+  * Invalid. Should not occur.