com.accela.aa.emse.dom

Class LicenseScript

java.lang.Object

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

com.accela.aa.emse.dom.LicenseScript

All Implemented Interfaces:

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

public class LicenseScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.LicenseScriptService

 
 Accela Automation
 File: LicenseScript.java
 
 Accela, Inc.
 Copyright (C): 2004-2014
 
 Description:
 Provides the "aa.LicenseScript" object through which script writers can
 operate on to perform the "License" object related functions.
 
 Notes:
 $Id: LicenseScript.java 270462 2014-04-28 10:05:58Z ..\rain.wang $
 
 Revision History:
 01/12/04       Edwin lin               Initial version.
 11/01/2006     Michael Mao     cache service object.
 12/26/2006     Tony Wu         update method getRefLicenseProfBySeqNbr to get the attributes for the LicenseScriptModel.
 01/31/2007     Chandler Huang  Update the getRefLicensesProfByLicNbr(...) and getRefLicensesProfByName(...) for getting attributes for LicenseProfession
 

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	associateContactWithPublicUser(java.lang.String publicUserSeqNbr, java.lang.String contactSeqNbr) Associate the contact with the specific public user .
ScriptResult	associateLpWithCap(com.accela.aa.aamain.cap.CapIDModel capId, LicenseScriptModel license) Associate the license with the specific cap.
ScriptResult	associateLpWithPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser, LicenseScriptModel license) Associate the licesne with the specific public user, and the notice mail will be sent to the PublicUser and the Agency User.
ScriptResult	checkTradeNamesGroupByGroup(CapScriptModel cap, java.lang.String tradeName1Key1, java.lang.String tradeName2Key1, java.lang.String tradeName1Key2, java.lang.String tradeName2Key2, java.lang.String tradeName1Key3, java.lang.String tradeName2Key3) Check trade names group by group.
ScriptResult	createApprovalTradeNameLicense(CapScriptModel capScriptModel, com.accela.v360.publicuser.PublicUserModel publicUser, java.lang.String licenseType, java.lang.String englishTradeName, java.lang.String arabicTradeName, java.lang.String legalFormKey, java.lang.String financeNbrKey) Create an Approval TradeName License.
ScriptResult	createApprovalTradeNameLicense(CapScriptModel capScriptModel, com.accela.v360.publicuser.PublicUserModel publicUser, java.lang.String licenseType, java.lang.String tradeName1Key1, java.lang.String tradeName1Key2, java.lang.String tradeName1Key3, java.lang.String tradeName2Key1, java.lang.String tradeName2Key2, java.lang.String tradeName2Key3, java.lang.String legalFormKey, java.lang.String financeNbrKey) Create an Approval TradeName License, and write it to DB.
ScriptResult	createAssociatedLicenseProfessional(CapScriptModel capScriptModel, java.lang.String licenseType, java.lang.String tradeName1Key1, java.lang.String tradeName1Key2, java.lang.String tradeName1Key3, java.lang.String tradeName2Key1, java.lang.String tradeName2Key2, java.lang.String tradeName2Key3, java.lang.String legalFormKey, java.lang.String financeNbrKey) Create Approval TradeName License, assocaite the LP to the specific cap associate the LP to the public user send the approval notice mail to the public user it same as invoking: 1.createApprovalTradeNameLicense(); 2.associateWithCap(); 3.associateWithPublicUser(); 4.sendNoticeMailToUser().
LicenseScriptModel	createLicenseScriptModel() Add a LicenseScriptModel.
PeopleAttributeScriptModel	createPeopleAttributeScriptModel() Creates the people attribute script model.
ScriptResult	createRefLicenseProf(LicenseScriptModel licenseScriptModel) Copy License to Lic.
ScriptResult	editRefLicenseProf(LicenseScriptModel licenseScriptModel) Get LicenseScriptModel.
ScriptResult	getCapIDsByLicenseModel(LicenseScriptModel licenseScriptModel) Get Caps by LicenseModel.
ScriptResult	getLicenseProf(com.accela.aa.aamain.cap.CapIDModel capID) Get LicenseProfessionals from Lic.
ScriptResult	getProviderBySeq(java.lang.String providerNbr) Gets the provider by seq.
com.accela.v360.publicuser.PublicUserModel	getPublicUserByUserName(java.lang.String puserUserName) Get the public user by the userName.
ScriptResult	getRefLicenseProfByProviderNo(java.lang.String providerNo) Gets the license professional by provider no.
ScriptResult	getRefLicenseProfBySeqNbr(java.lang.String serviceProviderCode, java.lang.Long seqNbr) Get LicenseScriptModel.
ScriptResult	getRefLicensesProfByLicNbr(java.lang.String serviceProviderCode, java.lang.String licenseNbr) Get a collection of LicenseScriptModel.
ScriptResult	getRefLicensesProfByName(java.lang.String serviceProviderCode, java.lang.String fName, java.lang.String mName, java.lang.String lName) Get LicenseScriptModel.
ScriptResult	getRefLicProfByOnlineUser(java.lang.String userSeqNbr) Get all reference license professional by the user sequence number.
ScriptResult	getTradeNameList(java.lang.String businessName, java.lang.String businessName2) Return list of trade names by BusinessName and BusName2.
ScriptResult	isApproveTradeName(CapScriptModel cap, java.lang.String filterName, java.lang.String currentModuleName, java.lang.String status) Judge the status change is whether for approving trade name.
ScriptResult	notifyPublicUserByEmail(com.accela.v360.publicuser.PublicUserModel publicUser, LicenseScriptModel license) Send the notice mail about approval trade name to the public user
ScriptResult	updateLicenseStatusByTypeAndNbr(java.lang.String licenseType, java.lang.String licenseNbr, java.lang.String auditStatus) update the status of license.

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

