summaryrefslogtreecommitdiffstats
path: root/src/org/uic/ticket/api/spec/ICounterMark.java
blob: 9ccf920411bf0189cd42a404b6705a8a4df4d0b9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/*
 * 
 */
package org.uic.ticket.api.spec;

import java.util.Collection;
import java.util.Date;

/**
 * The Interface ICounterMark.
 * 
 * The group ticket counter mark.
 * 
 * Members of a group might be provided with a counter mark indicating their
 * participation in a group. The counter mark is not itself a ticket, but referees to a 
 * ticket.
 * 
 * The content corresponds to the open ticket content.
 * 
 */
public interface ICounterMark  extends IDocumentData {


	/**
	 * Gets the reference.
	 *
	 * @return the reference
	 */
	public String getReference();

	/**
	 * Sets the reference.
	 *
	 * @param reference the new reference
	 */
	public void setReference(String reference);

	/**
	 * Gets the product owner.
	 * 
	 * The product owner is the railways responsible for assembling this ticket. As there is currently no 
	 * standard interface for open tickets between an product owner and an issuer this is usually 
	 * identical to the issuer of a counter mark.   
	 *
	 * @return the product owner
	 */
	public String getProductOwner();

	/**
	 * Sets the product owner.
	 * 
	 * The product owner is the railways responsible for assembling this ticket. As there is currently no 
	 * standard interface for open tickets between an product owner and an issuer this is usually 
	 * identical to the issuer of a counter mark.  
	 *
	 * @param productOwner the new product owner
	 */
	public void setProductOwner(String productOwner);
	
	/**
	 * Gets the product id.
	 *
	 * @return the product id
	 */
	public String getProductId();

	/**
	 * Sets the product id.
	 *
	 * @param productId the new product id
	 */
	public void setProductId(String productId);
	
	
	/**
	 * Checks if is return included.
	 *
	 * @return true, if is return included
	 */
	public boolean isReturnIncluded();

	/**
	 * Sets the return included.
	 *
	 * @param returnIncluded the new return included
	 */
	public void setReturnIncluded(boolean returnIncluded);

	/**
	 * Gets the station code table.
	 *
	 * Defines the station code table to be used to retrieve station information. 
	 * Default in this case is the UIC station codes table for standard UIC 
	 * station code from MERITS (UIC country code + 5 digit local code) 	 
	 *	 
	 * @return the station code table
	 */
	public IStationCodeTable getStationCodeTable();

	/**
	 * Sets the station code table.
	 *
	 * Defines the station code table to be used to retrieve station information. 
	 * Default in this case is the UIC station codes table for standard UIC 
	 * station code from MERITS (UIC country code + 5 digit local code) 
	 * 	 
	 * @param stationCodeTable the new station code table
	 */
	public void setStationCodeTable(IStationCodeTable stationCodeTable);

	/**
	 * Gets the from station.
	 *
	 * @return the from station
	 */
	public String getFromStation();

	/**
	 * Sets the from station.
	 *
	 * @param fromStation the new from station
	 */
	public void setFromStation(String fromStation);

	/**
	 * Gets the to station.
	 *
	 * @return the to station
	 */
	public String getToStation();

	/**
	 * Sets the to station.
	 *
	 * @param toStation the new to station
	 */
	public void setToStation(String toStation);

	/**
	 * Gets the from station name.
	 *
	 * @return the from station name
	 */
	public String getFromStationName();

	/**
	 * Sets the from station name.
	 *
	 * @param fromStationName the new from station name
	 */
	public void setFromStationName(String fromStationName);

	/**
	 * Gets the to station name.
	 *
	 * @return the to station name
	 */
	public String getToStationName();

	/**
	 * Sets the to station name.
	 *
	 * @param toStationName the new to station name
	 */
	public void setToStationName(String toStationName);

	/**
	 * Gets the valid region desc.
	 *
	 * @return the valid region desc
	 */
	public String getValidRegionDesc();

	/**
	 * Sets the valid region desc.
	 *
	 * @param validRegionDesc the new valid region desc
	 */
	public void setValidRegionDesc(String validRegionDesc);

	/**
	 * Gets the valid region list.
	 *
	 * @return the valid region list
	 */
	public Collection<IRegionalValidity> getValidRegionList();

	/**
	 * Adds the valid region list.
	 *
	 * @param validRegion the valid region
	 */
	public void addValidRegionList(IRegionalValidity validRegion);

