Home » NOVA Fulfillment » NOVA Fulfillment Master Data

NOVA Fulfillment Master Data (Package ch.voev.nova.fulfillment.masterdata)

Types / Enumerations:


Types

BookableItemValueResolutionRule

Value resolution rule to resolve receipt attribute directly from a property of a bookable item.


Type Details Details
Parent Class ValueResolutionRule


Properties / Associations

Name Type Multiplicity Constraints Description
bookableItemProperty BookableItemFulfillmentPropertyType 1..1 Bookable item property from which a receipt attribute should be taken.


DomainExtensionValueResolutionRule

Value resolution rule to resolve receipt attribute from a domain extension using a JSON Path expression.


Type Details Details
Parent Class ValueResolutionRule


Properties / Associations

Name Type Multiplicity Constraints Description
domainExtensionType DomainExtensionType 1..1 Domain extension type from which the receipt attribute should be resolved.
jsonPathExpression String 1..1 JSON Path expression that should be used to resolve the receipt attribute value.


FulfillmentDataUnit

Type represents the response when requesting data unit "Fulfillment". It contains information like receipts and receipt attributes.


Type Details Details
Parent Class DataUnit


Properties / Associations

Name Type Multiplicity Constraints Description
receiptAttributeMasterData ReceiptAttributeMasterData 1..1
receiptAttributes ReceiptAttribute 0..* derived
receiptAttributeDefinitions ReceiptAttributeDefinition 0..*
receiptDefinitions ReceiptDefinition 0..*
receiptTextFragments ReceiptTextFragment 0..*
fulfillmentMediaTypeCheckoutParameters FulfillmentMediaTypeCheckoutParameter 0..*
productFulfillmentDefinitions ProductFulfillmentDefinition 0..*


FulfillmentMediaTypeCheckoutParameter

Entity defines the checkout parameters for a specific fulfillment media type.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
mediaType FulfillmentMediaType 1..1 Restriction of media types for which the checkout parameter is applicable. If the list is empty then there is no restriction.
mandatoryCheckoutParameters CheckoutParameterDefinition 0..* List with all checkout parameters that are specific for the fulfillment media type.
optionalCheckoutParameters CheckoutParameterDefinition 0..*


ProductFulfillmentDefinition

Type defines all the fulfillment relevant parameters (e.g. checkout parameters, allowed fulfillment media, etc.) for a specific product.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
product Product 1..1
receipts ReceiptDefinition 0..*
allowedFulfillmentMediaTypes FulfillmentMediaType 0..*
securityElementFormat SecurityElementFormat 0..1
printName LocalizedString 0..1
allowedFulfillmentTypes FulfillmentType 0..*


ReceiptAttribute

Specifies a receipt attribute (DE: Druckattribut) which is used on a receipt or ticket which is issued after selling a product on NOVA.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
code ReceiptAttributeCode 1..1
labelText LocalizedString 0..1
valueType ReceiptAttributeType 1..1


ReceiptAttributeDefinition

Type is used to define a receipt attribute. A receipt attribute is used for dynamic values of a fulfillment. In order to resolve the value for a receipt attribute it is possible to define so called resolution rules that are executed during runtime to resolve the actual value.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
code ReceiptAttributeCode 1..1
valueResolutionRules ValueResolutionRule 0..* List of value resolution rules. The list is ordered according to the priority of the rules. If multiple rules are provided then the follow up rules should only be used in case that the previous rule does not return a value.
legacyCode ReceiptAttributeCode 0..1 Optional legacy code of the receipt property as it was used on NOVA 14.
valueType ReceiptAttributeType 1..1
multivalued boolean 1..1 Attribute defines it the property is multivalued or not. If a receipt attribute is multivalued then this means that will be used as receipt attribute inside lists.
labelText LocalizedString 0..1


ReceiptAttributeMasterData

Type is the entry point for all master data of receipt attributes.


Type Details Details
Parent Class EntityMasterData


Properties / Associations

Name Type Multiplicity Constraints Description
receiptAttributes ReceiptAttribute 0..*


ReceiptDefinition

Type defines a receipt containing a list of receipt attributes used e.g. for printing tickets.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
title LocalizedString 1..1
description LocalizedString 0..1
receiptAttributeDefinitions ReceiptAttributeDefinition 0..* List of attributes that belong to this receipt.
code ReceiptCode 1..1


ReceiptTextFragment

Type is used to define text fragments for a receipt. In addition to simple plain text fragments its also possible that a fragment is customized by some dynamic values. Therefore inside the master data of a text fragment placeholders with the following format are defined: ${RECEIPT_ATTRIBUTE_CODE}

The actual values are provided using receipt attributes. It's in the responsibility of the NOVA Client to do the replacement of placeholders by the actual value.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
code ReceiptTextFragmentCode 1..1 Code of the receipt fragment. This code remains stable over several versions and thus can be used a business key e.g. in layout definitions.
legacyCode ReceiptTextFragmentCode 0..1 Optional legacy code of the receipt property as it was used on NOVA 14.
multiMarkupText MultiLocalizedMarkupText 1..1 Formatted and localized variants of a receipt fragment.
placeholderVariables ReceiptAttributeCode 0..* If a text fragment supports dynamic customization using receipt attributes then they are defined through this list here.


ValueResolutionRule

Abstract base class for all types of resolution rules.


Type Details Details
Abstract true


Properties / Associations

Name Type Multiplicity Constraints Description



Enumerations

BookableItemFulfillmentPropertyType

Enumeration defines the properties of a bookable item that can be used as receipt attributes for fulfillment.

Please be aware that this type is a so called extensible enum. This means that additional literals might be added in the future and that this is considered to be a non-breaking / SemVer compliant change.

Literals

Name Description
BOOKABLE_ITEM_ID
BOOKABLE_ITEM_REFERENCE_CODE
SALES_PRICE
VALID_FROM
VALID_UNTIL
VALIDITY_DURATION
PRODUCT_NUMBER
PRODUCT_NAME
PRODUCT_VARIANT_NAME
SUBJECT_DESCRIPTION
SUBJECT_TYPE
POINT_OF_SALE
POINT_OF_DISTRIBUTION
CUSTOMER_ROLE_BUYER
CUSTOMER_ROLE_PASSENGER
CUSTOMER_ROLE_CONTRACT_OWNER
CUSTOMER_ROLE_PARENT
CUSTOMER_ROLE_CONTACT_PERSON
UNKNOWN Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice.