com.accela.aa.emse.dom

Class AppSpecificInfoScript

java.lang.Object

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

com.accela.aa.emse.dom.AppSpecificInfoScript

All Implemented Interfaces:

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

public class AppSpecificInfoScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

 
 Accela Automation
 File: AppSpecificInfoScript.java
 
 Accela, Inc.
 Copyright (C): 2002-2013
 
 Description:
 To allow script writer's to access application specific information (select and update).
 
 Notes:
 $Id: AppSpecificInfoScript.java 242973 2013-01-21 07:41:46Z bruce.deng $
 
 Revision History:
 10/28/2002, Kelvin Wu, Initial Version
 11/10/2002, Kelvin Wu, modify the methods according the EMSE Phase 4 Correction Document.
 10/08/2003, Sunny Wu,  Add method getCheckboxByCapIDAndGroup(...)
 and editAppSpecInfos(...) for getting and updating task specific info item
 03/07/2005, Peter Lu,  Update methods about AppSpecInfo.
 07/07/2005, Peter Lu,  Fix bug about AppSpecInfo.
 11/01/2006 Michael Mao cache service object.
 
 

Constructor Summary

Constructors

Constructor and Description
AppSpecificInfoScript() Constructor for AppSpecificInfoScript.
AppSpecificInfoScript(java.lang.String serviceProviderCode, java.lang.String auditID) Constructor for AppSpecificInfoScript.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	addRefASISubgroupsToCAP(java.lang.String groupCode, java.lang.String[] subgroups, com.accela.aa.aamain.cap.CapIDModel targetCAPID) Add ref ASI subgroup items to target cap.
ScriptResult	copyASISubGroups(com.accela.aa.aamain.cap.CapIDModel sourceCAPID, com.accela.aa.aamain.cap.CapIDModel targetCAPID, java.lang.String[] subgroups) Copy ASI subgroup items from source cap to target cap.
ScriptResult	createRefAppSpecDropDown(java.lang.String groupCode, java.lang.String groupName, java.lang.String chckboxGroup, java.lang.String fieldLabel, java.lang.String attrValue) Add a refRefAppSpec dropdownlist value.
ScriptResult	editAppSpecificInfo(com.accela.aa.aamain.cap.AppSpecificInfoModel[] bchckboxs) Edit AppSpecificInfo with array of AppSpecificInfoModel.
ScriptResult	editAppSpecInfos(com.accela.aa.aamain.cap.AppSpecificInfoModel[] bchckboxs) Edit task and application specific info.
ScriptResult	editAppSpecInfoValue(com.accela.aa.aamain.cap.AppSpecificInfoModel bchckboxs) Edit or create ASI value.
ScriptResult	editSingleAppSpecific(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String fieldName, java.lang.String newValue, java.lang.String subGroupName) Edits the single application specific itemValue by capID/itemName/checkboxType.
ScriptResult	getAppSpecificInfoByCap(CapModel capModel) get AppSpecificInfo By cap id.
ScriptResult	getAppSpecificInfos(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String fieldName) Gets the application specific infos by capID and itemName.
ScriptResult	getAppSpecificInfos(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String subGroupName, java.lang.String fieldName) Gets the application specific infos by capID, subGroupName and itemName.
ScriptResult	getByCapID(com.accela.aa.aamain.cap.CapIDModel capID) Get by CapID.
ScriptResult	getByFeeIndicator(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String feeIndicator) Get by FeeIndicator.
ScriptResult	getByList(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String checkboxDescList) Get by list.
ScriptResult	getByType(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String checkboxDesc) Get by type.
ScriptResult	getCAPASISubgroups(com.accela.aa.aamain.cap.CapIDModel capID) Get the subgroup names only from the daily side for the specified cap.
ScriptResult	getCheckboxByCapIDAndGroup(com.accela.aa.aamain.cap.CapIDModel capID, long processID, int stepNumber, java.lang.String checkboxGroup, com.accela.aa.util.QueryFormat format) Fetch all of the task specific info items for a task.
ScriptResult	getRefAppSpecDropDownList(java.lang.String groupCode, java.lang.String groupName, java.lang.String checkboxGroup, java.lang.String fieldLabel) Retrieve dropdown list valuesdropdown list values used by the given application specific info field.
ScriptResult	getRefAppSpecInfoWithFieldList(java.lang.String groupCode, java.lang.String groupName, java.lang.String CheckboxGroup) Retrieve application specific info group and field detail according to the service provider code, group code and group name.
ScriptResult	getRefASISubgroups(java.lang.String groupCode) Get ASI subgroup names of the specified ASI group from reference end.
ScriptResult	removeASISubgroupsFromCAP(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String[] subgroups) Remove ASI subgroup items from cap.

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

