<?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>Accounting Services: Rate and related services</description>
    <vendor>OFBiz</vendor>
    <version>1.0</version>

    <service name="updateRateAmount" default-entity-name="RateAmount" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="updateRateAmount">
        <description>Create/update Rate Amount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="all" mode="IN" optional="true"/>
        <override name="rateTypeId" optional="false"/>
        <override name="rateAmount" optional="false"/>
        <override name="emplPositionTypeId" default-value="_NA_"/>
        <override name="workEffortId" default-value="_NA_"/>
        <override name="periodTypeId" default-value="RATE_HOUR"/>
        <override name="partyId" default-value="_NA_"/>
    </service>
    <service name="expireRateAmount" default-entity-name="RateAmount" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="expireRateAmount">
        <description>expire Rate Amount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <override name="rateTypeId" optional="false"/>
        <override name="fromDate" optional="false"/>
        <override name="emplPositionTypeId" default-value="_NA_"/>
        <override name="workEffortId" default-value="_NA_"/>
        <override name="periodTypeId" default-value="RATE_HOUR"/>
        <override name="partyId" default-value="_NA_"/>
    </service>
    <service name="deleteRateAmount" default-entity-name="RateAmount" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="deleteRateAmount">
        <description>Deprecated please use expireRateAmount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <override name="rateTypeId" optional="false"/>
        <override name="fromDate" optional="false"/>
    </service>
    <service name="getRateAmount" default-entity-name="RateAmount" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="getRateAmount">
        <description>Get Rate Amount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="VIEW"/>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <attribute name="level" type="String" mode="OUT" optional="true"/><!-- the level the amount was retrieved from(specific -> general): workEffort, party, emplPositionType, rateType or 'null' if not found-->
        <attribute name="rateAmount" type="BigDecimal" mode="OUT" optional="true"/>
        <attribute name="periodTypeId" type="String" mode="INOUT" optional="true" default-value="RATE_HOUR"/>
        <attribute name="rateCurrencyUomId" type="String" mode="INOUT" optional="true"/>
        <attribute name="fromDate" type="Timestamp" mode="OUT" optional="true"/>
        <override name="rateTypeId" optional="false"/>
    </service>
    <service name="getRatesAmountsFromWorkEffortId" default-entity-name="RateAmount" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="getRatesAmountsFromWorkEffortId">
        <description>Get all Rates Amounts for a given workEffortId</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="VIEW"/>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <attribute name="periodTypeId" type="String" mode="INOUT" optional="true"/>
        <attribute name="rateCurrencyUomId" type="String" mode="INOUT" optional="true"/>
        <attribute name="ratesList" type="List" mode="OUT" optional="true"/>
        <override name="workEffortId" optional="false"/>
    </service>
    <service name="getRatesAmountsFromPartyId" default-entity-name="RateAmount" engine="groovy" auth="true"
             location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="getRatesAmountsFromPartyId">
        <description>Get all Rates Amounts for a given partyId</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="VIEW"/>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <attribute name="periodTypeId" type="String" mode="INOUT" optional="true"/>
        <attribute name="rateCurrencyUomId" type="String" mode="INOUT" optional="true"/>
        <attribute name="ratesList" type="List" mode="OUT" optional="true"/>
        <override name="partyId" optional="false"/>
    </service>
    <service name="getRatesAmountsFromEmplPositionTypeId" default-entity-name="RateAmount" engine="groovy" auth="true"
             location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="getRatesAmountsFromEmplPositionTypeId">
        <description>Get all Rates Amounts for a given emplPositionTypeId</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="VIEW"/>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <attribute name="periodTypeId" type="String" mode="INOUT" optional="true"/>
        <attribute name="rateCurrencyUomId" type="String" mode="INOUT" optional="true"/>
        <attribute name="ratesList" type="List" mode="OUT" optional="true"/>
        <override name="emplPositionTypeId" optional="false"/>
    </service>
    <service name="filterRateAmountList" default-entity-name="RateAmount" engine="groovy" auth="true"
             location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="filterRateAmountList">
        <description>Get the most specific non-empty Rate Amount list from a list of Rate Amount, given the input parameters :
        workEffortId, partyId, emplPositionTypeId and rateTypeId</description>
        <auto-attributes include="pk" mode="IN" optional="true"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <attribute name="ratesList" type="List" mode="IN" optional="true"/>
        <attribute name="filteredRatesList" type="List" mode="OUT" optional="true"/>
    </service>

    <!-- PartyRate Services -->
    <service name="updatePartyRate" default-entity-name="PartyRate" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="updatePartyRate">
        <description>Creates PartyRate</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <attribute name="organizationPartyId" type="String" mode="IN" optional="true"/>
        <attribute name="rateAmount" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="rateCurrencyUomId" type="String" mode="IN" optional="true"/>
        <attribute name="periodTypeId" type="String" mode="IN"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="deletePartyRate" default-entity-name="PartyRate" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="deletePartyRate">
        <description>Deletes PartyRate</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <attribute name="rateAmountFromDate" type="Timestamp" mode="IN" optional="true"/>
    </service>
    <service name="expirePartyRate" default-entity-name="PartyRate" engine="groovy" auth="true"
        location="component://accounting/groovyScripts/rate/RateServices.groovy" invoke="expirePartyRate">
        <description>Expire PartyRate and expire related rateAmount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <attribute name="rateAmountFromDate" type="Timestamp" mode="IN" optional="true"/><!-- to be able to expire rateamount specific to a party records....-->
    </service>

    <!-- RateType services -->
    <service name="createRateType" default-entity-name="RateType" engine="entity-auto" invoke="create" auth="true">
        <description>Create a RateType</description>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <auto-attributes include="pk" mode="INOUT" optional="true"/>
    </service>
    <service name="updateRateType" default-entity-name="RateType" engine="entity-auto" invoke="update" auth="true">
        <description>Update a RateType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteRateType" default-entity-name="RateType" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete a RateType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

</services>
