Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

Library Management System High Level Design Document

Version 1.1

Thursday Team Dated: 2nd April 2002 Authors

Venkat Subramanian Vs4433@albany.edu (Leader) Weiwei Miao Weiweimiao@Hotmail.Com Jiaoheng Meng Mengjj@Hotmail.Com Zhenyu Dai Zhenyud@Hotmail.Com Xiaoyu Zheng Xyz_Bupt@Yahoo.Com.Cn Lanli Yang Lanliyang@Yahoo.Com

Revision History
Date 2 April 2002 9th April 2002
nd

Version 1.0 1.1 First version

Description

Author Design Team Design Team Coding Team Testing Team

Second version: Made changes to GUI section based on review comments during team meeting on 4th April, 2002.

Confidential

CSI 518 : Thursday Team

Page 1

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

Table of Contents 1.
1.2

Introduction...................................................................................................3
Scope........................................................................................................................................3 References....................................................................................................................................................3

2. 3. 4.
4.1

Architectural Representation .....................................................................4 Architectural Goals and Constraints .........................................................5 Use-Case View ..............................................................................................5
Use-Case Realizations.............................................................................................................5

5.
5.1

Logical View .................................................................................................8

Overview..................................................................................................................................8 Class Design Detail.....................................................................................................................................9

6. 7.

Process View ...............................................................................................11 Data View ....................................................................................................16

8.1 Screens:...............................................................................................................................................17

8. User Interface .............................................................................................................17

Confidential

CSI 518 : Thursday Team

Page 2

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

Software Architecture Document

1. Introduction
This document provides a comprehensive architectural overview of the system, using a number of different architectural views to depict different aspects of the system. It is intended to capture and convey the significant architectural decisions which have been made on the system.

1.2

Scope This document outlines : Detailed use case scenarios of key process flows of the application The class model and relationships The sequence diagrams which outline key use case scenarios The data/object model with relational table design User interface style and design

References Requirements Document Ver 1.1 Rational Unified Process Software Architecture Document template

Confidential

CSI 518 : Thursday Team

Page 3

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

2.

Architectural Representation
This section describes what software architecture is for the current system, and how it is represented.

AddNewStudent
(from csi518team)

UpdateDeleteStudent
(from csi518team)

AddBook
(from csi518team)

UpdateDeleteBook
(from csi518team)

SearchBook
(from csi518team)

Librarian
(from csi518team)

CheckInBook
(from csi518team)

CheckOutBook
(from csi518team)

PayLateFee
(from csi518team)

ViewStudentDetails
(from csi518team)

ViewBookDetail
(from csi518team)

Confidential

CSI 518 : Thursday Team

Page 4

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

3.

Architectural Goals and Constraints

This section describes the software requirements and objectives that have some significant impact on the architecture. The key design goals would be : Usability Stability Platform independence 3-Tier design methodologies to enable efficient and responsive system

4.

Use-Case View
This section lists use cases or scenarios from the use-case model which depict significant, central functionality of the final system, or if they have a large architectural coverage.

4.1

Use-Case Realizations

Add New Student :

InsertStudentRecord

Librarian

ViewStudentDetails

VerifyStudent

Failure

Update Delete Student

Failure ViewStudentDetails VerifyStudent

Librarian

UpdateDeleteStudentRecord

Confidential

CSI 518 : Thursday Team

Page 5

Library Management System High Level Design Document

Add Book

Version: 1.0 Date: 2-Apr-2002

Failure

Librarian

ViewBookDetail

AddBookRecord

Update Delete Book

Failure

Librarian

ViewBookDetail

UpdateDeleteBookRecord

Search Book

Confidential

CSI 518 : Thursday Team

Page 6

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

ViewBookDetail Success Librarian EnterSearchParameters DispalySearchResult AddToMyList <<extends>> Failure

ShowMyList <<extends>>

CheckInBook

CheckOutBook

CheckIn Book
<<extends>>

Success Librarian EnterStudentID

PayLateFee

Failure

Checkout Book

Success

Librarian

EnterBookCallNo

EnterStudentID

Failure

Confidential

CSI 518 : Thursday Team

Page 7

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

5.

Logical View

