UMS Design Document

University Student Management System Due Calculation Design Document

Page 1

UMS Design Document

1. Purpose
The document illustrates the design of due calculation module.

2. For the Associates:

Associates should refer the following documents to understand the screen design and the high level design. CaseStudyScreenDesign.doc Ilustrates the screen design the associates to follow for developing the application. CaseStudyMasterDesign.docx Ilustrates the class hierarchy, flow sequence , packaging details and exception handling mechanism for developing the application.

3. Database Design
Table Name BRANCH_MASTER Column Name BRANCH_CODE BRANCH_NAME Column Discription Column is used for storing branch code Column is used for storing the branch names Column is used for storing the Fees Column used for storing the caution deposit Data Type char varchar2 Data Size 3 12 Primary Key Yes No

FEES CAUTION_DEPOSIT

number number

(7,2 ) (8,2)

Table Name STUDENT _INFO

Column Name

Column Discription

Data Type

Data Size 10

Primar y Key Yes

Foreign Key

REG_NUMBER

STUDENT_NAME BRANCH_CODE

Column is used for storing student register number Column is used for storing student name Column is used for storing the students branch code Column is used for storing the year in which the student passes twelfth Column is used for storing the marks obtained by the student in twelfth Column is used for storing whether the students is an NSS cadet

number

varchar2 char

25 3

No No Yes Branch_ Master

YEAR_PASSING_TW ELFTH

number

TWELFTH_MARKS

number

(5,2)

NSS_CADET

char Values can be Y or N

Page 2

UMS Design Document

FEES Column is used for storing the fees payable by the student Column for storing the caution deposit Column for storing the date of birth of the student number (7,2)

CAUTION_DEPOSIT DATE_OF_BIRTH

number Date

(8,2)

Table Name STUDENT _RESULT

Column Name REG_NUMBER

Column Discription Column is used for storing student register number Column is used for storing the grade of the student Column is used for storing the eligibility of scholarship
Column for storing the semester for which the result is published Column Discription Column is used for storing the category in which due is payable. Values are 1. Attendance 2. Fees 3. Infra Column used for storing the due amount payable for the category.

Data Type number

Data Size 10

Primary Key Yes

STUDENT_GRADE

char

No

Foreign Key Yes (STUDEN T_INFO) No

IS_ELIGIBLE_SCHOL ARSHIP
SEMESTER

char

No

No

char

Table Name OTHER_DUE_ MASTER

Column Name CATEGORY

Data Type Varchar2

Data Size 10

Primary Key YES

Foreign Key

DUE_AMOUNT

Number

Table Name DUE_DETAILS

Column Name

Column Discription Column is used for storing the register number of the student Column is used for storing the due amount Column used for storing the mode if the amount is refundable to the student or if the student should be pay the amount. Values should be payable and refund

Data Type Number

Data Size

REG_NUMBER
DUE_AMOUNT MODE

Primary Key YES

Foreign Key Yes Student_Inf o

Number Varchar2 10

Page 3

UMS Design Document

4. Required Objects, Services, and Libraries

4.10 Value Objects:
Value Object Name DuesVO StudentDueVO Value Object Description This VO is used for storing the due details and transferring from front end to back end. This VO is used to get the details of a students due from the system and display it to the user

5. Technical Specifications
Publish Result screen:
system.
Data Element Control type Textbox Dropdown Default Values No No Edita ble Field Yes No Restrictions Mandatory/ Non Mandatory Mandatory Mandatory Data Type number char Data Size 10 3

This screen is used by admin to enter the marks into the

Register Number Branch

Only Numbers Values should be from the branch_ master table A date picker should be provided to select the date of birth. The date selected must appear in the text box Only Positive numbers or zero Only Positive numbers or zero Only Positive numbers or zero Only Positive numbers or zero Yes/No Three Options 1. Attendance shortage 2. Delay in Fee 3. Damage to infra Only Positive numbers or zero

Date of birth

Text Box

No

No

Mandatory

Date

Number of Library Books Lost Number of Library Books Damaged Transportation Due Hostel Due Laboratory Due Other Due

Text Box

No

Yes

Mandatory

number

Text Box

No

Yes

Mandatory

number

Text Box Text Box Radio Button Check Box

No No No No

Yes Yes Yes No

Mandatory Mandatory Mandatory Non Mandatory

number number number number

6 6 6 6

Common Due

Text Box

No

Yes

Page 4

UMS Design Document

On success a message should be displayed The Due Amount Payable is <amount> must be <Paid>/<Refunded> based on whether the amount needs to be paid by the student or will be refunded to the student.

