fiori-service.cds

/*
  Annotations for the Manage Orders App
*/

using AdminService from '../../srv/admin-service';


////////////////////////////////////////////////////////////////////////////
//
//	Common
//
annotate AdminService.OrderItems with {
    book   @(
        Common           : {
            Text         : book.title,
            FieldControl : #Mandatory
        },
        ValueList.entity : 'Books',
    );
    quantity @(Common.FieldControl : #Mandatory);
}

annotate AdminService.Orders with {
    shippingAddress @(Common : {
        FieldControl : #Mandatory,
        ValueList    : {
            CollectionPath  : 'Addresses',
            Label           : 'Addresses',
            SearchSupported : 'true',
            Parameters      : [
                {
                    $Type             : 'Common.ValueListParameterOut',
                    LocalDataProperty : 'shippingAddress_ID',
                    ValueListProperty : 'ID'
                },
                {
                    $Type             : 'Common.ValueListParameterOut',
                    LocalDataProperty : 'shippingAddress_businessPartner',
                    ValueListProperty : 'businessPartner'
                },
                {
                    $Type             : 'Common.ValueListParameterDisplayOnly',
                    ValueListProperty : 'postalCode'
                },
                {
                    $Type             : 'Common.ValueListParameterDisplayOnly',
                    ValueListProperty : 'city'
                },
                {
                    $Type             : 'Common.ValueListParameterDisplayOnly',
                    ValueListProperty : 'country'
                },
                {
                    $Type             : 'Common.ValueListParameterDisplayOnly',
                    ValueListProperty : 'street'
                },
                {
                    $Type             : 'Common.ValueListParameterDisplayOnly',
                    ValueListProperty : 'houseNumber'
                },
            ]
        }
    });
}

////////////////////////////////////////////////////////////////////////////
//
//	UI
//
annotate AdminService.Orders with @(
    title : '{i18n>Order}',
    UI     : {
        ////////////////////////////////////////////////////////////////////////////
        //
        //	Lists of Orders
        //
        SelectionFields             : [
            createdAt,
            createdBy
        ],
        LineItem                    : [
            {
                Value : createdBy,
                Label : '{i18n>Customer}'
            },
            {
                Value : total,
                Label : '{i18n>Total}'
            },
            {
                Value : createdAt,
                Label : '{i18n>Date}'
            }
        ],
        ////////////////////////////////////////////////////////////////////////////
        //
        //	Order Details
        //
        HeaderInfo                  : {
            TypeName       : '{i18n>Order}',
            TypeNamePlural : '{i18n>Orders}',
            Title          : {
                Label : '{i18n>OrderNumber}', //A label is possible but it is not considered on the ObjectPage yet
                Value : OrderNo
            },
            Description    : {Value : createdBy}
        },
        Identification              : [ //Is the main field group
            {
                Value : createdBy,
                Label : '{i18n>Customer}'
            },
            {
                Value : createdAt,
                Label : '{i18n>Date}'
            },
            {Value : OrderNo},
            {
                Value : 'shippingAddress',
                Label : '{i18n>ID}'
            }
        ],
        HeaderFacets                : [
            {
                $Type  : 'UI.ReferenceFacet',
                Label  : '{i18n>Created}',
                Target : '@UI.FieldGroup#Created'
            },
            {
                $Type  : 'UI.ReferenceFacet',
                Label  : '{i18n>Modified}',
                Target : '@UI.FieldGroup#Modified'
            },
        ],
        Facets                      : [
            {
                $Type  : 'UI.ReferenceFacet',
                Label  : '{i18n>ShippingAddress}',
                Target : '@UI.FieldGroup#ShippingAddress'
            },
            {
                $Type  : 'UI.ReferenceFacet',
                Label  : '{i18n>Details}',
                Target : '@UI.FieldGroup#Details'
            },
            {
                $Type  : 'UI.ReferenceFacet',
                Label  : '{i18n>OrderItems}',
                Target : 'Items/@UI.LineItem'
            },
            {
                $Type               : 'UI.ReferenceFacet',
                ID                  : 'ChangeHistoryFacet',
                Label               : '{i18n>ChangeHistory}',
                Target              : 'changes/@UI.PresentationVariant',
                ![@UI.PartOfPreview]: false
            }
        ],
        FieldGroup #Details         : {Data : [
            {
                Value : total,
                Label : '{i18n>Total}'
            },
            {
                Value : currency_code,
                Label : '{i18n>Currency}'
            }
        ]},
        FieldGroup #Created         : {Data : [
            {Value : createdBy},
            {Value : createdAt},
        ]},
        FieldGroup #Modified        : {Data : [
            {Value : modifiedBy},
            {Value : modifiedAt},
        ]},
        FieldGroup #ShippingAddress : {Data : [
            {
                Value : shippingAddress_ID,
                Label : '{i18n>ShippingAddress}'
            },
            {
                Value : shippingAddress.houseNumber,
                Label : '{i18n>HouseNumber}'
            },
            {
                Value : shippingAddress.street,
                Label : '{i18n>StreetName}'
            },
            {
                Value : shippingAddress.city,
                Label : '{i18n>CityName}'
            },
            {
                Value : shippingAddress.postalCode,
                Label : '{i18n>PostalCode}'
            },
        ]}
    },
    Common : {
        SideEffects #ItemsChanges    : {
            SourceEntities   : [Items],
            TargetProperties : ['total']
        },
        SideEffects #CurrencyChanges : {
            SourceProperties : [currency_code],
            TargetEntities   : [currency]
        },
        SideEffects #AddressChanges  : {
            SourceProperties : [shippingAddress_ID],
            TargetEntities   : [shippingAddress]
        }
    }
) {
    createdAt @UI.HiddenFilter      : false;
    createdBy @UI.HiddenFilter      : false;
    total
              @Common.FieldControl  : #ReadOnly
              @Measures.ISOCurrency : currency.code; //Bind the currency field to the amount field
//In all services we always find currency as the code and not as an object that contains a property code
//it seems to work but at least to me this is unconventional modeling.
};

