summaryrefslogtreecommitdiffstats
path: root/src/org/uic/ticket/api/spec/IDelayConfirmation.java
blob: aa9b418a03b19811d3cf4e0ddf1bb59aa6f47bb6 (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
/*
 * 
 */
package org.uic.ticket.api.spec;

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

import org.uic.ticket.api.asn.omv1.CodeTableType;


// TODO: Auto-generated Javadoc
/**
 * The Interface IDelayConfirmation implements 
 * a confirmation of delay given to a traveler to prove to another carrier he want tu use to continue the journey 
 * that he was delayed.
 */
public interface IDelayConfirmation  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 train.
	 *
	 * @return the train
	 */
	public String getTrain();
	
	/**
	 * Sets the train.
	 *
	 * @param train the new train
	 */
	public void setTrain(String train);

	/**
	 * 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 CodeTableType 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(CodeTableType stationCodeTable);

	/**
	 * Gets the from station code where the delay was final (usually the station where the traveler left the train).
	 *
	 * @return the from station code
	 */
	public String getStation();

	/**
	 * Sets the from station code where the delay was final (usually the station where the traveler left the train).
	 *
	 * @param station the new station
	 */
	public void setStation(String station);


	/**
	 * Sets the from station name where the delay was final (usually the station where the traveler left the train).
	 *
	 * @param fromStationName the new from station name
	 */
	public void setStationName(String fromStationName);

	/**
	 * Gets the to station name where the delay was final (usually the station where the traveler left the train).
	 *
	 * @return the to station name
	 */
	public String getStationName();

	/**
	 * Gets the planned arrival date and time where the traveler left the train.
	 *
	 * @return the planned arrival date and time
	 */
	public Date getArrivalDate();
	
	/**
	 * Sets the planned arrival date and time where the traveler left the train.
	 *
	 * @param arrivalDate the new planned arrival date and time
	 */
	public void setArrivalDate(Date arrivalDate);
	
	/**
	 * Checks if is train was cancelled.
	 *
	 * @return true, if is train cancelled
	 */
	public boolean isTrainCancelled();
	
	/**
	 * Sets the train cancelled.
	 *
	 * @param trainIsCancelled the new train cancelled
	 */
	public void setTrainCancelled(boolean trainIsCancelled);
	
	
	/**
	 * Gets the delay in minutes.
	 *
	 * @return the delay in minutes
	 */
	public int getDelay();
	
	/**
	 * Sets the delay in minutes.
	 *
	 * @param delay the delay in minutes
	 */
	public void setDelay(int delay);
	
	/**
	 * Gets the confirmation type.
	 * 
	 * See code list of the specification for the meaning of the values.
	 *
	 * @return the confirmation type
	 */
	public int getConfirmationType();
	
	/**
	 * Sets the confirmation type.
	 * 
	 * See code list of the specification for the meaning of the values.
	 *
	 * @param type the new confirmation type
	 */
	public void setConfirmationType(int type);
	
	/**
	 * Sets the confirmation that the traveler was on board of the delayed train.
	 *
	 * @param travelerOnBoardDelayed the confirmation that the traveler was on the delayed train
	 */
	public void setTravelerOnBoardDelayed(boolean travelerOnBoardDelayed);
	
	/**
	 * Sets the confirmation that the train was delayed.
	 *
	 * @param trainDelayed the confirmation that the train was delayed
	 */
	public void setTrainDelayed(boolean trainDelayed);
	
	/**
	 * Sets the confirmation that the train was delayed and the traveler had a ticket designated to the delayed train.
	 *
	 * @param trainOfTravelerDelayed the confirmation that the train was delayed and the traveler had a ticket designated to the delayed train.
	 */
	public void setTrainDelayedTravelerHasTrainTicket(boolean trainOfTravelerDelayed);
	
	/**
	 * Checks if this document confirms that the traveler was on board of the delayed train.
	 *
	 * @return true, if this document confirms that the traveler was on board of the delayed train
	 */
	public boolean isTravelerOnBoardDelayed();
	
	/**
	 * Checks if this document confirms that the train is delayed.
	 *
	 * @return true, if is train delay is confirmed
	 */
	public boolean isTrainDelayed();
	
	/**
	 * Checks if this document confirms that the train where the traveler had a designated ticket for is delayed.
	 *
	 * @return true, if this document confirms that the traveler has a ticket designated to the delayed train.
	 */
	public boolean isTrainDelayedTravelerHasTrainTicket();	
	
	
	/**
	 * Gets the linked tickets.
	 *
	 * Link to the ticket valid on the delayed train. 
	 *
	 * @return the linked tickets
	 */
	public Collection<ITicketLink> getLinkedTickets() ;
	

	/**
	 * Adds the linked ticket valid on the delayed train.
	 *
	 * 
	 * @param linkedTicket the linked ticket
	 */
	public void addLinkedTicket(ITicketLink linkedTicket) ;	
	



	/**
	 * 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 arrival ut coffset.
	 *
	 * @return the arrival ut coffset
	 */
	public Long getArrivalUTCoffset();

	/**
	 * Sets the arrival ut coffset.
	 *
	 * @param arrivalUTCoffset the new arrival ut coffset
	 */
	public void setArrivalUTCoffset(Long arrivalUTCoffset);
	
	
}