* [Improved]: Use GroovyBaseScript's logging utility methods instead of using Debug - Replaced the debug.log methods with the respective groovy utility method - Enhanced the GroovyBaseScript to entertain the fetch the current class name as the module name for logging - Overloaded the logError method to entertain throwbale object for better logging - Removed unused import statements and module variables. (OFBIZ-11762) * [Removed]: Extra line spaces. (OFBIZ-11762) * [Revert]: Unwanted changes. (OFBIZ-11762) * [Added] Same changes to these files. (OFBIZ-11762) Co-authored-by: Priya Sharma <priya.sharma@example.com>
133 lines
5.8 KiB
Groovy
133 lines
5.8 KiB
Groovy
/*
|
|
* 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.
|
|
*/
|
|
|
|
import org.apache.ofbiz.base.util.Debug
|
|
import org.apache.ofbiz.base.util.UtilDateTime
|
|
import org.apache.ofbiz.base.util.UtilValidate
|
|
import org.apache.ofbiz.entity.GenericValue
|
|
import org.apache.ofbiz.service.ServiceUtil
|
|
|
|
import java.sql.Timestamp
|
|
|
|
def getNextInvoiceId() {
|
|
result = success()
|
|
|
|
// try to find PartyAcctgPreference for parameters.partyId, see if we need any special invoice number sequencing
|
|
GenericValue partyAcctgPreference = from('PartyAcctgPreference').where(parameters).queryOne()
|
|
if (Debug.infoOn()) logInfo("In getNextInvoiceId partyId is [${parameters.partyId}], partyAcctgPreference: ${partyAcctgPreference}")
|
|
|
|
String customMethodName = null;
|
|
String invoiceIdPrefix = '';
|
|
if (partyAcctgPreference) {
|
|
invoiceIdPrefix = partyAcctgPreference.invoiceIdPrefix
|
|
//see OFBIZ-3765 beware of OFBIZ-3557
|
|
GenericValue customMethod = partyAcctgPreference.getRelatedOne('InvoiceCustomMethod', true)
|
|
if (customMethod) {
|
|
customMethodName = customMethod.customMethodName
|
|
} else {
|
|
//retrieve service from deprecated enumeration see OFBIZ-3765 beware of OFBIZ-3557
|
|
if ('INVSQ_ENF_SEQ' == partyAcctgPreference.oldInvoiceSequenceEnumId) {
|
|
customMethodName = 'invoiceSequenceEnforced'
|
|
}
|
|
if ('INVSQ_RESTARTYR' == partyAcctgPreference.oldInvoiceSequenceEnumId) {
|
|
customMethodName = 'invoiceSequenceRestart'
|
|
}
|
|
}
|
|
} else {
|
|
logWarning('Acctg preference not defined for partyId [${parameters.partyId}]')
|
|
}
|
|
|
|
String invoiceIdTemp = ''
|
|
if (customMethodName) {
|
|
parameters.partyAcctgPreference = partyAcctgPreference
|
|
Map serviceResult = run service: customMethodName, with: parameters
|
|
if (ServiceUtil.isError(serviceResult)) return serviceResult
|
|
invoiceIdTemp = serviceResult.invoiceId
|
|
} else {
|
|
logInfo('In createInvoice sequence enum Standard')
|
|
//default to the default sequencing: INVSQ_STANDARD
|
|
invoiceIdTemp = parameters.invoiceId
|
|
if (!invoiceIdTemp) {
|
|
invoiceIdTemp = delegator.getNextSeqId('Invoice', 1)
|
|
} else {
|
|
//check the provided ID
|
|
errorMsg = UtilValidate.checkValidDatabaseId(invoiceIdTemp)
|
|
if (errorMsg != null) {
|
|
return error("In getNextInvoiceId ${errorMsg}")
|
|
}
|
|
}
|
|
}
|
|
|
|
// use invoiceIdTemp along with the invoiceIdPrefix to create the real ID
|
|
String invoiceId = invoiceIdPrefix + invoiceIdTemp
|
|
result.invoiceId = invoiceId
|
|
return result
|
|
}
|
|
|
|
def invoiceSequenceEnforced() {
|
|
result = success()
|
|
|
|
logInfo('In createInvoice sequence enum Enforced')
|
|
GenericValue partyAcctgPreference = parameters.partyAcctgPreference
|
|
//this is sequential sequencing, we can't skip a number, also it must be a unique sequence per partyIdFrom
|
|
|
|
Long lastInvoiceNumber = 1
|
|
if (partyAcctgPreference.lastInvoiceNumber) {
|
|
lastInvoiceNumber = partyAcctgPreference.lastInvoiceNumber + 1
|
|
}
|
|
|
|
partyAcctgPreference.lastInvoiceNumber = lastInvoiceNumber
|
|
delegator.store(partyAcctgPreference)
|
|
result.invoiceId = lastInvoiceNumber
|
|
return result
|
|
}
|
|
|
|
def invoiceSequenceRestart() {
|
|
result = success()
|
|
|
|
logInfo('In createInvoice sequence enum Enforced')
|
|
GenericValue partyAcctgPreference = parameters.partyAcctgPreference
|
|
//this is sequential sequencing, we can't skip a number, also it must be a unique sequence per partyIdFrom
|
|
|
|
Timestamp nowTimestamp = UtilDateTime.nowTimestamp()
|
|
if (!partyAcctgPreference.lastInvoiceRestartDate) {
|
|
//if no lastInvoiceRestartDate then it's easy, just start now with 1
|
|
partyAcctgPreference.lastInvoiceNumber = 1l
|
|
partyAcctgPreference.lastInvoiceRestartDate = nowTimestamp
|
|
} else {
|
|
//first figure out if we need to reset the lastInvoiceNumber; is the lastInvoiceRestartDate after the fiscalYearStartMonth/Day for this year?
|
|
curYearFiscalStartDate = UtilDateTime.getYearStart(nowTimestamp, partyAcctgPreference.fiscalYearStartDay, partyAcctgPreference.fiscalYearStartMonth, 0l)
|
|
if (partyAcctgPreference.lastInvoiceRestartDate < curYearFiscalStartDate && nowTimestamp >= curYearFiscalStartDate) {
|
|
//less than fiscal year start, we need to reset it
|
|
partyAcctgPreference.lastInvoiceNumber = 1l
|
|
partyAcctgPreference.lastInvoiceRestartDate = nowTimestamp
|
|
} else {
|
|
//greater than or equal to fiscal year start or nowTimestamp hasn't yet hit the current year fiscal start date, we're okay, just increment
|
|
partyAcctgPreference.lastInvoiceNumber += 1l
|
|
}
|
|
}
|
|
delegator.store(partyAcctgPreference)
|
|
|
|
//get the current year string for prefix, etc; simple 4 digit year date string (using system defaults)
|
|
Integer curYearString = UtilDateTime.getYear(partyAcctgPreference.lastInvoiceRestartDate, timeZone, locale)
|
|
result.invoiceId = "${curYearString}-${partyAcctgPreference.lastInvoiceNumber}"
|
|
return result
|
|
}
|
|
|