com.accela.aa.emse.dom

Class FeeScript

java.lang.Object

com.accela.aa.emse.dom.service.BaseAAScript

com.accela.aa.emse.dom.FeeScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.FeeScriptService, com.accela.aa.emse.dom.service.ScriptAble

public class FeeScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.FeeScriptService

 
  
   
    Accela Automation
    File: FeeScript.java
   
    Accela, Inc.
    Copyright (C): 2001-2014
   
    Description:
   
    Notes:
    $Id: FeeScript.java 270462 2014-04-28 10:05:58Z ..\rain.wang $
   
    Revision History:
    12/13/01, Emil Andresen, Initial Version
    03/07/02, Carl Zhu     , Add one method: getOneRWC(FeeROC feeItem)
    05/11/02, jlu            rename Fee to FeeManager, remove getOneRWC, getFeeTotal(id123),
                             findbyxxxxx
    06/14/02 jlu             change method name getFeeItem to getFeeItems
    08/06/02, Keivin Xu      Add methods getFeeItem and getFeeTotal
    02/19/04, Kevin.Liu      Add method getFeeItemOfInvoicedbyCapID().
    07/18/05  Edwin Lin      Add the method named addFeeItem() for 05act-06174
    04/27/06  Henvy Jiang    Add the method named getFeeItemByPK
    11/01/2006 Michael Mao      cache service object.
  
 

Constructor Summary

Constructors

Constructor and Description
FeeScript() Constructor for FeeScript.
FeeScript(java.lang.String serviceProviderCode, java.lang.String auditID, com.accela.aa.emse.dom.service.CachedService cachedService) Constructor for FeeScript.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	addFeeItem(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String paymentPeriod, java.lang.String feeCod, java.lang.String Display, java.lang.String feeDescription, java.lang.String accCodeL1, java.lang.String accCodeL2, java.lang.String accCodeL3, java.lang.String formula, double feeUnit, java.lang.String udes, double fee, com.accela.aa.emse.util.ScriptDateTime applyDate, com.accela.aa.emse.util.ScriptDateTime effectDate, com.accela.aa.emse.util.ScriptDateTime expireDate, java.lang.String udf1, java.lang.String udf2, java.lang.String udf3, java.lang.String udf4, java.lang.String subgroup, java.lang.String calcFlag, java.lang.String feeitemStatus, java.lang.String feeCalcProc, java.lang.String auditID) Add FeeItem.
ScriptResult	addFeeItem(java.util.Collection feeItemModels) auto Invoicing Of Fee
ScriptResult	addFeeItem(FeeItemScriptModel scriptF4feeitemROC) Add FeeItem.
F4FeeItemScriptModel	createF4FeeItemScriptModel() createF4FeeItemScriptModel
ScriptResult	editFeeNotes(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String feeNote, long feeSeqNbr) edit fee notes
ScriptResult	getFeeItemByPK(com.accela.aa.aamain.cap.CapIDModel capID, long feeSeqNbr) get a fee item from F4FEEITEM table
ScriptResult	getFeeItemOfInvoicedByCapID(com.accela.aa.aamain.cap.CapIDModel capID) Get all records of FeeItems that have been invoiced from F4FeeItem and X4FeeItem_Invoice.
ScriptResult	getFeeItems(com.accela.aa.aamain.cap.CapIDModel capID) Get FeeItems.
ScriptResult	getFeeItems(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String feeCode, java.lang.String status) getFeeItems.
ScriptResult	getFeeTotal(com.accela.aa.aamain.cap.CapIDModel capID) Get total fee by capID.
ScriptResult	getFeeTotal(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String paymentPeriod) Get total fee by capID and paymentPeriod.
ScriptResult	getRefFeeItemByFeeCode(java.lang.String feeSchedule, java.lang.String feeCode, java.lang.String payPeriodGroup, com.accela.aa.emse.util.ScriptDateTime expDate) Get RefFeeItem by fee code.
ScriptResult	getRefFeeItemByFeeCodeVersion(java.lang.String feeSchedule, java.lang.String version, java.lang.String feeCode, java.lang.String payPeriodGroup, com.accela.aa.emse.util.ScriptDateTime expDate) Get RefFeeItem by fee code.
ScriptResult	getRefFeeScheduleVersionsByDate(java.lang.String feeSchedule, com.accela.aa.emse.util.ScriptDateTime checkDate) Get array of enabled Fee Schedule objects by date
ScriptResult	getScriptF4FeeItemModel(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String paymentPeriod, java.lang.String feeCod, java.lang.String Display, java.lang.String feeDescription, java.lang.String accCodeL1, java.lang.String accCodeL2, java.lang.String accCodeL3, java.lang.String formula, double feeUnit, java.lang.String udes, double fee, com.accela.aa.emse.util.ScriptDateTime applyDate, com.accela.aa.emse.util.ScriptDateTime effectDate, com.accela.aa.emse.util.ScriptDateTime expireDate, java.lang.String udf1, java.lang.String udf2, java.lang.String udf3, java.lang.String udf4, java.lang.String subgroup, java.lang.String calcFlag, java.lang.String feeitemStatus, java.lang.String feeCalcProc, java.lang.String auditID) Add F4FeeItemModel.
ScriptResult	getScriptF4FeeItemModel(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String paymentPeriod, java.lang.String feeCod, java.lang.String Display, java.lang.String feeDescription, java.lang.String accCodeL1, java.lang.String accCodeL2, java.lang.String accCodeL3, java.lang.String formula, double feeUnit, java.lang.String udes, double fee, com.accela.aa.emse.util.ScriptDateTime applyDate, com.accela.aa.emse.util.ScriptDateTime effectDate, com.accela.aa.emse.util.ScriptDateTime expireDate, java.lang.String udf1, java.lang.String udf2, java.lang.String udf3, java.lang.String udf4, java.lang.String subgroup, java.lang.String calcFlag, java.lang.String feeitemStatus, java.lang.String feeCalcProc, java.lang.String auditID, java.lang.String feeAllocatedType, java.lang.Double accountCode1Allocation, java.lang.Double accountCode2Allocation, java.lang.Double accountCode3Allocation)
ScriptResult	isFullPaid4Renewal(com.accela.aa.aamain.cap.CapIDModel capIDModel) Get fee balance due by capID.