View Due Screen : This is a pop screen which accepts a register number and displays
the due details if available in the system.
Data Element Control type Textbox Default Values No Edita ble Field Yes Restrictions Mandatory/ Non Mandatory Mandatory Data Type number Data Size 10

Register Number

Only Numbers

Application Components Specification:

Refer to the sequence and class diagram in the master design document for details on the components hierarchy, how they structured and integrated.
Component Name UniversityCalcula teDueDelegate UniversityCalcula teDueDelegate UniversityLocator Method Name calculateDue Method input DueVO Method Output StudentDueVO Description This method invokes the facades and throws University and University business Exception. This method invokes the facades and throws University and University business Exception. Method used for locating the appropriate faade based on the input name and return the object. Throws UiversityException when any runtime error occurs. Method invokes the appropriate BOs and returns the value to the screens. Handles exceptions , logs it and throws it back to the presentation tier. Method invokes the appropriate BOs and returns the value to the screens. Handles exceptions , logs it and throws it back to the presentation tier. Method performs validations , calculates the due,stores into the system and returns the due payable by the student. Throws university and university business exception. This methods checks if the entered student is registered in the system for the entered branch and his/her date of birth in the system is same as the entered value. If found return true. Else Return false Gets the caution deposit amount paid by the student Algorithm Not applicable

getDue

int registerNumber Faade name

StudentDueVO

Not applicable

locate

Faade Object

Not applicable.

UniversityCalcula teDueFacade

calculateDue

DueVO

StudentDueVO

Not applicable.

UniversityPublish ResultFacade

getDue

int registerNumber

StudentDueVO

Not applicable.

DueBO

calculateDue

DueVO

StudentDueVO

DueDAO

checkStudent

int registerNumber, String branch,Date dob

Boolean

Refer to section 6 for fee calculation details and the validations to be done. NA

DueDAO

getCautionDepo sit

int registerNumber

int

NA

Page 5

UMS Design Document

DueDAO DueDAO DueDAO getFees isExists addDues int registerNumber int registerNumber DueVO int Boolean Boolean Gets the fees amount paid by the student Checks if the due details for the student already exist in the system Used to insert the due details into the system if the details does not exist for the particular student. Called if the isExists() method returns false Used to update the due details into the system if the details already exist for the particular student. Called if the isExists() method returns true This method gets the due rates for all the sorts of due which falls in the category other due which are attendance shortage,delayed fees payment and damage to infra. This method shuld load values from the OTHER_DUE_MASTER table and load the values to a HashMap with the category and due rate as key and value respectively. This method is used to delete the result of the student for the entered semester. The method should be called only if the deleteMarks method returns true This method is used to check if the student that the results for the student are available for all the eigth semesters and in none of the semester his grade is F This method retrieves the retrieves the due details with the entered register number. NA NA NA

DueDAO

updateDues

DueVO

Boolean

NA

DueDAO

getDueRates

Map

DueDAO

deleteResult

int registerNumber, String semester

Boolean

DueDAO

isCourseCompl eted

int registerNumer

boolean

DueDAO

getDues

int registerNumber

StudentDueVO

6. Algorithms
6.1 Validations
If student details not found for the entered register number and branch throw business exception with error code 600 If the results are not available for all the semesters or if the students grade is F in any of the semesters throw business exception with error code 601 If non numeric values entered into the due fields throw business exception with error code 602 If any of the marks is negative or greater than 100 throw business exception with error code 553 All fields are mandatory

Page 6

UMS Design Document

6.2 Due Calculation

Step 1 : Calculate the total dues in library(DL) which is the sum of dues resulting from book loss and book damage. The dues are calculated as per the table below Category Number of Books Amount/Book Damaged <=2 100 Damaged >2 200 Lost <=2 1000 Lost >2 2000 Step 2 : Calculate the laboratory Due(Dlab) The laboratory dues for any damages or loss in the laboratory is calculated as 50% of the caution deposit paid by the student. Step 3 : The dues in transport(Dt) and hostel(Dh) are accepted from the user Step 4: Calculate the due in the Other Dues (Dother) section. This can be calculated using the getDueRates() DAO method which returns a Map object containing the due rates for all the three due types under other dues. Retrieve the due rates for each type from the map object. The due amount is calculated as x% percentage of the fees paid by the student where x is the due rate for a particular type. Step 5: Check if there are any common fine for the batch.If the student secured A grade in the final semester,then he/she is exempted from paying the common fine.

6.2.1 Student Registration

Step 1 : Perform all the business validation Step 2 : Calculate the dues. Step 3: Load the details into the system.

Page 7