FP Fare Price MODEL::FARE PRICE

: Public abstract Class

Created:	28/11/2016 18:23:43
Modified:	15/07/2021 00:49:21

Project:
Author:	Transmodel
Version:	6.0-1.0
Phase:	1.0
Status:	Validated
Complexity:	Easy
Difficulty:
Priority:
Multiplicity:
Advanced:
UUID:	{E0A05D1E-C849-4b64-BE7B-5F9EE33D7F21}
Appears In:	FM FP Fare Calculation Parameters MODEL, FM FP Fare Calculation Parameters MODEL Basic [INFO], FM FP Price MODEL, FM FP Priceable Object MODEL, FM FP Priceable Object MODEL Basic [INFO], FM FP Price MODEL Basic [INFO], PRICEABLE OBJECT, FM FS Priceable Object HIERARCHY [INFO], FM FP Parking Tariff MODEL, PARKING CHARGE BAND, FM FP Parking Tariff HIERARCHY [INFO], FM FP Fare Table MODEL, FM FP Fare Table MODEL Basic [INFO], FARE TABLE, FM FS Fare Zone HIERARCHY [INFO], GEOGRAPHICAL INTERVAL, FM FS Geographical Fare Structure HIERARCHY [INFO], FM FS Distance Element Matrix HIERARCHY [INFO], FM FS Time Fare Structure HIERARCHY [INFO], FM FS Quality Structure HIERARCHY [INFO], FM FS Fare Structure Element HIERARCHY [INFO], FM FS Validable Element HIERARCHY [INFO], FM AR Fare Product MODEL Intro [INFO], FM AR Fare Product MODEL, FM AR Fare Product HIERARCHY [INFO], FM AR Types of Fare Product HIERARCHY [INFO], FM AR Usage Parameters HIERARCHY [INFO], SALES OFFER PACKAGE, FM SD Sales Offer Package HIERARCHY [INFO], FM SD Sales Distribution HIERARCHY [INFO], FM ST Sales Transaction HIERARCHY [INFO], FM FF Fare Frame MODEL, PI TD Passenger Fare Offer MODEL, PI TD Passenger Fare Offer MODEL Basic [INFO], PI TD Passenger Fare Offer MODEL Overview [INFO], PI TD Passenger Fare Offer MODEL Introduction [INFO], PI FQ Single Trip Fare Delivery MODEL, PI FQ Repeated Trip Fare Delivery MODEL, NM Extract of Transmodel for Alternative Modes Pricing MODEL, NM Colour usage

Price features for a PRICEABLE OBJECT.

Attributes
Associations To
Associations From
Advanced
Other Links

Attribute

Public AmountType
Amount

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Price in a specified currency.

Public AmountType
DiscountAmount

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Discount given, if any, in a specified currency.

Public AmountType
DiscountPercentageUsed

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Discount percentage used, if any when deriving price.

Public date
EndDate

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

End date for PRICE validity.

Package FarePriceIdType
id

Details:

Alias:
Initial:
Stereotype:	<<UID>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Identifier of FARE PRICE.

Public boolean
IsAllowed

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

Whether the FARE PRICE is allowed. Default is true.

Public MultilingualString
Name

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Name of PRICE.

Public integer
Ranking

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

Relative ranking to be given to discount to use to favour it over other discounts available.

Public date
StartDate

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Start date for PRICE validity.

Public AmountType
TaxAmount

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Tax included in Amount, in same currency as amount.

Public AmountType
TaxPercentageUsed

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

persistence=false

Notes:

Tax rate used, if any when deriving price.

Element	Source Role	Target Role
PRICEABLE OBJECT Class «Abstract»	Name: given for	Name: related to
Details:
PT FARE OFFER Class	Name: priced by	Name: price for
Details:
FARE PRICE Class	Name: reference for	Name: derived from
Details:
PRICE GROUP Class	Name: included in	Name: composed of
Details:

Element	Source Role	Target Role
PRICE UNIT Class	Name: used to specify	Name: given in
Details:
PRICING SERVICE Class	Name: providing	Name: provided by
Details:
CELL Class	Name: priced by	Name: pricing
Details:
FARE PRICE Class	Name: reference for	Name: derived from
Details:
PRICING RULE Class	Name: calculating	Name: calculated by
Details:

Property	Value
isFinalSpecialization:	0

Object	Type	Connection	Direction	Notes
PRICEABLE OBJECT	Class	Strong	To
QUALITY STRUCTURE FACTOR PRICE	Class	Generalization	From
VALIDABLE ELEMENT PRICE	Class	Generalization	From
CUSTOMER PURCHASE PACKAGE PRICE	Class	Generalization	From
FULFILMENT METHOD PRICE	Class	Generalization	From
FARE PRODUCT PRICE	Class	Generalization	From
CONTROLLABLE ELEMENT PRICE	Class	Generalization	From
PT FARE OFFER	Class	Weak	To
USAGE PARAMETER PRICE	Class	Generalization	From
DISTANCE MATRIX ELEMENT PRICE	Class	Generalization	From
GEOGRAPHICAL UNIT PRICE	Class	Generalization	From
SERIES CONSTRAINT PRICE	Class	Generalization	From
TIME UNIT PRICE	Class	Generalization	From
CAPPING RULE PRICE	Class	Generalization	From
PARKING PRICE	Class	Generalization	From
SALES OFFER PACKAGE PRICE	Class	Generalization	From
FARE STRUCTURE ELEMENT PRICE	Class	Generalization	From
GEOGRAPHICAL INTERVAL PRICE	Class	Generalization	From
TIME INTERVAL PRICE	Class	Generalization	From