1 /*
2 * Created on Apr 21, 2005
3 *
4 * Copyright 2005-2006 the original author or authors.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.wcb.model.vo;
19 /**
20 * This class allows checking of ssn numbers.
21 * @author wbogaardt
22 *
23 */
24
25 public class SsnAreaVo {
26
27 private String local;
28
29 /**
30 * State code of ssn.
31 */
32 private String state;
33
34 /**
35 * Special note code value.
36 */
37 private String noteCode;
38
39 /**
40 * High grouping value.
41 */
42 private String highGroup;
43
44 /**
45 * Special Note field.
46 */
47 private String note;
48
49 /**
50 * Constructor method for ssn value objects.
51 * @param loc Location of the ssn.
52 * @param st state the ssn was issued.
53 * @param notecde notification code.
54 * @param highGrp high group number issued for ssn.
55 * @param aNote special note.
56 */
57 public SsnAreaVo(String loc, String st, String notecde, String highGrp,
58 String aNote) {
59 this.local = loc;
60 this.state = st;
61 this.noteCode = notecde;
62 this.highGroup = highGrp;
63 this.note = aNote;
64 }
65
66 /**
67 * Return the high group string.
68 * @return high group
69 */
70 public String getHighGroup() {
71 return highGroup;
72 }
73
74 /**
75 * Set the high group string.
76 * @param high high group.
77 */
78 public void setHighGroup(String high) {
79 this.highGroup = high;
80 }
81
82 /**
83 * Set the location of the ssn.
84 * @return string of location
85 */
86 public String getLocal() {
87 return local;
88 }
89
90 /**
91 * Set the location of the ssn.
92 * @param lcl ssn local
93 */
94 public void setLocal(String lcl) {
95 this.local = lcl;
96 }
97
98 /**
99 * Comments or remarks.
100 * @return get comments of the value
101 */
102 public String getNote() {
103 return note;
104 }
105
106 /**
107 * set the notes of the ssn value.
108 * @param noteS note value
109 */
110 public void setNote(String noteS) {
111 this.note = noteS;
112 }
113
114 /**
115 * Single letter note code.
116 * @return note code
117 */
118 public String getNoteCode() {
119 return noteCode;
120 }
121
122 /**
123 * Set the single letter note code.
124 * @param aNote a note code of ssn
125 */
126 public void setNoteCode(String aNote) {
127 this.noteCode = aNote;
128 }
129
130 /**
131 * the State of the ssn assignment.
132 * @return the state assigned
133 */
134 public String getState() {
135 return state;
136 }
137
138 /**
139 * Set the state assigned.
140 * @param st the state assigned
141 */
142 public void setState(String st) {
143 this.state = st;
144 }
145
146 }