Package: Organization

Organization

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2016, 2022 Eurotech and/or its affiliates and others
3: *
4: * This program and the accompanying materials are made
5: * available under the terms of the Eclipse Public License 2.0
6: * which is available at https://www.eclipse.org/legal/epl-2.0/
7: *
8: * SPDX-License-Identifier: EPL-2.0
9: *
10: * Contributors:
11: * Eurotech - initial API and implementation
12: *******************************************************************************/
13: package org.eclipse.kapua.service.account;
14:
15: import org.eclipse.kapua.service.account.xml.AccountXmlRegistry;
16:
17: import javax.xml.bind.annotation.XmlAccessType;
18: import javax.xml.bind.annotation.XmlAccessorType;
19: import javax.xml.bind.annotation.XmlType;
20:
21: /**
22: * {@link Organization} definition.
23: *
24: * @since 1.0.0
25: */
26: @XmlAccessorType(XmlAccessType.PROPERTY)
27: @XmlType(factoryClass = AccountXmlRegistry.class, factoryMethod = "newOrganization")
28: public interface Organization {
29:
30: /**
31: * Gets the name.
32: *
33: * @return The name.
34: * @since 1.0.0
35: */
36: String getName();
37:
38: /**
39: * Sets the name
40: *
41: * @param name The name.
42: * @since 1.0.0
43: */
44: void setName(String name);
45:
46: /**
47: * Gets the referent name.
48: *
49: * @return The referent name.
50: * @since 1.0.0
51: */
52: String getPersonName();
53:
54: /**
55: * Sets the referent name.
56: *
57: * @param personName The referent name
58: * @since 1.0.0
59: */
60: void setPersonName(String personName);
61:
62: /**
63: * Gets the email.
64: *
65: * @return The email.
66: * @since 1.0.0
67: */
68: String getEmail();
69:
70: /**
71: * Sets the email.
72: *
73: * @param email The email.
74: * @since 1.0.0
75: */
76: void setEmail(String email);
77:
78: /**
79: * Gets the phone number.
80: *
81: * @return The phone number.
82: * @since 1.0.0
83: */
84: String getPhoneNumber();
85:
86: /**
87: * Sets the phone number.
88: *
89: * @param phoneNumber The phone number.
90: * @since 1.0.0
91: */
92: void setPhoneNumber(String phoneNumber);
93:
94: /**
95: * Gets the address first line.
96: *
97: * @return The address first line.
98: * @since 1.0.0
99: */
100: String getAddressLine1();
101:
102: /**
103: * Sets the address first line.
104: *
105: * @param addressLine1 The address first line.
106: * @since 1.0.0
107: */
108: void setAddressLine1(String addressLine1);
109:
110: /**
111: * Gets the address second line.
112: *
113: * @return The address second line.
114: * @since 1.0.0
115: */
116: String getAddressLine2();
117:
118: /**
119: * Sets the address second line.
120: *
121: * @param addressLine2 The address second line.
122: * @since 1.0.0
123: */
124: void setAddressLine2(String addressLine2);
125:
126:
127: /**
128: * Gets the address third line.
129: *
130: * @return The address third line.
131: * @since 1.1.0
132: */
133: String getAddressLine3();
134:
135: /**
136: * Sets the address third line.
137: *
138: * @param addressLine3 The address third line.
139: * @since 1.1.0
140: */
141: void setAddressLine3(String addressLine3);
142:
143: /**
144: * Gets the postal ZIP code.
145: *
146: * @return The postal ZIP code.
147: * @since 1.0.0
148: */
149: String getZipPostCode();
150:
151: /**
152: * Sets the postal ZIP code.
153: *
154: * @param zipPostalCode The postal ZIP code.
155: * @since 1.0.0
156: */
157: void setZipPostCode(String zipPostalCode);
158:
159: /**
160: * Gets the city.
161: *
162: * @return The city.
163: * @since 1.0.0
164: */
165: String getCity();
166:
167: /**
168: * Sets the city.
169: *
170: * @param city The city.
171: * @since 1.0.0
172: */
173: void setCity(String city);
174:
175: /**
176: * Gets the province or state (if it is a federal state) within a country.
177: *
178: * @return The province or state (if it is a federal state) within a country.
179: * @since 1.0.0
180: */
181: String getStateProvinceCounty();
182:
183: /**
184: * Sets the province or state (if it is a federal state) within a country.
185: *
186: * @param stateProvinceCounty The province or state (if it is a federal state) within a country.
187: * @since 1.0.0
188: */
189: void setStateProvinceCounty(String stateProvinceCounty);
190:
191: /**
192: * Gets the country.
193: *
194: * @return The country.
195: * @since 1.0.0
196: */
197: String getCountry();
198:
199: /**
200: * Sets the country.
201: *
202: * @param country The country.
203: * @since 1.0.0
204: */
205: void setCountry(String country);
206: }