summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/uic/barcode/ticket/api/spec/IZone.java
blob: 75fc69d899750a7982d7ff6fee27ee1f875580d9 (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
/*
 * 
 */
package org.uic.barcode.ticket.api.spec;

import java.util.Collection;

/**
 * The Interface IZone.
 * 
 * 
 * IZone describes a regional validity in a zone.
 * 
 */
public interface IZone extends IRegionalValidity{

	/**
	 * Gets the carrier.
	 * 
	 * @return the carrier
	 */
	public String getCarrier();
	
	/**
	 * Sets the carrier.
	 *
	 * @param carrier the new carrier
	 */
	public void setCarrier(String carrier);
	
	/**
	 * 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 entry station in case the journey in the zone  has to start at a specific station in the zone 
	 * E.g. city traffic at the end of a train journey starting at the final train station.
	 *
	 * @return the entry station
	 */
	public String getEntryStation() ;

	/**
	 * Sets the entry station in case the journey in the zone has to start at a specific station in the zone 
	 * E.g. city traffic at the end of a train journey starting at the final train station.
	 * 
	 * @param entryStation the new entry station
	 */
	public void setEntryStation(String entryStation);

	/**
	 * Gets the terminating station in case the journey in the zone has to end at a specific station in the zone 
	 * E.g. city traffic at the begin of a train journey starting at the first train station.
	 *
	 * @return the terminating station
	 */
	public String getTerminatingStation();

	/**
	 * Sets the terminating station in case the journey in the zone has to end at a specific station in the zone 
	 * E.g. city traffic at the begin of a train journey starting at the first train station.
	 *
	 * @param terminatingStation the new terminating station
	 */
	public void setTerminatingStation(String terminatingStation);
	
	/**
	 * Gets the city code of the local city in case the zone is part of regional 
	 *   city transport: code list of the local carrier.
	 *
	 * @return the city
	 */
	public int getCity() ;

	/**
	 * Sets the city code of the local city in case the zone is part of regional 
	 *   city transport: code list of the local carrier
	 *   
	 * @param city the new city
	 */
	public void setCity(int city);

	/**
	 * Gets the binary zone id.
	 *   binary encoding of zones, encoding specification provided by 
	 *   the local service provider
	 *
	 * @return the binary zone id
	 */
	public byte[] getBinaryZoneId() ;

	/**
	 * Sets the binary zone id.
	 *   binary encoding of zones, encoding specification provided by 
	 *   the local service provider
	 *   
	 * @param binatyZoneId the new binaty zone id
	 */
	public void setBinaryZoneId(byte[] binatyZoneId);
	
	/**
	 * Gets the zone ids.
	 *  ids of the valid zones known by the local carriers in that zone
	 *
	 * @return the zone ids
	 */
	public Collection<Integer> getZoneIds() ;

	/**
	 * Adds a zone id.
	 *  id of the valid zones known by the local carriers in that zone
	 *
	 * @param zoneId the zone id
	 */
	public void addZoneId(int zoneId);
	
	/**
	 * Gets the European NUTS code in case this code is used to encode the zone.
	 *
	 * @return the NUTS code
	 */
	public String  getNUTScode();
	
	/**
	 * Sets the European NUTS code in case this code is used to encode the zone.
	 *
	 * @param code the new NUTS code
	 */
	public void  setNUTScode(String code);
	
}