LicenseScript

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

Constructor for LicenseScript.

Parameters:

serviceProviderCode - agency code

auditID - the audit id

Throws:

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

LicenseScript

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

Constructor for LicenseScript.

Throws:

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

Method Detail

createLicenseScriptModel

public LicenseScriptModel createLicenseScriptModel()

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

Add a LicenseScriptModel.

Specified by:

createLicenseScriptModel in interface com.accela.aa.emse.dom.service.LicenseScriptService

Returns:

LicenseScriptModel

createPeopleAttributeScriptModel

public PeopleAttributeScriptModel createPeopleAttributeScriptModel()

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

Creates the people attribute script model.

Specified by:

createPeopleAttributeScriptModel in interface com.accela.aa.emse.dom.service.LicenseScriptService

Returns:

the people attribute script model

createRefLicenseProf

public ScriptResult createRefLicenseProf(LicenseScriptModel licenseScriptModel)

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

Copy License to Lic. Prof. reference table .

Specified by:

createRefLicenseProf in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

licenseScriptModel - the license script model

Returns:

ScriptResult

editRefLicenseProf

public ScriptResult editRefLicenseProf(LicenseScriptModel licenseScriptModel)

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

Get LicenseScriptModel.

Specified by:

editRefLicenseProf in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

licenseScriptModel - LicenseScriptModel

Returns:

ScriptResult

getProviderBySeq

public ScriptResult getProviderBySeq(java.lang.String providerNbr)

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

Gets the provider by seq.

Specified by:

getProviderBySeq in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

providerNbr - the provider nbr

Returns:

the provider by seq

getRefLicenseProfBySeqNbr

public ScriptResult getRefLicenseProfBySeqNbr(java.lang.String serviceProviderCode,
                                     java.lang.Long seqNbr)

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

Get LicenseScriptModel.

Specified by:

getRefLicenseProfBySeqNbr in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

serviceProviderCode - agency code

seqNbr - license number

Returns:

ScriptResult

getRefLicensesProfByLicNbr

public ScriptResult getRefLicensesProfByLicNbr(java.lang.String serviceProviderCode,
                                      java.lang.String licenseNbr)

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

Get a collection of LicenseScriptModel.

Specified by:

getRefLicensesProfByLicNbr in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

serviceProviderCode - agency code

licenseNbr - license number

Returns:

ScriptResult

getRefLicensesProfByName

public ScriptResult getRefLicensesProfByName(java.lang.String serviceProviderCode,
                                    java.lang.String fName,
                                    java.lang.String mName,
                                    java.lang.String lName)

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

Get LicenseScriptModel.

Specified by:

getRefLicensesProfByName in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

serviceProviderCode - agency code

fName - first name

mName - middle name

lName - last name

Returns:

ScriptResult

getLicenseProf

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

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

Get LicenseProfessionals from Lic. Prof. reference table .

Specified by:

getLicenseProf in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