AppSpecificInfoScript

public AppSpecificInfoScript(java.lang.String serviceProviderCode,
                     java.lang.String auditID)
                      throws com.accela.aa.exception.AAException

Constructor for AppSpecificInfoScript.

Parameters:

serviceProviderCode - agency code

auditID - the caller id

Throws:

com.accela.aa.exception.AAException

AppSpecificInfoScript

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

Constructor for AppSpecificInfoScript.

Throws:

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

Method Detail

getByType

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

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

Get by type.

Specified by:

getByType in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - CapIDModel

checkboxDesc - checkboxDesc

Returns:

ScriptResult

getByList

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

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

Get by list.

Specified by:

getByList in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - CapIDModel

checkboxDescList - checkboxDesc list

Returns:

ScriptResult

getAppSpecificInfos

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

Gets the application specific infos by capID and itemName. if itemName is null. it will return all application specifics by capID.

Specified by:

getAppSpecificInfos in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - the cap id

fieldName - the specific item name

Returns:

the application specific infos

getAppSpecificInfos

public ScriptResult getAppSpecificInfos(com.accela.aa.aamain.cap.CapIDModel capID,
                               java.lang.String subGroupName,
                               java.lang.String fieldName)

Gets the application specific infos by capID, subGroupName and itemName. if itemName is null, it will return all application specifics by capID.

Specified by:

getAppSpecificInfos in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - the cap id

subGroupname - Subgroup Name of ASI

fieldName - the specific item name

Returns:

the application specific infos

editSingleAppSpecific

public ScriptResult editSingleAppSpecific(com.accela.aa.aamain.cap.CapIDModel capID,
                                 java.lang.String fieldName,
                                 java.lang.String newValue,
                                 java.lang.String subGroupName)

Edits the single application specific itemValue by capID/itemName/checkboxType. When checkboxType is null. it will change the first application specific itemValue by capID/itemName

Specified by:

editSingleAppSpecific in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - the cap id

fieldName - the item name

newValue - the item value

subGroupName - the check box type

Returns:

the script result

getByCapID

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

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

Get by CapID.

Specified by:

getByCapID in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - CapIDModel

Returns:

ScriptResult

getByFeeIndicator

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

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

Get by FeeIndicator.

Specified by:

getByFeeIndicator in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - CapIDModel

feeIndicator - fee indicator

Returns:

ScriptResult

editAppSpecificInfo

public ScriptResult editAppSpecificInfo(com.accela.aa.aamain.cap.AppSpecificInfoModel[] bchckboxs)

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

Edit AppSpecificInfo with array of AppSpecificInfoModel.

Specified by:

editAppSpecificInfo in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

bchckboxs - the array of AppSpecificInfoModel

Returns:

ScriptResult

getRefAppSpecInfoWithFieldList

public ScriptResult getRefAppSpecInfoWithFieldList(java.lang.String groupCode,
                                          java.lang.String groupName,
                                          java.lang.String CheckboxGroup)

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

Retrieve application specific info group and field detail according to the service provider code, group code and group name.

Specified by:

getRefAppSpecInfoWithFieldList in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

groupCode - group code

groupName - group name

CheckboxGroup - Checkbox Group

Returns:

ScriptResult

getRefAppSpecDropDownList

public ScriptResult getRefAppSpecDropDownList(java.lang.String groupCode,
                                     java.lang.String groupName,
                                     java.lang.String checkboxGroup,
                                     java.lang.String fieldLabel)

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

Retrieve dropdown list valuesdropdown list values used by the given application specific info field.

Specified by:

getRefAppSpecDropDownList in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

groupCode - group code

groupName - group name

fieldLabel - field label

Returns:

Collection return the dropdown list valuesdropdown list values used by the given application specific info field.

createRefAppSpecDropDown

