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

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


/**
 * The Interface IStationPassage.
 * 
 * IStationPassage describes a ticket to enter or pass a station or platform.
 * 
 */
public interface IStationPassage  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 type.
	 *
	 * @return the product type
	 */
	public String getProductId();
	
	/**
	 * Sets the product type.
	 *
	 * @param type the new product id
	 */
	public void setProductId(String type);

	/**
	 * Gets the product owner.
	 *
	 * @return the product owner
	 */
	public String getProductOwner();
	
	/**
	 * Sets the product owner.
	 *
	 * @param productOwner the new product owner
	 */
	public void setProductOwner(String productOwner);

	/**
	 * Gets the valid from date and time.
	 *
	 * @return the valid from date and time
	 */
	public Date getValidFrom();
	
	/**
	 * Sets the valid from date and time.
	 *
	 * @param validFrom the new valid from date and time
	 */
	public void setValidFrom(Date validFrom);

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

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

	/**
	 * Gets the station code table.
	 *
	 * @return the station code table
	 */
	public IStationCodeTable getStationCodeTable();

	/**
	 * Sets the station code table.
	 *
	 * @param stationCodeTable the new station code table
	 */
	public void setStationCodeTable(IStationCodeTable stationCodeTable);

	/**
	 * Gets the list of station codes of all stations where the passage is allowed.
	 *
	 * @return the stations list
	 */
	public Collection<String> getStations();

	/**
	 * Adds a station where the passage is allowed.
	 *
	 * @param station the station code
	 */
	public void addStation(String station);

	/**
	 * Adds a station name of a station where the passage is allowed.
	 *
	 * @param name the name
	 */
	public void addStationName(String name);
	
	/**
	 * Gets the station names of all stations where the passage is allowed.
	 *
	 * @return the station names
	 */
	public Collection<String> getStationNames();

	/**
	 * Gets the number of days allowed the passage is allowed in case the number is smaller that the validity range.
	 *
	 * @return the number of passage days allowed
	 */
	public int getNumberOfdaysAllowed();

	/**
	 * Sets the number of days allowed the passage is allowed in case the number is smaller that the validity range.
	 *
	 * @param numberOfdaysAllowed the new number of allowed days
	 */
	public void setNumberOfdaysAllowed(int numberOfdaysAllowed);
	
	
	/**
	 * Gets the product name.
	 *
	 * @return the product name
	 */
	public String getProductName();

	/**
	 * Sets the product name.
	 *
	 * @param name the new product name
	 */
	public void setProductName(String name);
	

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

	/**
	 * Sets the extension.
	 *
	 * @param extensionData the new extension
	 */
	public void setExtension(IExtension extensionData);	

	
	/**
	 * Gets the area codes of areas in a station where the access is allowed.
	 *
	 * @return the area codes of areas in a station where the access is allowed
	 */
	public Collection<String> getAreaCodes();
	
	/**
	 * Gets the area names of areas in a station where the access is allowed.
	 *
	 * @return the area names of areas in a station where the access is allowed
	 */
	public Collection<String> getAreaNames();
	
	/**
	 * Adds an area code of an area in a station where the access is allowed.
	 *
	 * @param code the area code of an area in a station where the access is allowed.
	 */
	public void addAreaCode(String code);
	
	/**
	 * Adds an area name of an area in a station where the access is allowed.
	 *
	 * @param name the name of an area in a station where the access is allowed
	 */
	public void addAreaName(String name);	
	
	/**
	 * Sets the until date and time.
	 *
	 * @param date the new until date and time
	 */
	public void setUntilDate(Date date);	
	
	
	/**
	 * 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) ;
	
}