capID - CapIDModel

Returns:

ScriptResult

createApprovalTradeNameLicense

public ScriptResult createApprovalTradeNameLicense(CapScriptModel capScriptModel,
                                          com.accela.v360.publicuser.PublicUserModel publicUser,
                                          java.lang.String licenseType,
                                          java.lang.String tradeName1Key1,
                                          java.lang.String tradeName1Key2,
                                          java.lang.String tradeName1Key3,
                                          java.lang.String tradeName2Key1,
                                          java.lang.String tradeName2Key2,
                                          java.lang.String tradeName2Key3,
                                          java.lang.String legalFormKey,
                                          java.lang.String financeNbrKey)

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

Create an Approval TradeName License, and write it to DB.

Specified by:

createApprovalTradeNameLicense in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

capScriptModel - the cap script model

publicUser - the public user

licenseType - the license type

tradeName1Key1 - the trade name1 key1

tradeName1Key2 - the trade name1 key2

tradeName1Key3 - the trade name1 key3

tradeName2Key1 - the trade name2 key1

tradeName2Key2 - the trade name2 key2

tradeName2Key3 - the trade name2 key3

legalFormKey - the legal form key

financeNbrKey - the finance nbr key

Returns:

the script result

createApprovalTradeNameLicense

public ScriptResult createApprovalTradeNameLicense(CapScriptModel capScriptModel,
                                          com.accela.v360.publicuser.PublicUserModel publicUser,
                                          java.lang.String licenseType,
                                          java.lang.String englishTradeName,
                                          java.lang.String arabicTradeName,
                                          java.lang.String legalFormKey,
                                          java.lang.String financeNbrKey)
                                            throws com.accela.aa.exception.AAException,
                                                   java.rmi.RemoteException

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

Create an Approval TradeName License.

Specified by:

createApprovalTradeNameLicense in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

capScriptModel - the cap script model

publicUser - the public user

licenseType - the license type

englishTradeName - the ASI field labels of english trade names

arabicTradeName - the ASI field labels of arabic trade names

legalFormKey - the legal form key

financeNbrKey - the finance nbr key

Returns:

the script result

Throws:

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

java.rmi.RemoteException - the remote exception

getPublicUserByUserName

public com.accela.v360.publicuser.PublicUserModel getPublicUserByUserName(java.lang.String puserUserName)
                                                                   throws java.lang.Exception

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

Get the public user by the userName.

Specified by:

getPublicUserByUserName in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

puserUserName - the puser user name

Returns:

the public user by user name

Throws:

java.lang.Exception - the exception

associateLpWithCap

public ScriptResult associateLpWithCap(com.accela.aa.aamain.cap.CapIDModel capId,
                              LicenseScriptModel license)

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

Associate the license with the specific cap.

Specified by:

associateLpWithCap in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

capId - the cap id

license - the license

Returns:

the script result

associateLpWithPublicUser

public ScriptResult associateLpWithPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser,
                                     LicenseScriptModel license)

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

Associate the licesne with the specific public user, and the notice mail will be sent to the PublicUser and the Agency User.

Specified by:

associateLpWithPublicUser in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

publicUser - the public user

license - the license

Returns:

the script result

associateContactWithPublicUser

public ScriptResult associateContactWithPublicUser(java.lang.String publicUserSeqNbr,
                                          java.lang.String contactSeqNbr)

Associate the contact with the specific public user .

Specified by:

associateContactWithPublicUser in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

publicUserSeqNbr - the sequence number of public user.

contactSeqNbr - the sequence number of contact.

Returns:

the script result

notifyPublicUserByEmail

public ScriptResult notifyPublicUserByEmail(com.accela.v360.publicuser.PublicUserModel publicUser,
                                   LicenseScriptModel license)

Send the notice mail about approval trade name to the public user

Specified by:

notifyPublicUserByEmail in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

publicUser -

license -

Returns:

the script result

createAssociatedLicenseProfessional

public ScriptResult createAssociatedLicenseProfessional(CapScriptModel capScriptModel,
                                               java.lang.String licenseType,
                                               java.lang.String tradeName1Key1,
                                               java.lang.String tradeName1Key2,
                                               java.lang.String tradeName1Key3,
                                               java.lang.String tradeName2Key1,
                                               java.lang.String tradeName2Key2,
                                               java.lang.String tradeName2Key3,
                                               java.lang.String legalFormKey,
                                               java.lang.String financeNbrKey)

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

