From e023e674020f1a435f7b8c8b9276704f576ea6e5 Mon Sep 17 00:00:00 2001 From: CGantert345 <57003061+CGantert345@users.noreply.github.com> Date: Mon, 29 Mar 2021 14:08:45 +0200 Subject: structure change 1 --- .../uic/barcode/ticket/api/spec/IOpenTicket.java | 561 --------------------- 1 file changed, 561 deletions(-) delete mode 100644 src/org/uic/barcode/ticket/api/spec/IOpenTicket.java (limited to 'src/org/uic/barcode/ticket/api/spec/IOpenTicket.java') diff --git a/src/org/uic/barcode/ticket/api/spec/IOpenTicket.java b/src/org/uic/barcode/ticket/api/spec/IOpenTicket.java deleted file mode 100644 index 174eb92..0000000 --- a/src/org/uic/barcode/ticket/api/spec/IOpenTicket.java +++ /dev/null @@ -1,561 +0,0 @@ -/* - * - */ -package org.uic.barcode.ticket.api.spec; - -import java.util.Collection; -import java.util.Date; - - -// TODO: Auto-generated Javadoc -/** - * The Interface IOpenTicket. - */ -public interface IOpenTicket 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 id. - * - * @return the product id - */ - public String getProductId(); - - /** - * Sets the product id. - * - * @param productId the new product id - */ - public void setProductId(String productId); - - /** - * 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 an open ticket. - * - * @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 an open ticket. - * - * @param productOwner the new product owner - */ - public void setProductOwner(String productOwner); - - /** - * Gets the external issuer. - * - * @return the external issuer - */ - public int getExternalIssuer(); - - /** - * Sets the external issuer. - * - * Identification of the issuer provided by an external carrier - * - * @param externalIssuer the new external issuer - */ - public void setExternalIssuer(int externalIssuer); - - /** - * Gets the authorization code. - * - * Authorization code given by a carrier to the product owner to allow the sale - * - * @return the authorization code - */ - public int getAuthorizationCode(); - - /** - * Sets the authorization code. - * - * An authorization code given by a carrier to the product owner to allow the sale - * - * @param authorizationCode the new authorization code - */ - public void setAuthorizationCode(int authorizationCode); - - /** - * Checks if the ticket includes the return trip. - * - * @return true, if the ticket includes the return trip. - */ - public boolean isReturnIncluded(); - - /** - * Sets that the ticket includes the return trip. - * - * @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 code. - * - * @return the from station code - */ - public String getFromStation(); - - /** - * Sets the from station code. - * - * @param fromStation the new from station code - */ - public void setFromStation(String fromStation); - - /** - * Gets the to station code. - * - * @return the to station code - */ - public String getToStation(); - - /** - * Sets the to station code. - * - * @param toStation the new to station code - */ - 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 description. - * - * @return the valid region desc - */ - public String getValidRegionDesc(); - - /** - * Sets the human readable description of the valid region. - * - * @param validRegionDesc the new human readable description of the valid region - */ - public void setValidRegionDesc(String validRegionDesc); - - /** - * Gets the list of valid regions. - * - * @return the list of valid regions - */ - public Collection getValidRegionList(); - - /** - * Adds a valid region. - * - * @param validRegion the valid region - */ - public void addValidRegionList(IRegionalValidity validRegion); - - /** - * Gets the return trip description. - * - * @return the return trip description - */ - public IReturnRouteDescription getReturnDescription() ; - - /** - * Sets the return description. - * - * @param returnDescription the new return description - */ - public void setReturnDescription(IReturnRouteDescription returnDescription); - - /** - * 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 activated days. - * - * A list of days where the ticket is valid. This should be omitted if - * the ticket is valid on the entire validity range. - * - * @return the activated days - */ - public Collection getActivatedDays(); - - /** - * Adds the activated day. - * - * A list of days where the ticket is valid. This should be omitted if - * the ticket is valid on the entire validity range. - * - * @param activatedDay the activated day - */ - public void addActivatedDay(Date activatedDay); - - /** - * Gets the travel class code. - * - * @return the travel class code - */ - public ITravelClassType getClassCode(); - - /** - * Sets the travel class code. - * - * @param classCode the new travel class code - */ - public void setClassCode(ITravelClassType classCode); - - /** - * Gets the carriers included in the transport contract. - * - * @return the included carriers - */ - public Collection getIncludedCarriers(); - - /** - * Adds a carrier to the transport contract. - * - * @param includedCarrier the carrier - */ - public void addIncludedCarrier(String includedCarrier); - - /** - * Gets the included service brands on which the ticket is valid - * - * The list should be omitted in case all service brands are - * included or a list of excluded service brands is provided. - * - * @return the included service brands - */ - public Collection getIncludedServiceBrands(); - - /** - * Adds an included service brand. - * - * The list should be omitted in case all service brands are - * included or a list of excluded service brands is provided. - * - * @param includedServiceBrand the included service brand - */ - public void addIncludedServiceBrand(Integer includedServiceBrand); - - /** - * Gets the list of excluded service brands. - * - * The list should be omitted in case a complete - * list of included service brands is provided. - * - * @return the list of excluded service brands - */ - public Collection getExcludedServiceBrands(); - - /** - * Adds an excluded service brand. - * - * The list should be omitted in case a complete - * list of included service brands is provided. - * - * @param excludedServiceBrand the excluded service brand - */ - public void addExcludedServiceBrand(Integer excludedServiceBrand); - - - - - /** - * Gets the list of excluded Transport Types. - * - * The list should be omitted in case a complete - * list of included transport types is provided. - * - * @return the list of excluded transport types - */ - public Collection getExcludedTransportTypes(); - - /** - * Adds an excluded service brand. - * - * The list should be omitted in case a complete - * list of included TransportTypes is provided. - * - * @param excluded TransportType the excluded TransportTypes - */ - public void addExcludedTransportType(Integer excludedTransportType); - - - /** - * Gets the list of excluded Transport Types. - * - * The list should be omitted in case a complete - * list of included transport types is provided. - * - * @return the list of included transport types - */ - public Collection getIncludedTransportTypes(); - - /** - * Adds an excluded service brand. - * - * The list should be omitted in case a complete - * list of included TransportTypes is provided. - * - * @param excluded TransportType the excluded TransportTypes - */ - public void addInludedTransportType(Integer includedTransportType); - - - /** - * Gets the tariffs. - * - * @return the tariffs - */ - public Collection getTariffs(); - - /** - * Adds the tariff. - * - * @param tariff the tariff - */ - public void addTariff(ITariff tariff); - - /** - * Gets the included add on tickets. - * - * E.g. an included local transport ticket at the beginning or end of the route. - * - * @return the included add ons - */ - public Collection getIncludedAddOns(); - - /** - * Adds an included add on ticket. - * - * E.g. an included local transport ticket at the beginning or end of the route. - * - * @param includedAddOn the included add on - */ - public void addIncludedAddOn(IIncludedOpenTicket includedAddOn) ; - - /** - * 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 luggage restriction. - * - * @return the luggage restriction - */ - public ILuggageRestriction getLuggageRestriction(); - - /** - * Sets the luggage restriction. - * - * @param luggageRestriction the new luggage restriction - */ - public void setLuggageRestriction(ILuggageRestriction luggageRestriction); - - /** - * Gets the extension. - * - * @return the extension - */ - public IExtension getExtension(); - - /** - * Sets the extension. - * - * @param extension the new extension - */ - public void setExtension(IExtension extension); - - - /** - * Sets the service level. - * - * The service level codes are defined in UIC leaflet 918.1 - * - * @param serviceLevel the new service level - */ - public void setServiceLevel(String serviceLevel); - - - /** - * Gets the service level. - * - * The service level codes are defined in UIC leaflet 918.1 - * - * @return the service level - */ - public String getServiceLevel(); - - - - /** - * Sets the price. - * - * - * @param price - */ - public void setPrice(Long price); - - - /** - * Gets the price. - * - * The price - * - * @return the price - */ - public Long getPrice(); - - - /** - * Gets the included add on tickets. - * - * E.g. an included local transport ticket at the beginning or end of the route. - * - * @return the included add ons - */ - public Collection getVatDetails(); - - /** - * Adds an included add on ticket. - * - * E.g. an included local transport ticket at the beginning or end of the route. - * - * @param includedAddOn the included add on - */ - public void addVatDetail(IVatDetail vatDetail) ; - - - - - /** - * 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) ; - - -} -- cgit v1.2.3