//The enity types name is AdminService.my_bookshop_OrderItems
//The annotations below are not generated in edmx WHY?
annotate AdminService.OrderItems with @(
    title : '{i18n>OrderItem}',
    UI     : {
        HeaderInfo      : {
            TypeName       : '{i18n>OrderItem}',
            TypeNamePlural : '{i18n>OrderItems}',
            Title          : {Value : book.title},
            Description    : {Value : book.descr}
        },
        // There is no filterbar for items so the selctionfileds is not needed
        SelectionFields : [book_ID],
        ////////////////////////////////////////////////////////////////////////////
        //
        //	Lists of OrderItems
        //
        LineItem        : [
            {
                Value : book_ID,
                Label : '{i18n>Books}'
            },
            {
                Value : quantity,
            },
            {
                Value : amount,
            }
        ],
        Identification  : [ //Is the main field group
            //{Value: ID, Label:'{i18n>ID}'}, //A guid shouldn't be on the UI
            {
                Value : book_ID,
            },
            {
                Value : quantity,
            },
            {
                Value : amount,
            }
        ],
        Facets          : [{
            $Type  : 'UI.ReferenceFacet',
            Label  : '{i18n>OrderItem}',
            Target : '@UI.Identification'
        }, ],
    },
    Common : {
        SideEffects #AmountChanges : {
            SourceProperties : [quantity],
            TargetProperties : ['amount']
        },
        SideEffects #BookChanges   : {
            SourceProperties : [book_ID],
            TargetEntities   : [book],
            TargetProperties : ['amount']
        }
    }
) {
    @title: '{i18n>Amount}'
    amount
    @Common.FieldControl : #ReadOnly;

    @title: '{i18n>Quantity}'
    quantity;
    @title: '{i18n>Book}'
    book;
//ERROR ALERT: The following line refering to the parents currency code will lead to a server error
//@Measures.ISOCurrency:parent.currency.code; //Bind the currency field to the quantity field of the parent
};


annotate AdminService.Orders.changes:up_ with @UI.Hidden;