Methods inherited from class com.accela.aa.emse.dom.service.BaseAAScript

initScript

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.accela.aa.emse.dom.service.ScriptAble

initScript

Constructor Detail

FeeScript

public FeeScript(java.lang.String serviceProviderCode,
         java.lang.String auditID,
         com.accela.aa.emse.dom.service.CachedService cachedService)
          throws com.accela.aa.exception.AAException

Constructor for FeeScript.

Parameters:

serviceProviderCode - agency code

auditID - the caller id

Throws:

com.accela.aa.exception.AAException - the AA exception

FeeScript

public FeeScript()
          throws com.accela.aa.exception.AAException

Constructor for FeeScript.

Throws:

com.accela.aa.exception.AAException - the AA exception

Method Detail

getFeeItems

public ScriptResult getFeeItems(com.accela.aa.aamain.cap.CapIDModel capID)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Get FeeItems.

Specified by:

getFeeItems in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

capID - CapIDModel

Returns:

ScriptResult

getFeeTotal

public ScriptResult getFeeTotal(com.accela.aa.aamain.cap.CapIDModel capID)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Get total fee by capID.

Specified by:

getFeeTotal in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

capID - CapIDModel

Returns:

ScriptResult

addFeeItem

public ScriptResult addFeeItem(FeeItemScriptModel scriptF4feeitemROC)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Add FeeItem.

Specified by:

addFeeItem in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

scriptF4feeitemROC - FeeItemScriptModel

Returns:

ScriptResult

addFeeItem

public ScriptResult addFeeItem(com.accela.aa.aamain.cap.CapIDModel capID,
                      java.lang.String paymentPeriod,
                      java.lang.String feeCod,
                      java.lang.String Display,
                      java.lang.String feeDescription,
                      java.lang.String accCodeL1,
                      java.lang.String accCodeL2,
                      java.lang.String accCodeL3,
                      java.lang.String formula,
                      double feeUnit,
                      java.lang.String udes,
                      double fee,
                      com.accela.aa.emse.util.ScriptDateTime applyDate,
                      com.accela.aa.emse.util.ScriptDateTime effectDate,
                      com.accela.aa.emse.util.ScriptDateTime expireDate,
                      java.lang.String udf1,
                      java.lang.String udf2,
                      java.lang.String udf3,
                      java.lang.String udf4,
                      java.lang.String subgroup,
                      java.lang.String calcFlag,
                      java.lang.String feeitemStatus,
                      java.lang.String feeCalcProc,
                      java.lang.String auditID)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Add FeeItem.