	/**
	 * Gets the return description.
	 *
	 * @return the return description
	 */
	public IReturnRouteDescription getReturnDescription() ;

	/**
	 * Sets the return description.
	 *
	 * @param returnDescription the new return description
	 */
	public void setReturnDescription(IReturnRouteDescription returnDescription);
	
	/**
	 * Gets the valid from.
	 *
	 * @return the valid from
	 */
	public Date getValidFrom() ;

	/**
	 * Sets the valid from.
	 *
	 * @param validFrom the new valid from
	 */
	public void setValidFrom(Date validFrom);

	/**
	 * Gets the valid until.
	 *
	 * @return the valid until
	 */
	public Date getValidUntil();

	/**
	 * Sets the valid until.
	 *
	 * @param validUntil the new valid until
	 */
	public void setValidUntil(Date validUntil);

	/**
	 * Gets the class code.
	 *
	 * @return the class code
	 */
	public ITravelClassType getClassCode();

	/**
	 * Sets the class code.
	 *
	 * @param classCode the new class code
	 */
	public void setClassCode(ITravelClassType classCode);

	/**
	 * Gets the included carriers.
	 *
	 * @return the included carriers
	 */
	public Collection<String> getIncludedCarriers();

	/**
	 * Adds the included carrier.
	 *
	 * @param includedCarrier the included carrier
	 */
	public void addIncludedCarrier(String includedCarrier);

	/**
	 * Gets the included service brands.
	 *
	 * @return the included service brands
	 */
	public Collection<Integer> getIncludedServiceBrands();

	/**
	 * Adds the included service brand.
	 *
	 * @param includedServiceBrand the included service brand
	 */
	public void addIncludedServiceBrand(Integer includedServiceBrand);

	/**
	 * Gets the excluded service brands.
	 *
	 * @return the excluded service brands
	 */
	public Collection<Integer> getExcludedServiceBrands();

	/**
	 * Adds the excluded service brand.
	 *
	 * @param excludedServiceBrand the excluded service brand
	 */
	public void addExcludedServiceBrand(Integer excludedServiceBrand);

	/**
	 * Gets the info text.
	 *
	 * @return the info text
	 */
	public String getInfoText();

	/**
	 * Sets the info text.
	 *
	 * @param infoText the new info text
	 */
	public void setInfoText(String infoText);

	/**
	 * Gets the extension.
	 *
	 * @return the extension
	 */
	public IExtension getExtension();

	/**
	 * Sets the extension.
	 *
	 * @param extension the new extension
	 */
	public void setExtension(IExtension extension);
	
	/**
	 * Gets the total of countermarks.
	 *
	 * @return the total of countermarks
	 */
	public int getTotalOfCountermarks();

	/**
	 * Sets the total of countermarks.
	 *
	 * @param totalOfCountermarks the new total of countermarks
	 */
	public void setTotalOfCountermarks(int totalOfCountermarks);

	/**
	 * Gets the group name.
	 *
	 * @return the group name
	 */
	public String getGroupName();

	/**
	 * Sets the group name.
	 *
	 * @param groupName the new group name
	 */
	public void setGroupName(String groupName);
	
	/**
	 * Gets the number of countermark.
	 *
	 * @return the number of countermark
	 */
	public int getNumberOfCountermark();

	/**
	 * Sets the number of countermark.
	 *
	 * @param numberOfCountermark the new number of countermark
	 */
	public void setNumberOfCountermark(int numberOfCountermark) ;
	

	public void setTicketReference(String ticketReference);
	public String getTicketReference();
	
	/**
	 * Gets the validFrom date time offset to UTC in units of 15 minutes.
	 *
	 * @return the validFrom date time UTC offset
	 */
	public Long getValidFromUTCoffset();
	
	/**
	 * Sets the validFrom date time.
	 *
	 * @param validFromDateTime the new validFrom date time
	 */
	public void setValidFromUTCoffset(Long validFromUTCoffset) ;
	
	/**
	 * Gets the validUntil date time offset to UTC in units of 15 minutes.
	 *
	 * @return the validUntil date time UTC offset
	 */
	public Long getValidUntilUTCoffset();
	
	/**
	 * Sets the validUntil date time.
	 *
	 * @param validUntilDateTime the new validUntil date time
	 */
	public void setValidUntilUTCoffset(Long validUntilUTCoffset) ;
	
	
	
}