SetFocus Library Project Documentation

Table of contents ,[object Object]

SetFocus Project #2 – Library Phase 1Page 4

SetFocus Project #5 – Library Phase 4Page 23SetFocus Project #1 – .NET Framework Objective Build parts of the business tier for a retail company, consisting of two assemblies; Foundation and AppTypes. Summary This project demonstrates fundamental .NET skills and interaction between a n‐tiered application. A list of C# / .NET skills used in this project: • Delegates, events• Custom exception/attribute classes • Custom EventArgs classes• Event logger and collection classes • Generic Collections• Custom Serializations • Binary & SOAP Formatters• Abstract classes & interfaces • Enumerations• Properties • Custom Enumerators Implementation of ISerializable, IComparer, IComparable & IList<T> interfaces Foundation Assembly This assembly contains the foundation interfaces and base classes used throughout the project. SetFocus Project #1 – .NET Framework AppTypes Assembly This assembly contains various entity, collection, and exception classes used by the business. SetFocus Project #2 – Library Phase 1 Objective Create a Windows Forms‐based front‐end application that will provide a librarian with a visual interface through which librarian functions are performed. Required functionality included adding new members (adult and juvenile) and checking books in and out. Summary This project demonstrates the use of .NET windows form development techniques. Some of the techniques used include: • User input validation and feedback using error providers • Data binding to a gridview control and manipulation of the control • Incorporate n‐tier architecture for scalability • Create a user interface that is intuitive and requires minimal training • Effective error and exception handling. • Use of regular expressions for input validation. DescriptionTo make the interface as intuitive as possible, all functions were accessed through the menu.The code behind the user interface (HU.LibraryWinClient) handled all the input validations, screen changes, and contained the logic to perform each operation.The Business Layer (HU.LibraryBusiness) provided the connection between the UI and the library of data access functions. In this project, all book information, member records, loan records, etc. are all stored on SQL Server 2008. Access to the database occurred through a Data Access Layer, which was provided as a precompiled DLL for the project.The UI does not know how the data is accessed or retrieved. If changes are needed to how data is accessed, the front‐end does not need to be modified, providing for scalability. SetFocus Project #2 – Library Phase 1 BusinessLayer source code using System; using System.Collections.Generic; using System.Linq; using System.Text; using HU.LibraryEntities; using HU.LibraryDataAccess; namespace HU.LibraryBusiness { public class BusinessLayer { public BusinessLayer() { } public Member GetMemberInformation(short memberId) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the GetMember() method and pass in a member id Member myMember = lda.GetMember(memberId); // return the retrieved member return myMember; } public Item GetItemInformation(Int32 isbn,Int16 copyNumber) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the GetItem() method and pass in a isbn and Copy number Item myItem = lda.GetItem(isbn,copyNumber); // return the retrieved item return myItem; } public short GetLastCopyNumner(Int32 isbn) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the GetLastCopy() method and pass in a isbn short lastCopyNumner = lda.GetLastCopy(isbn); // return the retrieved item return lastCopyNumner; } public HU.LibraryEntities.ItemsDataSet GetOutstandingLoans(short memberId) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda=new HU.LibraryDataAccess.DataAccess(); // Call the GetIItems() method and pass in a member id HU.LibraryEntities.ItemsDataSet myItemsDataSet = lda.GetItems(memberId); return myItemsDataSet; } public void AddAdultMember(AdultMember member) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the AddMember() method and pass in an Adult member lda.AddMember(member); } public void AddJuvenileMember(JuvenileMember member) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the AddMember() method and pass in an Juvenile member lda.AddMember(member); } public void AddItemNumber(Item item) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the AddItem() method and pass in isbn lda.AddItem(item); } public void CheckOut(string memberNumberText, string isbnText, string copyNumberText) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the CheckOutItem method and pass in memberId,isbn,copyNumber short memberNumber = short.Parse(memberNumberText); Int32 isbn = Int32.Parse(isbnText); short copyNumber = short.Parse(copyNumberText); lda.CheckOutItem(memberNumber, isbn, copyNumber); } public void CheckIn(string isbnText, string copyNumberText) { // Create a library data access object HU.LibraryDataAccess.DataAccess lda = new HU.LibraryDataAccess.DataAccess(); // Call the CheckInItem method and pass in isbn,copyNumber Int32 isbn = Int32.Parse(isbnText); short copyNumber = short.Parse(copyNumberText); lda.CheckInItem(isbn, copyNumber); } } } SetFocus Project #2 – Library Phase 1 Functionality Details Add Adult – First and Last name, Street, City, State, and Zip Code are mandatory. Middle Initial and phone number are optional. Add Juvenile – First and Last name, Birth Date, and Sponsoring Adult Member ID are required. Middle Initial is an optional field. Rules implemented while adding and displaying a member: • The first and last name fields could only contain 15 alphabetic characters. The first letter was required to be uppercase and the remaining characters must be lowercase. • The middle initial, while optional, was required to be a single uppercase letter. • The Street and City fields could be no more than 15 characters. • The State field had to be two uppercase letters. The dropdown was populated from a XML file. • The Zip Code had to be a ##### or #####-#### where # is a number (0-9). • The phone number had to be in the (###)###-#### format when supplied. • Birth Date had to be a valid date falling within the 18 year period ending on the current date. • Sponsoring Adult Member ID had to reference a valid adult member already in the database. • Each member could only have 4 books checked out at a time. Checking out a book also required that the member’s expiration date be in the future. • If a book was to be checked out, but the database indicated that it was already on loan, the librarian was prompted if they wanted to check the book in first. • All functions like check in book, check out book, and canceling the addition of a new member provided a method for the librarian to cancel the operation. SetFocus Project #2 – Library Phase 1 Screenshots: Main Menu Member Information SetFocus Project #2 – Library Phase 1 Screenshots ( continued ): Check Out Check In SetFocus Project #3 – Library Phase 2 Objective Library Phase 1 created the UI layer for a library management system. This project created the Data Access layer and SQL Server Stored Procedures for the library application to replace the ones provided for Phase 1. In addition to Phase 1’s functionality, Phase 2 added “Add Item” menu to add new books. Summary This project demonstrates the use of ADO.NET and Transact‐SQL to access a SQL Server 2008 database. Some of the techniques used include: • Create and implement the Entities classes used in the library project • Data validation in SQL • Stored procedures in Transact‐SQL (T‐SQL) on SQL Server 2008 • Implementing error handling in SQL • Accessing stored procedures through System.Data.SqlClient • Retrieve and process result sets returned from stored procedures • Process errors raised by T‐SQL in ADO.NET • Write a T‐SQL script to test Stored Procedures for functionality • Create and utilize strongly typed datasets based on stored procedures. DescriptionThe goal of this project was to recreate the DLLs provided during Phase 1.HU.LibraryEntities contained the various classes and enumerations referenced by the entire project. It contains the AdultMember,JuvenileMember, Member, Item, LibraryException classes as well the ErrorCode enumeration. It also contains the strongly typed ItemsDataSet dataset.The HU.LibraryDataAccess project provided the layer between theBusiness layer and the database. The UI (user interface) layer made requests to the LibraryBusiness layer, which in turn made the request of the Data Access layer. The Data Access layer executes the appropriate SQL Server database stored procedures through ADO.NET code. The connection string was stored at the project level, which means that it only needs changed ONCE.As long as the DataAccess layer returns the expected objects, theBusiness and UI layers do NOT need modifying. These layers were only modified was to add functionality and change from the SetFocus provided DLLs from phase 1. This provides for scalability and flexibility on the database server. SetFocus Project #3 – Library Phase 2 This diagram shows the tables and their relationships in the Library database used in this project. SetFocus Project #3 – Library Phase 2 Stored ProceduresSeveral stored procedures were created during this phase of the project. The majority were to duplicate the results from Phase 1.The dbo.AddItem procedure supports the additional functionality added during Phase 2.Each stored procedure contained the same validation on data as the other layers of the project.The GetMemberByISBNCopy stored procedure called the GetMemberByMemberID procedure to return the member records to the Data Access layer. This simplifies code modification by requiring change to a single stored procedure and a single Data Access method to change the data. As part of Phase 2, to test the stored procedures T-SQL scripts was created. The scripts include code for passing and failure of procedures. Each stored procedure attempted to make the select statements returning information to the data access layer as efficient and compact as possible. The AddAdult stored procedure is below. USE [library] GO -- ================================================================== -- Author: Harmik Uchian -- Create date: 01/21/2010 -- Description: Adds a row in the Member and Adult -- ================================================================== -- Errors raised: -- -- Message Severity State --'Last Name is missing',11,1 --'Name is missing',11,2 --'Street is missing',11,3 --'City is missing',11,4 --'State is missing',11,5 --'Zip is missing',11,6 --'Last Name must contain 1 - 15 chracters',11,7 --'First Name must contain 1 - 15 chracters',11,8 --'Middle Initial must contain 1 chracter',11,9 --'Street must contain 1 - 15 chracters',11,10 --'City must contain 1 - 15 chracters',11,11 --'State must contain 1 - 15 chracters',11,12 --'Zip Code must contain 5 - 10 chracters',11,13 --'Telephone must contain less than 13 chracters',11,14 -- ================================================================== SetFocus Project #3 – Library Phase 2 AddAdult stored procedure ( continued ) CREATE proc [dbo].[AddAdult] -- ================================================================== -- Parameters: -- Name Type @lastname varchar(15) =null, @firstname varchar(15) =null, @middleinitial char(1) =null, @street varchar(15) =null, @city varchar(15) =null, @state char(2) =null, @zip char(10) =null, @phone_no char(13) =null, @expiration_date datetime =null, -- ================================================================== --Output variables @member_no smallint output As -- ================================================================== -- validate params If @lastname is null BEGIN RAISERROR ('Last Name is missing',11, 1) return -1 END If @firstname is null BEGIN RAISERROR ('First Name is missing',11, 2) return -1 END If @street is null BEGIN RAISERROR ('Street is missing',11, 3) return -1 END If @city is null BEGIN RAISERROR ('City is missing',11, 4) return -1 END If @state is null BEGIN RAISERROR ('State is missing',11, 5) return -1 END If @zip is null BEGIN RAISERROR ('Zip is missing',11, 6) return -1 END -- additional validation - Check for empty string or zero value IF LEN(@lastname) > 15 OR LEN (@lastname) < 1 BEGIN RAISERROR ('Last Name must contain 1 - 15 chracters',11,7) RETURN -1 END SetFocus Project #3 – Library Phase 2 AddAdult stored procedure ( continued ) IF LEN(@firstname) > 15 OR LEN (@firstname) < 1 BEGIN RAISERROR ('First Name must contain 1 - 15 chracters',11,8) RETURN -1 END IF LEN(@middleinitial) > 1 BEGIN RAISERROR ('Middle Initial must contain 1 chracter',11,9) RETURN -1 END IF LEN(@street) > 15 OR LEN (@street) < 1 BEGIN RAISERROR ('Street must contain 1 - 15 chracters',11,10) RETURN -1 END IF LEN(@city) > 15 OR LEN (@city) < 1 BEGIN RAISERROR ('City must contain 1 - 15 chracters',11,11) RETURN -1 END IF LEN(@state) > 2 OR LEN (@state) < 2 BEGIN RAISERROR ('State must contain 2 chracters',11,12) RETURN -1 END IF LEN(@zip) <> 10 and LEN (@zip) <> 5 BEGIN RAISERROR ('Zip Code must contain 5 or 10 chracters',11,13) RETURN -1 END IF LEN(@phone_no) > 13 BEGIN RAISERROR ('Telephone must contain less than 13 chracters',11,14) RETURN -1 END -- do the work -- Calculate the expiration date one year from today set @expiration_date =dateadd(year,1,getdate()) BEGIN TRY BEGIN TRANSACTION -- Insert into Member Table first INSERT INTO [library].[dbo].[member] ([lastname] ,[firstname] ,[middleinitial]) VALUES (@lastname ,@firstname ,@middleinitial) -- Get new created MemberID SET @member_no=SCOPE_IDENTITY() SetFocus Project #3 – Library Phase 2 AddAdult stored procedure ( continued ) -- Insert into Adult Table INSERT INTO [library].[dbo].[adult] ([member_no] ,[street] ,[city] ,[state] ,[zip] ,[phone_no] ,[expr_date]) VALUES (@member_no ,@street ,@city ,@state ,@zip ,@phone_no ,@expiration_date) print 'suceess' COMMIT TRANSACTION return 0 END TRY BEGIN CATCH if @@TRANCOUNT >0 ROLLBACK TRANSACTION --local vars DECLARE @ErrorMessage NVARCHAR(4000); DECLARE @ErrorSeverity INT; DECLARE @ErrorState INT; --populate vars SELECT @ErrorMessage = ERROR_MESSAGE(), @ErrorSeverity = ERROR_SEVERITY(), @ErrorState = ERROR_STATE(); -- rethrow goes to front end c# RAISERROR (@ErrorMessage, @ErrorSeverity, @ErrorState); RETURN -1 END CATCH GO SetFocus Project #3 – Library Phase 2 CheckIn.cs C# source code using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Linq; using System.Text; using System.Windows.Forms; using HU.LibraryEntities; using HU.LibraryBusiness; namespace HU.LibraryWinClient { /// <summary> /// Check In form is used to check in items /// </summary> public partial class CheckIn : Form { private BusinessLayer bl; private int isbn; short copyNumber; public CheckIn() { InitializeComponent(); } private void isbnMaskedTextBox_Validated(object sender, EventArgs e) { control_Validated(sender, e); } private void isbnMaskedTextBox_Validating(object sender, CancelEventArgs e) { if (isbnMaskedTextBox.Text.Length == 0) { e.Cancel = true; errorProvider.SetError(isbnMaskedTextBox, quot;
ISBN can not be empty.quot;
); } else { //Convert Copy Number text box to short bool validInt = Int32.TryParse(isbnMaskedTextBox.Text, out isbn); if (isbn > 2147483647 || isbn == 0 || !validInt) { e.Cancel = true; errorProvider.SetError(isbnMaskedTextBox, quot;
ISBN should be an Integer between 1 and 2147483647.quot;
); } else { //Reformat entered digits to a valid Int without spaces isbnMaskedTextBox.Text = isbn.ToString(); } } } private void copyNumberMaskedTextBox_Validating(object sender, CancelEventArgs e) { SetFocus Project #3 – Library Phase 2 CheckIn.cs C# source code ( continued ) if (copyNumberMaskedTextBox.Text.Length == 0) { e.Cancel = true; errorProvider.SetError(copyNumberMaskedTextBox, quot;
Copy Number can not be empty.quot;
); } else { //Convert Copy Number text box to short bool validShort = short.TryParse(copyNumberMaskedTextBox.Text, out copyNumber); if (copyNumber > 32767 || copyNumber == 0 || !validShort) { e.Cancel = true; errorProvider.SetError(copyNumberMaskedTextBox, quot;
Copy Number should be an Integer between 1 and 32767.quot;
); } else { //Reformat entered digits to a valid short without spaces copyNumberMaskedTextBox.Text = copyNumber.ToString(); } } } private void copyNumberMaskedTextBox_Validated(object sender, EventArgs e) { control_Validated(sender, e); } private void control_Validated(object sender, EventArgs e) { Control ctrl = (Control)sender; errorProvider.SetError(ctrl, quot;
quot;
); } /// <summary> /// Finds the book based on ISBN and Copy number /// </summary> /// <param name=quot;
senderquot;
></param> /// <param name=quot;
equot;
></param> private void findItemButton_Click(object sender, EventArgs e) { //Make sure isbn and copy number are valid if (!this.ValidateChildren(ValidationConstraints.Visible | ValidationConstraints.Enabled)) { return; } // Create a business object bl = new BusinessLayer(); // Parse the values from the textbox copyNumber = short.Parse(copyNumberMaskedTextBox.Text); isbn = Int32.Parse(isbnMaskedTextBox.Text); try { // Call the GetItemInformation() method and pass in isbn and copy number Item myItem = bl.GetItemInformation(isbn, copyNumber); // Display the Information titleTextBox.Text = myItem.Title; autherTextBox.Text = myItem.Author; if (myItem.MemberNumber != 0) { SetFocus Project #3 – Library Phase 2 CheckIn.cs C# source code ( continued ) dueDateTextBox.Text = myItem.DueDate.ToString(); checkoutDateTextBox.Text = myItem.CheckoutDate.ToString(); checkoutMemberIDTextBox.Text = myItem.MemberNumber.ToString(); checkInItemButton.Enabled = true; } else { checkInItemButton.Enabled = false; dueDateTextBox.Clear(); checkoutDateTextBox.Clear(); checkoutMemberIDTextBox.Clear(); } checkInItemButton.Focus(); } catch (LibraryException le) { switch (le.LibraryErrorCode) { case ErrorCode.ItemNotFound: MessageBox.Show(le.Message, le.LibraryErrorCode.ToString()); isbnMaskedTextBox.Focus(); break; default: break; } } catch (Exception ex) { MessageBox.Show(ex.Message); } } private void cancelButton_Click(object sender, EventArgs e) { clearCheckInForm(true,true); } /// <summary> /// Check i item /// </summary> /// <param name=quot;
senderquot;
></param> /// <param name=quot;
equot;
></param> private void checkInItemButton_Click(object sender, EventArgs e) { if (checkoutMemberIDTextBox.Text==quot;
quot;
) { MessageBox.Show(quot;
This item is not on loanquot;
); return; } try { bl.CheckIn(isbnMaskedTextBox.Text, copyNumberMaskedTextBox.Text); cancelButton.PerformClick(); isbnMaskedTextBox.Focus(); } catch (LibraryException le) { switch (le.LibraryErrorCode) { case ErrorCode.CheckInFailed: MessageBox.Show(quot;
Failed to check in specified item.quot;
); SetFocus Project #3 – Library Phase 2 CheckIn.cs C# source code ( continued ) break; case ErrorCode.GenericException: MessageBox.Show(le.Message,quot;
Generic Errorquot;
); break; case ErrorCode.ItemNotFound: MessageBox.Show(quot;
No Item with the specified ISBN and copy number was found.quot;
); break; case ErrorCode.ItemNotOnLoan: MessageBox.Show(le.Message,quot;
Item Not On Loanquot;
); cancelButton.PerformClick(); break; default: break; } } catch (Exception ex) { MessageBox.Show(ex.Message); } } private void clearCheckInForm(bool clearISBN, bool clearCopyNumber) { if (clearISBN == true) { isbnMaskedTextBox.Clear(); } errorProvider.SetError(isbnMaskedTextBox, quot;
quot;
); if (clearCopyNumber == true) { copyNumberMaskedTextBox.Clear(); isbnMaskedTextBox.Focus(); } errorProvider.SetError(copyNumberMaskedTextBox, quot;
quot;
); titleTextBox.Clear(); autherTextBox.Clear(); dueDateTextBox.Clear(); checkoutDateTextBox.Clear(); checkoutMemberIDTextBox.Clear(); checkInItemButton.Enabled = false; } private void isbnMaskedTextBox_TextChanged(object sender, EventArgs e) { clearCheckInForm(false, true); } private void copyNumberMaskedTextBox_TextChanged(object sender, EventArgs e) { clearCheckInForm(false, false); } private void button1_Click(object sender, EventArgs e) { this.Close(); } private void CheckIn_FormClosing(object sender, FormClosingEventArgs e) { e.Cancel = false; } } } SetFocus Project #4 – Library Phase 3 Objective Library Phases 1 & 2 created the UI and Data Access layers for a library management system. This project converted the application into a web‐based application utilizing ASP.NET. In addition to Phase 1 & 2’s functionality, Phase 3’s functionality included the ability to renew an expired adult’s membership one more year, the ability to convert a Juvenile member to an Adult member, and implement authentication and authorization to restrict access to the system. Summary This project demonstrates the use of ASP.NET. Some of the techniques used include: • Create and use ASP.NET master pages to provide a consistent look across the website. • Use of Membership Roles to restrict access to pages. • Use of AJAX control to update only checked out items grid. • Utilizing ViewState objects to save data between postbacks. • Databinding through the ObjectDataSource control. • Create a web interface that is intuitive and requires minimal training. • Use various validation controls to validate input before postback. DescriptionEach control had appropriate error validation controls attached such that validation would occur on the client. The code behind files for each page contained the server side validations.The user interface used the same business layer(HU.LibraryBusiness) as the previous phases of the project with additional functionality added to comprehend new requirements.The additional functionality of converting a Juvenile member to an Adult member and renewing an adult’s membership required the addition of several business Layer, Data Access Layer, and Stored Procedures. SetFocus Project #4 – Library Phase 3 SetFocus Project #4 – Library Phase 3 SetFocus Project #5 – Library Phase 4 Objective As the potential to acquire libraries and partnerships with other libraries increase, there is a need to take the library management system to the next level. To do this, Web services must be implemented. The Web service provides access to the business layer of the system. Because of the possibility of interfacing with systems of partner libraries, security must be implemented as well. Summary This project demonstrates the use of Web Service implementation techniques. Some of the techniques used include: • Authentication using ASP.NET membership • Authorization using ASP.NET roles • Usage of Certificates for Security, Signing, and Encryption • True N‐Tier structures • Creation and interpretation of custom SoapException objects DescriptionThe goal of this phase of development was to separate the UI from the business and data layers. Certain business layer methods were overloaded. I reworked these for the web service since web services do not support overloaded methods.The Add Member methods of the business layer simply modified the parameters passed in. Since web services are inherently one‐way, these were rewritten so the appropriate data was passed back to the UI layer. Another obstacle is that web services only throw SoapExceptions. I developed a method of encoding the type of error received from the business layer and encoding all appropriate information into a custom SoapException. SetFocus Project #5 – Library Phase 4 Supported Web Service operations: namespace HU.LibraryServiceLibrary { [ServiceContract] public interface ILibraryService { [FaultContract(typeof(LibraryFault))] [OperationContract] Member GetMemberInformation(short memberId); [FaultContract(typeof(LibraryFault))] [OperationContract] Item GetItemInformation(Int32 isbn, Int16 copyNumber); [FaultContract(typeof(LibraryFault))] [OperationContract] short GetLastCopyNumner(Int32 isbn); [FaultContract(typeof(LibraryFault))] [OperationContract] ItemsDataSet GetOutstandingLoans(short memberId); [FaultContract(typeof(LibraryFault))] [OperationContract] short AddAdultMember(AdultMember member); [FaultContract(typeof(LibraryFault))] [OperationContract] short AddJuvenileMember(JuvenileMember member); [FaultContract(typeof(LibraryFault))] [OperationContract] void AddItemNumber(Item item); [FaultContract(typeof(LibraryFault))] [OperationContract] void CheckOut(string memberNumberText, string isbnText, string copyNumberText); [FaultContract(typeof(LibraryFault))] [OperationContract] void CheckIn(string isbnText, string copyNumberText); [FaultContract(typeof(LibraryFault))] [OperationContract] void Renew(string memberNumberText); [FaultContract(typeof(LibraryFault))] [OperationContract] void ConvertJuvenile(string memberNumberText); } }

SetFocus Library Project Documentation

Recomendados

Recomendados

Mais conteúdo relacionado

Mais procurados

Mais procurados (20)

Semelhante a SetFocus Library Project Documentation

Semelhante a SetFocus Library Project Documentation (20)

SetFocus Library Project Documentation