public ScriptResult createRefAppSpecDropDown(java.lang.String groupCode,
                                    java.lang.String groupName,
                                    java.lang.String chckboxGroup,
                                    java.lang.String fieldLabel,
                                    java.lang.String attrValue)

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

Add a refRefAppSpec dropdownlist value.

Specified by:

createRefAppSpecDropDown in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

groupCode - App Specific Info Group Code

groupName - App Specific Info Group Name

chckboxGroup - App Specific Info Group checkbox group

fieldLabel - field label

attrValue - field value

Returns:

ScriptResult

getCheckboxByCapIDAndGroup

public ScriptResult getCheckboxByCapIDAndGroup(com.accela.aa.aamain.cap.CapIDModel capID,
                                      long processID,
                                      int stepNumber,
                                      java.lang.String checkboxGroup,
                                      com.accela.aa.util.QueryFormat format)

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

Fetch all of the task specific info items for a task.

Specified by:

getCheckboxByCapIDAndGroup in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capID - CapIDModel

processID - process id

stepNumber - step number

checkboxGroup - checkboxGroup

format - QueryFormat

Returns:

ScriptResult

editAppSpecInfos

public ScriptResult editAppSpecInfos(com.accela.aa.aamain.cap.AppSpecificInfoModel[] bchckboxs)

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

Edit task and application specific info.

Specified by:

editAppSpecInfos in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

bchckboxs - the array of AppSpecificInfoModel

Returns:

ScriptResult

editAppSpecInfoValue

public ScriptResult editAppSpecInfoValue(com.accela.aa.aamain.cap.AppSpecificInfoModel bchckboxs)

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

Edit or create ASI value.

Specified by:

editAppSpecInfoValue in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

bchckboxs - AppSpecificInfoModel

Returns:

ScriptResult

getRefASISubgroups

public ScriptResult getRefASISubgroups(java.lang.String groupCode)

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

Get ASI subgroup names of the specified ASI group from reference end.

Specified by:

getRefASISubgroups in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

See Also:

AppSpecificInfoService.getRefASISubgroups(String, String, String)

getCAPASISubgroups

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

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

Get the subgroup names only from the daily side for the specified cap.

Specified by:

getCAPASISubgroups in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

See Also:

AppSpecificInfoService.getAppSpecificInfoGroupByCapID(com.accela.aa.aamain.cap.CapIDModel, com.accela.aa.util.QueryFormat)

addRefASISubgroupsToCAP

public ScriptResult addRefASISubgroupsToCAP(java.lang.String groupCode,
                                   java.lang.String[] subgroups,
                                   com.accela.aa.aamain.cap.CapIDModel targetCAPID)

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

Add ref ASI subgroup items to target cap.

Specified by:

addRefASISubgroupsToCAP in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

See Also:

AppSpecificInfoService.addRefASISubgroupsToCAP(java.lang.String, java.lang.String, java.lang.String[], com.accela.aa.aamain.cap.CapIDModel, java.lang.String)

removeASISubgroupsFromCAP

public ScriptResult removeASISubgroupsFromCAP(com.accela.aa.aamain.cap.CapIDModel capID,
                                     java.lang.String[] subgroups)

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

Remove ASI subgroup items from cap.

Specified by:

removeASISubgroupsFromCAP in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

See Also:

AppSpecificInfoService.removeASISubgroupsFromCAP(com.accela.aa.aamain.cap.CapIDModel, java.lang.String[], java.lang.String)

getAppSpecificInfoByCap

public ScriptResult getAppSpecificInfoByCap(CapModel capModel)

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

get AppSpecificInfo By cap id.

Specified by:

getAppSpecificInfoByCap in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

Parameters:

capModel - cap model.

Returns:

the app specific info by cap

copyASISubGroups

public ScriptResult copyASISubGroups(com.accela.aa.aamain.cap.CapIDModel sourceCAPID,
                            com.accela.aa.aamain.cap.CapIDModel targetCAPID,
                            java.lang.String[] subgroups)

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

Copy ASI subgroup items from source cap to target cap.

Specified by:

copyASISubGroups in interface com.accela.aa.emse.dom.service.AppSpecificInfoScriptService

See Also:

AppSpecificInfoService.copyASISubGroups(com.accela.aa.aamain.cap.CapIDModel, com.accela.aa.aamain.cap.CapIDModel, java.lang.String[], java.lang.String)