Airlines (component)

From UG

Revision as of 20:35, 23 January 2010 (edit) Alex (Talk | contribs) (→TS: User Interface) ← Older edit		Revision as of 20:38, 23 January 2010 (edit) (undo) Alex (Talk | contribs) (→TS: Functionality) Newer edit →
Line 129:		Line 129:
	See Use Cases.		See Use Cases.
-	== TS: Functionality ==	+	=== TS: Functionality ===
	See below a list of Use Cases (UC) and Test Cases (TC).		See below a list of Use Cases (UC) and Test Cases (TC).
-	=== UC: Find Airline ===	+	==== UC: Find Airline ====
	# scroll up / down		# scroll up / down
	# click several times on table headers to sort up and down; scroll		# click several times on table headers to sort up and down; scroll
-	=== UC: Edit Airline. All fields are entered in a valid format ===	+	==== UC: Edit Airline. All fields are entered in a valid format ====
	# Select airline from the list		# Select airline from the list
Line 146:		Line 146:
	# system silently closes the window; user can see that fields on [[#Add Airlines Window]]  are updated		# system silently closes the window; user can see that fields on [[#Add Airlines Window]]  are updated
-	=== UC: Edit Airline. Some fields are entered in invalid format ===	+	==== UC: Edit Airline. Some fields are entered in invalid format ====
-	=== UC: Edit Airline. Some required fields are blank ===	+	==== UC: Edit Airline. Some required fields are blank ====
-	==== Use Case: Archive and Unarchive ====	+	==== UC: Archive and Unarchive ====
	* Apply standard archive functionality: [[Archive (Feature)]] .		* Apply standard archive functionality: [[Archive (Feature)]] .
	* List ALL archived on [[#List All]]		* List ALL archived on [[#List All]]
		+
		+	==== TC: Set 2 airlines with the same code ====
		+	System must give [[Window#error]] saying: "Airline with this code already exists."
	=== Special Cases and Misc ===		=== Special Cases and Misc ===

---

Revision as of 20:38, 23 January 2010

Contents 1 Prerequisites, Classified As, Parent Mantis 2 Business Needs and Requirements 3 Technical Notes from Systems Architect 4 Technical Specification (TS) 4.1 TS: Summary 4.2 TS: Objects and Fields 4.2.1 Airline 4.3 TS: User Interface 4.3.1 List All Airlines Panel 4.3.2 Edit Airlines Window 4.3.3 Add Airlines Window 4.3.4 Warning and Error Windows 4.4 TS: Functionality 4.4.1 UC: Find Airline 4.4.2 UC: Edit Airline. All fields are entered in a valid format 4.4.3 UC: Edit Airline. Some fields are entered in invalid format 4.4.4 UC: Edit Airline. Some required fields are blank 4.4.5 UC: Archive and Unarchive 4.4.6 TC: Set 2 airlines with the same code 4.5 Special Cases and Misc 5 Quality Assurance 6 Look And Feel 7 Figures 7.1 Figure 1: List Airlines 7.2 Figure 2: Edit Airline 8 Questions 9 RFC and Ideas for Future 10 Known Non Critical Bugs 11 Links to Archived / Old specs 12 History 12.1 This doc has been created 12.2 Re-design (Tweak) (Spec Update): ..... <summary> ..... 13 Implementation 13.1 DB 13.2 Front End Code 13.3 Back End Code

Prerequisites, Classified As, Parent Mantis

• Classified As: (large) component
• Parent Mantis: 606

• Prerequisites: none

Business Needs and Requirements

Section maintained by:	In completed state?:	Last updated by/on:
Alex	Yes	--Alex 20:29, 23 January 2010 (UTC)

We need a place in the system where we manage Airlines. This is to be used on CT record, reports, pdfs, etc.

Required functionality: list, add, edit, delete, archive.

Technical Notes from Systems Architect

Section maintained by:	In completed state?:	Last updated by/on:
Alex	Yes	--Alex 20:29, 23 January 2010 (UTC)

This is a typical Admin component. Please apply standard patterns.

Technical Specification (TS)

Section maintained by:	In completed state?:	Last updated by/on:
TBD	Yes	--Alex 20:34, 23 January 2010 (UTC) TBD

TS: Summary

TS: Objects and Fields

Airline

Name

• type/format: alphanumeric; max=30 chars

2 Letter Code

• type/format: Datatypes#alpha; max=30 chars; all caps

3 Letter Numeric Code

• type/format: Datatypes#positive integer; max=3 digits

TS: User Interface

Consists of the following components - see below.

List All Airlines Panel

See #Figure 1: List Airlines

It has the following components:

• Buttons: Add, Edit, Remove.
• Listbox: with properties defined below:
  • Columns: one per each field for object #Airline
  • Sort: every column, alphabetical
  • Paging: none
  • Default sorting order: TBD

Edit Airlines Window

Component type: Window#Edit

See #Figure 2: Edit Airlines

See list of widgets below:

Name: (label: same)

Attribute:	Value:
default:	pull from selected object
type/format:	see #Airline object
required?:	Y
validation type:	stop on max / zk standard / on submit // TBD

Airline 2 Letter Code: (label: same)

Attribute:	Value:
default:	pull from selected object
type/format:	see #Airline object
required?:	Y
validation type:	stop on max / zk standard / on submit // TBD

Airline 3 Letter Numeric Code: (label: same)

Attribute:	Value:
default:	pull from selected object
type/format:	see #Airline object
required?:	Y
validation type:	stop on max / zk standard / on submit // TBD

Add Airlines Window

This is the same component as #Edit Airlines Window but with all values defaulted to blank.

Warning and Error Windows

See Use Cases.

TS: Functionality

See below a list of Use Cases (UC) and Test Cases (TC).

UC: Find Airline

1. scroll up / down
2. click several times on table headers to sort up and down; scroll

UC: Edit Airline. All fields are entered in a valid format

1. Select airline from the list
2. Click on *Add* button
3. #Add Airlines Window appears
4. Edit all fields
5. click on "OK" or "Cancel"
6. system silently closes the window; user can see that fields on #Add Airlines Window are updated

UC: Edit Airline. Some fields are entered in invalid format

UC: Edit Airline. Some required fields are blank

UC: Archive and Unarchive

• Apply standard archive functionality: Archive (Feature) .
• List ALL archived on #List All

TC: Set 2 airlines with the same code

System must give Window#error saying: "Airline with this code already exists."

Special Cases and Misc

None.

Quality Assurance

See list of major Use Cases and Test Cases defined in section #TS: Functionality .

Additional cases defined below:

TBD

This section maintained by: TBD Section Completed?: Not yet. Last updated on: TBD

Look And Feel

This section is to be written / defined by Graphic Designer and UI Designer.

• TS section maintained by: TBD
• TS Section Completed?: Not yet.
• TS Last updated by/on: TBD

Figures

Figure 1: List Airlines

Figure 2: Edit Airline

Questions

RFC and Ideas for Future

Known Non Critical Bugs

Links to Archived / Old specs

History

This doc has been created

--Alex 18:51, 23 January 2010 (UTC)

Re-design (Tweak) (Spec Update): ..... <summary> .....

<wiki date/signature>

• mantis: <link>
• Biz Req updated? N/Y
• Tech Spec updated? N/Y

Implementation

• TS section maintained by: TBD
• TS Section Completed?: Not yet.
• TS Last updated by/on: TBD

DB

• see Tbl Airline

Front End Code

http://mantis.jaguarfreight.com/svn/repo2/cybertrax/trunk/java/CyberTrax/proto2.0.1f/admin/carriers/

Back End Code

...