Create Approval TradeName License, assocaite the LP to the specific cap associate the LP to the public user send the approval notice mail to the public user it same as invoking: 1.createApprovalTradeNameLicense(); 2.associateWithCap(); 3.associateWithPublicUser(); 4.sendNoticeMailToUser().

Specified by:

createAssociatedLicenseProfessional in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

capScriptModel - the cap script model

licenseType - the license type

tradeName1Key1 - the trade name1 key1

tradeName1Key2 - the trade name1 key2

tradeName1Key3 - the trade name1 key3

tradeName2Key1 - the trade name2 key1

tradeName2Key2 - the trade name2 key2

tradeName2Key3 - the trade name2 key3

legalFormKey - the legal form key

financeNbrKey - the finance nbr key

Returns:

the script result

getTradeNameList

public ScriptResult getTradeNameList(java.lang.String businessName,
                            java.lang.String businessName2)

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

Return list of trade names by BusinessName and BusName2. One of the two params can be null but not both.

Specified by:

getTradeNameList in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

businessName - the business name which may be null

businessName2 - the business name2 which may be null

Returns:

list of trade names by BusinessName and BusName2.

isApproveTradeName

public ScriptResult isApproveTradeName(CapScriptModel cap,
                              java.lang.String filterName,
                              java.lang.String currentModuleName,
                              java.lang.String status)

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

Judge the status change is whether for approving trade name.

Specified by:

isApproveTradeName in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

cap - The current trade name cap

filterName - The cap type filter name

currentModuleName - The current module name

status - The status which user want to change

Returns:

the script result

getRefLicProfByOnlineUser

public ScriptResult getRefLicProfByOnlineUser(java.lang.String userSeqNbr)

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

Get all reference license professional by the user sequence number.

Specified by:

getRefLicProfByOnlineUser in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

userSeqNbr - the sequence number of the public user

Returns:

a list of reference license professional

checkTradeNamesGroupByGroup

public ScriptResult checkTradeNamesGroupByGroup(CapScriptModel cap,
                                       java.lang.String tradeName1Key1,
                                       java.lang.String tradeName2Key1,
                                       java.lang.String tradeName1Key2,
                                       java.lang.String tradeName2Key2,
                                       java.lang.String tradeName1Key3,
                                       java.lang.String tradeName2Key3)

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

Check trade names group by group.

Specified by:

checkTradeNamesGroupByGroup in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

cap - the cap

tradeName1Key1 - the trade name1 key1

tradeName2Key1 - the trade name2 key1

tradeName1Key2 - the trade name1 key2

tradeName2Key2 - the trade name2 key2

tradeName1Key3 - the trade name1 key3

tradeName2Key3 - the trade name2 key3

Returns:

the script result

updateLicenseStatusByTypeAndNbr

public ScriptResult updateLicenseStatusByTypeAndNbr(java.lang.String licenseType,
                                           java.lang.String licenseNbr,
                                           java.lang.String auditStatus)

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

update the status of license.

Specified by:

updateLicenseStatusByTypeAndNbr in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

licenseType - the license type

licenseNbr - the license nbr

auditStatus - the audit status

Returns:

ScriptResult -- contains the result("true/false") and the error message.

getRefLicenseProfByProviderNo

public ScriptResult getRefLicenseProfByProviderNo(java.lang.String providerNo)

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

Gets the license professional by provider no.

Specified by:

getRefLicenseProfByProviderNo in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

providerNo - the provider no

Returns:

the provider by provider no

getCapIDsByLicenseModel

public ScriptResult getCapIDsByLicenseModel(LicenseScriptModel licenseScriptModel)

Get Caps by LicenseModel. Note: There's a limitation up to 3,000 records. If there are more than 3,000 records meet your querying criteria, the interface will not return data normally but return a null output,false flag with an error message "The results count exceed the max limit 3000." eg. ScriptResult(false, "getCapIDsByLicenseModel","The results count exceed the max limit 3000.", null). Once the error message occurs, please change your criteria in capModel to narrow your search for getting data normally.

Specified by:

getCapIDsByLicenseModel in interface com.accela.aa.emse.dom.service.LicenseScriptService

Parameters:

licenseScriptModel - LicenseScriptModel

Returns:

ScriptResult the script result output is CapIDModel List