Specified by:

addFeeItem in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

capID - CapIDModel

paymentPeriod - payment period

feeCod - fee code

Display - display

feeDescription - fee description

accCodeL1 - accCodeL1

accCodeL2 - accCodeL2

accCodeL3 - accCodeL3

formula - the fee formula

feeUnit - the fee unit

udes - udes

fee - fee

applyDate - the apply date

effectDate - the effect date

expireDate - the effect date

udf1 - udf1

udf2 - udf2

udf3 - udf3

udf4 - udf4

subgroup - subgroup

calcFlag - calc flag

feeitemStatus - fee item status

feeCalcProc - fee calc process

auditID - the caller id

Returns:

ScriptResult

getFeeTotal

public ScriptResult getFeeTotal(com.accela.aa.aamain.cap.CapIDModel capID,
                       java.lang.String paymentPeriod)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Get total fee by capID and paymentPeriod.

Specified by:

getFeeTotal in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

capID - CapIDModel

paymentPeriod - payment period

Returns:

ScriptResult

getRefFeeItemByFeeCode

public ScriptResult getRefFeeItemByFeeCode(java.lang.String feeSchedule,
                                  java.lang.String feeCode,
                                  java.lang.String payPeriodGroup,
                                  com.accela.aa.emse.util.ScriptDateTime expDate)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Get RefFeeItem by fee code.

Specified by:

getRefFeeItemByFeeCode in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

feeSchedule - fee schedule

feeCode - fee code

payPeriodGroup - pay period group

expDate - expiration date

Returns:

ScriptResult

getRefFeeItemByFeeCodeVersion

public ScriptResult getRefFeeItemByFeeCodeVersion(java.lang.String feeSchedule,
                                         java.lang.String version,
                                         java.lang.String feeCode,
                                         java.lang.String payPeriodGroup,
                                         com.accela.aa.emse.util.ScriptDateTime expDate)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Get RefFeeItem by fee code.

Specified by:

getRefFeeItemByFeeCodeVersion in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

feeSchedule - fee schedule

feeCode - fee code

payPeriodGroup - pay period group

expDate - expiration date

Returns:

ScriptResult

getScriptF4FeeItemModel

public ScriptResult getScriptF4FeeItemModel(com.accela.aa.aamain.cap.CapIDModel capID,
                                   java.lang.String paymentPeriod,
                                   java.lang.String feeCod,
                                   java.lang.String Display,
                                   java.lang.String feeDescription,
                                   java.lang.String accCodeL1,
                                   java.lang.String accCodeL2,
                                   java.lang.String accCodeL3,
                                   java.lang.String formula,
                                   double feeUnit,
                                   java.lang.String udes,
                                   double fee,
                                   com.accela.aa.emse.util.ScriptDateTime applyDate,
                                   com.accela.aa.emse.util.ScriptDateTime effectDate,
                                   com.accela.aa.emse.util.ScriptDateTime expireDate,
                                   java.lang.String udf1,
                                   java.lang.String udf2,
                                   java.lang.String udf3,
                                   java.lang.String udf4,
                                   java.lang.String subgroup,
                                   java.lang.String calcFlag,
                                   java.lang.String feeitemStatus,
                                   java.lang.String feeCalcProc,
                                   java.lang.String auditID)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Add F4FeeItemModel.

Specified by:

getScriptF4FeeItemModel in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

capID - CapIDModel

paymentPeriod - payment period

feeCod - fee code

Display - display

feeDescription - fee description

accCodeL1 - accCodeL1

accCodeL2 - accCodeL2

accCodeL3 - accCodeL3

formula - the fee formula

feeUnit - the fee unit

udes - udes

fee - fee

applyDate - the apply date

effectDate - the effect date

expireDate - the effect date

udf1 - udf1

udf2 - udf2

udf3 - udf3

udf4 - udf4

