applications/order/servicedef/services_shoppinglist.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://ofbiz.apache.org/dtds/services.xsd">
    <description>Order Services</description>
    <vendor>OFBiz</vendor>
    <version>1.0</version>

    <!-- Shopping List Services -->
    <service name="shoppingListInterface" engine="interface" location="" invoke="">
        <description>Shopping List Interface</description>
        <auto-attributes mode="IN" entity-name="ShoppingList" include="nonpk" optional="true"/>
        <attribute name="shippingMethodString" type="String" mode="IN" optional="true"/>
    </service>
    <service name="createShoppingList" engine="groovy" auth="false"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="createShoppingList">
        <description>Create a shopping list entity</description>
        <permission-service service-name="checkShoppingListSecurity" main-action="CREATE"/>
        <implements service="createShoppingListRecurrence"/>
        <implements service="shoppingListInterface"/>
        <attribute name="shoppingListId" type="String" mode="OUT" optional="false"/>
    </service>
    <service name="updateShoppingList" engine="groovy" auth="true"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="updateShoppingList">
        <description>Update a shopping list entity</description>
        <permission-service service-name="checkShoppingListSecurity" main-action="UPDATE"/>
        <implements service="createShoppingListRecurrence"/>
        <implements service="shoppingListInterface"/>
        <attribute name="shoppingListId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="removeShoppingList" engine="entity-auto" default-entity-name="ShoppingList" auth="true" invoke="delete">
        <description>Remove a shopping list entity</description>
        <permission-service service-name="checkShoppingListSecurity" main-action="DELETE"/>
        <attribute name="shoppingListId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="checkShoppingListSecurity" engine="groovy" auth="false"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="checkShoppingListSecurity">
        <description>Checks security on a ShoppingList</description>
        <implements service="permissionInterface"/>
        <attribute name="partyId" type="String" mode="IN" optional="true"/>
    </service>
    <service name="calculateShoppingListDeepTotalPrice" engine="groovy" auth="true"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="calculateShoppingListDeepTotalPrice">
        <description>Remove a shopping list entity</description>
        <attribute name="shoppingListId" type="String" mode="IN" optional="false"/>
        <attribute name="prodCatalogId" type="String" mode="IN" optional="false"/>
        <attribute name="webSiteId" type="String" mode="IN" optional="false"/>
        <attribute name="partyId" type="String" mode="IN" optional="true"/>
        <attribute name="productStoreId" type="String" mode="IN" optional="true"/>
        <attribute name="productStoreGroupId" type="String" mode="IN" optional="true"/>
        <attribute name="quantity" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="currencyUomId" type="String" mode="IN" optional="true"/>
        <attribute name="autoUserLogin" type="org.apache.ofbiz.entity.GenericValue" mode="IN" optional="true"/>
        <attribute name="totalPrice" type="BigDecimal" mode="OUT" optional="false"/>
    </service>

    <service name="runShoppingListAutoReorder" engine="java" auth="true" use-transaction="false"
            location="org.apache.ofbiz.order.shoppinglist.ShoppingListServices" invoke="createListReorders">
        <description>A service designed to be automatically run by job scheduler to create orders from auto-order shopping lists.
            This is done by looking for all auto-order shopping lists which are active
            comparing the lastOrderedDate and the defined recurrenceInfo with the time when the service is run.</description>
    </service>
    <service name="createShoppingListRecurrence" engine="java" auth="true"
            location="org.apache.ofbiz.order.shoppinglist.ShoppingListServices" invoke="setShoppingListRecurrence">
        <description>Creates Recurrence Info For Auto-Reorder Lists</description>
        <attribute name="startDateTime" type="Timestamp" mode="IN" optional="true"/>
        <attribute name="endDateTime" type="Timestamp" mode="IN" optional="true"/>
        <attribute name="frequency" type="Integer" mode="IN" optional="true"/>
        <attribute name="intervalNumber" type="Integer" mode="IN" optional="true"/>
        <attribute name="recurrenceInfoId" type="String" mode="OUT" optional="true"/>
    </service>
    <service name="splitShipmentMethodString" engine="java" auth="false"
            location="org.apache.ofbiz.order.shoppinglist.ShoppingListServices" invoke="splitShipmentMethodString">
        <description>Splits the shipping method string</description>
        <attribute name="shippingMethodString" type="String" mode="IN" optional="true"/>
        <attribute name="shipmentMethodTypeId" type="String" mode="OUT" optional="true"/>
        <attribute name="carrierPartyId" type="String" mode="OUT" optional="true"/>
    </service>
    <service name="makeShoppingListFromOrder" engine="java" auth="true"
            location="org.apache.ofbiz.order.shoppinglist.ShoppingListServices" invoke="makeListFromOrder">
        <description>Create/Update a shopping list from an order</description>
        <implements service="createShoppingListRecurrence"/>
        <attribute name="shoppingListTypeId" type="String" mode="IN" optional="true"/>
        <attribute name="shoppingListId" type="String" mode="INOUT" optional="true"/>
        <attribute name="orderId" type="String" mode="IN" optional="false"/>
        <attribute name="partyId" type="String" mode="IN" optional="true"/>
    </service>

    <service name="shoppingListItemInterface" engine="interface" location="" invoke="">
        <description>Interface of shopping list items</description>
        <attribute name="shoppingListId" type="String" mode="IN" optional="false"/>
        <attribute name="productId" type="String" mode="IN" optional="true"/>
        <attribute name="quantity" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="modifiedPrice" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="reservStart" type="Timestamp" mode="IN" optional="true"/>
        <attribute name="reservLength" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="reservPersons" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="quantityPurchased" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="configId" type="String" mode="IN" optional="true"/>
    </service>
    <service name="createShoppingListItem" engine="groovy" auth="false"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="createShoppingListItem">
        <description>Create a shopping list item</description>
        <permission-service service-name="checkShoppingListItemSecurity" main-action="CREATE"/>
        <implements service="shoppingListItemInterface"/>
        <attribute name="shoppingListId" type="String" mode="IN" optional="true"/>
        <attribute name="productStoreId" type="String" mode="INOUT" optional="true"/>
        <attribute name="productId" type="String" mode="IN" optional="false"/>
        <attribute name="shoppingListItemAttributes" type="Map" mode="IN" optional="true"/>
        <attribute name="shoppingListItemSeqId" type="String" mode="OUT" optional="false"/>
    </service>
    <service name="updateShoppingListItem" engine="groovy" auth="true"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="updateShoppingListItem">
        <description>Update a shopping list item</description>
        <permission-service service-name="checkShoppingListItemSecurity" main-action="UPDATE"/>
        <implements service="shoppingListItemInterface"/>
        <attribute name="shoppingListItemSeqId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="removeShoppingListItem" engine="groovy" auth="true"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="removeShoppingListItem">
        <description>Remove a shopping list item</description>
        <permission-service service-name="checkShoppingListItemSecurity" main-action="DELETE"/>
        <attribute name="shoppingListId" type="String" mode="IN" optional="false"/>
        <attribute name="shoppingListItemSeqId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="checkShoppingListItemSecurity" engine="groovy" auth="false"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="checkShoppingListItemSecurity">
        <description>Checks security on a ShoppingListItem</description>
        <implements service="permissionInterface"/>
        <attribute name="partyId" type="String" mode="IN" optional="true"/>
        <attribute name="shoppingListId" type="String" mode="IN" optional="true"/>
    </service>
    <service name="addSuggestionsToShoppingList" engine="groovy" auth="true"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="addSuggestionsToShoppingList">
        <description>Add suggestions to a shopping list</description>
        <attribute name="orderId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="addDistinctShoppingListItem" engine="groovy" auth="true"
            location="component://order/src/main/groovy/org/apache/ofbiz/order/shoppinglist/ShoppingListServicesScript.groovy" invoke="addDistinctShoppingListItem">
        <description>Adds a shopping list item if one with the same productId does not exist</description>
        <implements service="shoppingListItemInterface"/>
        <attribute name="shoppingListId" type="String" mode="IN" optional="false"/>
        <attribute name="productStoreId" type="String" mode="INOUT" optional="true"/>
        <attribute name="productId" type="String" mode="IN" optional="false"/>
        <attribute name="shoppingListItemSeqId" type="String" mode="OUT" optional="false"/>
    </service>

    <service name="autoDeleteAutoSaveShoppingList" engine="java" auth="true" max-retry="3" transaction-timeout="3600"
            location="org.apache.ofbiz.order.shoppinglist.ShoppingListServices" invoke="autoDeleteAutoSaveShoppingList">
            <description>
                Automatic delete auto save shopping list for anonymous users that are not updated in last 30 days.
                Default to 30 days unless no configuration is specified.
            </description>
    </service>

    <service name="createShoppingListItemSurvey" default-entity-name="ShoppingListItemSurvey" engine="entity-auto" invoke="create" auth="true">
        <description>Create a ShoppingListItemSurvey Record</description>
        <auto-attributes include="pk" mode="IN"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteShoppingListItemSurvey" default-entity-name="ShoppingListItemSurvey" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete a ShoppingListItemSurvey Record</description>
        <auto-attributes include="pk" mode="IN"/>
    </service>

    <service name="createShoppingListType" default-entity-name="ShoppingListType" engine="entity-auto" invoke="create" auth="true">
        <description>Create a ShoppingListType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateShoppingListType" default-entity-name="ShoppingListType" engine="entity-auto" invoke="update" auth="true">
        <description>Update a ShoppingListType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteShoppingListType" default-entity-name="ShoppingListType" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete a ShoppingListType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>
</services>