This section describes the architecturally significant parts of the design model, such as its decomposition into subsystems and packages. And for each significant package, its decomposition into classes and class utilities. 5.1 Overview

csi518 team class diagram

Book callNo : String ISBN : String title : String author : String status : String addBook() validate() search() update() delete() checkin() checkout()

Transaction transctionID : String studentID : String callNo : String checkOutDate : Date checkInDate : Date fines : Double update()

Student studentID : String name : String street : String city : String zipCode : String state : String phoneNo : String lateFeeTotal : Double addStudent() validateNewStudent() search() update() delete()

MyList callNo : String addToMyList() deleteFromList() viewList() clearList()

Confidential

CSI 518 : Thursday Team

Page 8

Library Management System High Level Design Document Class Design Detail

Version: 1.0 Date: 2-Apr-2002

Student Class : This class encapsulates all student related operations and details.

Student studentID : String name : String street : String city : String zipCode : String state : String phoneNo : String lateFeeTotal : Double addStudent(studentID, name, street, city, zipCode, state, phoneNo) : Error validateNewStudent() : Integer search(studentID, name) update(name, studentID, street, city, zipCode, state, phoneNo) : Error delete(studentID) : Error

Book Class : This class encapsulates all Book related operations and details.

Book callNo : String ISBN : String title : String author : String status : String addBook(callNo, ISBN, title, author) : Error validate() : Integer search(callNo, ISBN, title, author) update(callNo, ISBN, title, author) : Error delete(callNo) : Error checkin(callNo) : Error checkout(studentID, callNo) : Error

Confidential

CSI 518 : Thursday Team

Page 9

Library Management System High Level Design Document

Transaction Class :

Version: 1.0 Date: 2-Apr-2002

This class encapsulates a single transaction, and maps a student to a book which has been checked out. All associated details of a transaction are also stored in this class (late fees, checkin, checkout dates).

Transaction transctionID : String studentID : String callNo : String checkOutDate : Date checkInDate : Date fines : Double update(transactionID, studentID, callNo, checkOutDate, checkInDate, fines) : Error
MyListClass : This class encapsulates the usecases related to maintaing a temporary subset of user selected books during a search operation.

MyList callNo : String addToMyList(callNo) : Error deleteFromList(callNo) : Error viewList() : Error clearList() : Error

Confidential

CSI 518 : Thursday Team

Page 10

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

6.

Process View