subgroup - subgroup

calcFlag - calc flag

feeitemStatus - fee item status

feeCalcProc - fee calc process

auditID - the caller id

Returns:

ScriptResult

getFeeItemOfInvoicedByCapID

public ScriptResult getFeeItemOfInvoicedByCapID(com.accela.aa.aamain.cap.CapIDModel capID)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

Get all records of FeeItems that have been invoiced from F4FeeItem and X4FeeItem_Invoice.

Specified by:

getFeeItemOfInvoicedByCapID in interface com.accela.aa.emse.dom.service.FeeScriptService

Parameters:

capID - CapIDModel

Returns:

@author Kevin.Liu

addFeeItem

public ScriptResult addFeeItem(java.util.Collection feeItemModels)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

auto Invoicing Of Fee

Specified by:

addFeeItem in interface com.accela.aa.emse.dom.service.FeeScriptService

Returns:

ScriptResult

getFeeItemByPK

public ScriptResult getFeeItemByPK(com.accela.aa.aamain.cap.CapIDModel capID,
                          long feeSeqNbr)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

get a fee item from F4FEEITEM table

Specified by:

getFeeItemByPK in interface com.accela.aa.emse.dom.service.FeeScriptService

Returns:

ScriptResult

editFeeNotes

public ScriptResult editFeeNotes(com.accela.aa.aamain.cap.CapIDModel capID,
                        java.lang.String feeNote,
                        long feeSeqNbr)

edit fee notes

Parameters:

capID -

feeNote -

feeSeqNbr -

Returns:

ScriptResult

createF4FeeItemScriptModel

public F4FeeItemScriptModel createF4FeeItemScriptModel()

createF4FeeItemScriptModel

Specified by:

createF4FeeItemScriptModel in interface com.accela.aa.emse.dom.service.FeeScriptService

Returns:

F4FeeItemScriptModel

isFullPaid4Renewal

public ScriptResult isFullPaid4Renewal(com.accela.aa.aamain.cap.CapIDModel capIDModel)

Get fee balance due by capID.

Parameters:

capIDModel - cap ID model

Returns:

script result

getRefFeeScheduleVersionsByDate

public ScriptResult getRefFeeScheduleVersionsByDate(java.lang.String feeSchedule,
                                           com.accela.aa.emse.util.ScriptDateTime checkDate)

Get array of enabled Fee Schedule objects by date

Parameters:

feeSchedule - feeSchedule

checkDate - checkDate, need to check the date

Returns:

ScriptResult

getFeeItems

public ScriptResult getFeeItems(com.accela.aa.aamain.cap.CapIDModel capID,
                       java.lang.String feeCode,
                       java.lang.String status)

Description copied from interface: com.accela.aa.emse.dom.service.FeeScriptService

getFeeItems.

Specified by:

getFeeItems in interface com.accela.aa.emse.dom.service.FeeScriptService

Returns:

ScriptResult for Fee items

getScriptF4FeeItemModel

public ScriptResult getScriptF4FeeItemModel(com.accela.aa.aamain.cap.CapIDModel capID,
                                   java.lang.String paymentPeriod,
                                   java.lang.String feeCod,
                                   java.lang.String Display,
                                   java.lang.String feeDescription,
                                   java.lang.String accCodeL1,
                                   java.lang.String accCodeL2,
                                   java.lang.String accCodeL3,
                                   java.lang.String formula,
                                   double feeUnit,
                                   java.lang.String udes,
                                   double fee,
                                   com.accela.aa.emse.util.ScriptDateTime applyDate,
                                   com.accela.aa.emse.util.ScriptDateTime effectDate,
                                   com.accela.aa.emse.util.ScriptDateTime expireDate,
                                   java.lang.String udf1,
                                   java.lang.String udf2,
                                   java.lang.String udf3,
                                   java.lang.String udf4,
                                   java.lang.String subgroup,
                                   java.lang.String calcFlag,
                                   java.lang.String feeitemStatus,
                                   java.lang.String feeCalcProc,
                                   java.lang.String auditID,
                                   java.lang.String feeAllocatedType,
                                   java.lang.Double accountCode1Allocation,
                                   java.lang.Double accountCode2Allocation,
                                   java.lang.Double accountCode3Allocation)