[This section describes the system's decomposition into main sequences of flows.
Add New student

Librarian View student details Add student

Astudent : Student

Validate Error

Update Delete Student

Librarian

Astudent : Student View Student details

Delete student Validate student Delete successfully return error (if delete unsuccessfully)

Confidential

CSI 518 : Thursday Team

Page 11

Library Management System High Level Design Document

Add Book

Version: 1.0 Date: 2-Apr-2002

Librarian

Abook : Book

View book details Add the book Error

Update/Delete Book

Librarian View book details

Abook : Book

Delete the book Delete successfully Return error if delete unsuccessfully

Confidential

CSI 518 : Thursday Team

Page 12

Library Management System High Level Design Document

Search Book

Version: 1.0 Date: 2-Apr-2002

Librarian Enter search parameters

System : System

Abook : Book

Search search result Display search result

View book details Add to my list View my list display my list Error (if operated unsuccessfully)

Ceck In Book

Librarian

Atransction : Transction

Check in ( StudentID, Book) Validate CheckIn

Compute latefine Check in successfully Error

Confidential

CSI 518 : Thursday Team

Page 13

Library Management System High Level Design Document

Checkout Book

Version: 1.0 Date: 2-Apr-2002

Librarian : Librarian

Atransaction : Transction

Check out (StudentID, Book call#) validate checkout Check out successfully Error

ViewBookDetail

Librarian

Abook : Book

View book details display book details

Confidential

CSI 518 : Thursday Team

Page 14

Library Management System High Level Design Document

ViewtudentDetails

Version: 1.0 Date: 2-Apr-2002

Librarian

AStudent : Student View student details display student details

Confidential

CSI 518 : Thursday Team

Page 15

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

7.

Data View

A description of the persistent data storage perspective of the system.

T_Student studentID : VARCHAR(255) name : VARCHAR(255) street : VARCHAR(255) city : VARCHAR(255) zipCode : VARCHAR(255) state : VARCHAR(255) phoneNo : VARCHAR(255) lateFeeTotal : DOUBLE(64) <<PK>> PK_T_Student0()

<<Non-Identifying>> 1
1

0..*

T_Transaction transctionID : VARCHAR(255) studentID : VARCHAR(255) callNo : VARCHAR(255) checkOutDate : TIMESTAMP checkInDate : TIMESTAMP fines : DOUBLE(64) COL_0 : VARCHAR(255) COL_1 : VARCHAR(255) <<PK>> PK_T_Transactio1() <<FK>> FK_T_Transactio1() <<FK>> FK_T_Transactio0() <<Index>> TC_T_Transactio3() <<Index>> TC_T_Transactio1()

<<Non-Identifying>>

0..*

T_Book callNo : VARCHAR(255) ISBN : VARCHAR(255) title : VARCHAR(255) author : VARCHAR(255) status : VARCHAR(255) <<PK>> PK_T_Book2()

T_MyList callNo : VARCHAR(255) <<PK>> PK_T_MyList3()

Confidential

CSI 518 : Thursday Team

Page 16

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

8.

User Interface
This section provides the key user screen views and their relationships with the process. Note: N1 N2 : After press N1 button, N2 window will pop out.

If there is no comment for a button, the window which contains the button will be closed after it is pressed. 8.1 Screens:

Start Main Menu

M a in M e n u

L ib r a r y M a n a g e m e n t S y s te m
A d d N e w B o o k (1 6 ) A d d N e w S tu d e n t ( 1 7 ) U p d a te /D e le te S tu d e n t (2 2 ) C h e c k -o u t B o o k (2 1 )

U p d a te /D e le te B o o k ( 1 8 )

C h e c k -in B o o k (2 0 )

S e a r c h fo r B o o k ( 1 9 )

V ie w s tu d e n t D e ta il ( 2 3 )

16 64; 17 7; 18 68; 19 2; 20 13; 21 13; 22 9; 23 11; (Note : A command button to view saved list may be provided)

Confidential

CSI 518 : Thursday Team

Page 17

Library Management System High Level Design Document

W in d o w ( 2 ) - - S e a r c h B o o k

Version: 1.0 Date: 2-Apr-2002

A u th o r : T itle : IS B N :

B ru c e E c k e l T h in k in g in J a v a 0 -1 3 -0 2 7 3 6 3 -5
R e s e t (2 5 ) C a n c e l (2 6 )

S u b m it (2 4 )

24 succeed 3; 24 failure 77; 25 2; 26 1;

W in d o w ( 3 ) - - S e a r c h R e s u lt

P re vio u s P a g e

N e xt P a g e

Page #

go

S e le c t

C a ll #

IS B N

T it le

A u th o r

C o p ie s

B a c k to M a i n ( 2 7 ) V ie w D e ta il( 2 9 ) U p d a te ( 3 3 ) A d d to L is t ( 3 0 ) D e le te ( 3 4 )

N e w S e a rc h (2 8 ) V ie w L is t (3 1 ) C h e c k -in (3 5 ) C le a r L is t (3 2 ) C h e c k -o u t (3 6 )

28 2; 29 4; 30 3; 31 5; 32 3; 33 69; 35 13; 36 13; Confidential CSI 518 : Thursday Team Page 18

Library Management System High Level Design Document

W in d o w ( 4 ) - - V ie w B o o k 's D e t a il in f o r m a t io n

Version: 1.0 Date: 2-Apr-2002

C a ll #

IS B N

T it le

A u th o r

C o p ie s

S ta tu s

D u e D a te

B o rro w e d b y

A d d to L is t ( 3 7 )

C h e c k -in (3 8 )

C h e c k -o u t (3 9 )

B a c k to S e a r c h R e s u lt ( 4 0 )

37 5; 38 13; 39 13; 40 3;

W in d o w ( 5 ) - - M y L is t

B o o k lis t fo r : Y o u r N a m e
S e le c t C a ll # IS B N T it le A u th o r C o p ie s S ta tu s D u e D a te B o rro w e d b y
C h e c ko u t D a te

R e m o v e fr o m L is t (4 1 )

C h e c k -in (4 2 )

C h e c k -o u t (4 3 )

B a c k to S e a r c h R e s u lt ( 4 4 )

41 list after removing, 5; 42 13; 44 3; (Note : As librarian is the only intended user, and the name records are not maintained for brevity, the screen title need not show current logged in user.)

Confidential

CSI 518 : Thursday Team

Page 19

Library Management System High Level Design Document

W in d o w ( 7 ) - - A d d n e w s t u d e n t s

Version: 1.0 Date: 2-Apr-2002

ID /S S N N am e A d d re s s C ity S ta te Z IP Phone

123456789 X ia o y u Z h e n g 4 0 S . M a in A v e . A lb a n y NY 12208 1 234 567 8900

S u b m it (4 6 )

C a n c e l (4 7 )

W in d o w ( 9 ) - - U p d a t e /D e le t e a s t u d e n t

ID /S S N

123456789
D e le te ( 4 9 ) C a n c e l (2 6 )

U P d a te ( 4 8 )

48 12
W in d o w ( 1 1 ) - - S e a r c h a s t u d e n t

ID /S S N N am e S e a rc h (5 1 ) C a n c e l (5 0 )

51 12;

Confidential

CSI 518 : Thursday Team

Page 20

Library Management System High Level Design Document

W in d o w ( 1 2 ) - - S e a r c h S t u d e n t s r e s u lt

Version: 1.0 Date: 2-Apr-2002

S e le c t

ID

Nam e

A d d re ss

Phone

V i e w D e ta il( 5 3 )

U p d a te ( 5 4 )

D e le te ( 5 5 )

C a n c e l (5 6 )

53 60;

W in d o w ( 1 3 ) - - C h e c k in /o u t b o o k s

ID /S S N C a ll # C a ll # C a ll # C a ll # C a ll # C a ll # C h e c k in (6 1 )

123456789 123456789 123456789 123456789 123456789 123456789 123456789

C h e c k o u t( 6 2 ) C a n c e l (6 3 )

Note : There could be a max. of 10 books issuable by user. This screen may provide a max of 10 rows of call number text input fields.

Confidential

CSI 518 : Thursday Team

Page 21

Library Management System High Level Design Document

W in d o w ( 1 4 ) - - A d d a n e w b o o k

Version: 1.0 Date: 2-Apr-2002

IS B N T i tl e A u th o r

123456789 123456789 123456789

C a n c e l (6 6 )

A d d (6 5 )

W in d o w ( 6 0 ) - - V ie w s t u d e n t s ' d e t a il in f o r m a t io n

ID /S S N N am e A d d re s s C ity S ta te Z IP Phone

123456789 X ia o y u Z h e n g 4 0 S . M a in A v e . A lb a n y NY 12208 1 234 567 8900 C a ll # T it le

H o ld b o o k s C O d a te D u e d a te F in e s

T o ta l F in e s

D e l e te ( 5 8 )

B a c k to M a in ( 5 9 )

W in d o w ( 6 8 ) - - U p d a t e /D e le t e a b o o k

C a ll #

123456789
D e le te ( 7 1 ) C a n c e l (7 2 )

U P d a te ( 7 0 )

70 69;

Confidential

CSI 518 : Thursday Team

Page 22

Library Management System High Level Design Document

W in d o w ( 6 9 ) - - U p d a t e t h e b o o k

Version: 1.0 Date: 2-Apr-2002

C a ll # T i tl e A u th o r IS B N

1 2 3 4 5 6 7 8 9 (u n c h a n g e d ) T h in k in J a v a B ru c e E c k e l 123456789
C a n c e l (7 4 )

U p d a te ( 7 3 )

W in d o w ( 7 7 ) - - D is p la y E r r o r

E rro r!
Error M e s s a ge

OK

W in d o w ( 7 8 ) - - D is p la y S u c c e s s

S u c c e s s fu l !
O p e r a t io n in f o r m a t io n

OK

Confidential

CSI 518 : Thursday Team

Page 23

Library Management System High Level Design Document

Version: 1.0 Date: 2-Apr-2002

Confidential

CSI 518 : Thursday Team

Page 24