com.accela.aa.emse.dom

Class SetScript

java.lang.Object

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

com.accela.aa.emse.dom.SetScript

All Implemented Interfaces:

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

public class SetScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.SetScriptService

 
 Accela Automation
 File: BatchJobScript.java
 
 Accela, Inc.
 Copyright (C): 2001-2014
 
 Description:
 
 Notes:
 
 Revision History:
 07/28/03    Tony xian              Initial development.
 07/30/03    Moricky Mo             add the add(String setCode, String entType, CapIDModel capID, String entID) method
 11/01/2006 Michael Mao cache service object.
 
 

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	add(java.lang.String setCode, com.accela.aa.aamain.cap.CapIDModel capID) Add method.
ScriptResult	add(java.lang.String setCode, java.lang.String entType, com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String entID) Add method.
ScriptResult	addAddressSetMember(java.lang.String setCode, java.lang.Long addressNBR) Adds the address set member.
ScriptResult	addCapSetMember(java.lang.String setCode, com.accela.aa.aamain.cap.CapIDModel capIDModel) Adds the cap set member.
ScriptResult	addLPSetMember(java.lang.String setCode, java.lang.Long licenseSeqNBR) Adds the lp set member.
ScriptResult	addParcelSetMember(java.lang.String setCode, java.lang.String parcelNumber) Adds the parcel set member.
ScriptResult	addRecordSetMembers(java.util.List<com.accela.aa.aamain.cap.SetDetailsModel> setDetailsList) Add Set Member List for Set
ScriptResult	addSetofSetMember(java.lang.String setCode, java.lang.String clildSetID) Adds the setof set member.
ScriptResult	createSet(java.lang.String setCode, java.lang.String setName) Add a set.
ScriptResult	createSet(java.lang.String setCode, java.lang.String setName, java.lang.String setType, java.lang.String setComment) create a set for a specified type.
ScriptResult	createSet4RandomAudit(java.lang.String setCode, java.lang.String setName, java.lang.String setComment, RandomAuditRuleScriptModel randomAuditRuleScriptModel)
ScriptResult	createSet4RandomAudit(java.lang.String setCode, java.lang.String setName, java.lang.String setComment, java.lang.String randomType, double randomNumber)
ScriptResult	createSetHeader(SetHeaderScriptModel setHeaderScriptModel) Create SetHeaderModel
ScriptResult	deleteSetMembers(SetDetailsScriptModel setDetailsScriptModel) Delete Set Members.
ScriptResult	getAddressSetMembersByPK(java.lang.String setCode) Gets the address set members by pk.
ScriptResult	getCAPSetMembersByPK(java.lang.String setCode) Gets the cAP set members by pk.
ScriptResult	getLPSetMembersByPK(java.lang.String setCode) Gets the lP set members by pk.
ScriptResult	getNewRandomAuditRuleModel()
ScriptResult	getParcelSetMembersByPK(java.lang.String setCode) Gets the parcel set members by pk.
ScriptResult	getSetByPK(java.lang.String setCode) Get set by primary key set code.
ScriptResult	getSetBySetMember(SetDetailsScriptModel setDetailsScriptModel) Get set list which contain the specify set member
ScriptResult	getSetDetailsScriptModel() Get new SetDetailsScriptModel.
ScriptResult	getSetHeaderListByModel(SetHeaderScriptModel setHeaderScriptModel) Get Set Header List by Model
ScriptResult	getSetHeaderScriptModel() Get new SetHeaderScriptModel.
ScriptResult	getSetHeadersListByAddress(java.lang.Long addressNBR) Gets the sets the headers list by address.
ScriptResult	getSetHeadersListByChildSet(java.lang.String childID) Gets the sets the headers list by child set.
ScriptResult	getSetHeadersListByLP(java.lang.Long lpNBR) Gets the sets the headers list by license professional.
ScriptResult	getSetHeadersListByMember(com.accela.aa.aamain.cap.CapIDModel capIDModel) Gets the sets the headers list by member.
ScriptResult	getSetHeadersListByParcel(java.lang.String parcelNBR) Gets the sets the headers list by parcel.
ScriptResult	getSetMembers(SetDetailsScriptModel setDetailsScriptModel) Get SetMember List
ScriptResult	getSetSetMembersByPK(java.lang.String setCode) Gets the sets the set members by pk.
ScriptResult	removeSetHeader(java.lang.String setCode) Remove Set by Set ID.
ScriptResult	removeSetHeadersListByAddress(java.lang.String setCode, java.lang.Long addressNBR) Removes the set headers list by address.
ScriptResult	removeSetHeadersListByCap(java.lang.String setCode, com.accela.aa.aamain.cap.CapIDModel capIDModel) Removes the set headers list by cap.
ScriptResult	removeSetHeadersListByChild(java.lang.String setCode, java.lang.String clildSetID) Removes the set headers list by child.
ScriptResult	removeSetHeadersListByLP(java.lang.String setCode, java.lang.Long lpNBR) Removes the set headers list by license professional.
ScriptResult	removeSetHeadersListByParcel(java.lang.String setCode, java.lang.String parcelNBR) Removes the set headers list by parcel.
ScriptResult	updateSet(java.lang.String setCode, java.lang.String setName, java.lang.String setComments) Update Set detail information.
ScriptResult	updateSetHeader(SetHeaderScriptModel setHeaderScriptModel) Update SetHeaderModel.
ScriptResult	updateSetMemberStatus(SetDetailsScriptModel setDetailsScriptModel) Update Set Member Status and Set Member Status Date

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

SetScript

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

Constructor method.

Parameters:

serviceProviderCode - agency code

auditID - the audit id

Throws:

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

SetScript

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

Constructor method.

Throws:

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

Method Detail

createSet

public ScriptResult createSet(java.lang.String setCode,
                     java.lang.String setName)

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

Add a set.

Specified by:

createSet in interface com.accela.aa.emse.dom.service.SetScriptService

Parameters:

setCode - the set code

setName - the set name

Returns:

ScriptResult

createSet

public ScriptResult createSet(java.lang.String setCode,
                     java.lang.String setName,
                     java.lang.String setType,
                     java.lang.String setComment)

create a set for a specified type.

Parameters:

set - code

set - name

set - type: The setType value can be any of five types: CAP, PARCEL, SETS, ADDRESS, and LICENSE_PROFESSIONAL. If the setType value a user enters is not one of these five types, the setType value defaults to CAP.

set - comment

Returns:

createSet4RandomAudit

public ScriptResult createSet4RandomAudit(java.lang.String setCode,
                                 java.lang.String setName,
                                 java.lang.String setComment,
                                 java.lang.String randomType,
                                 double randomNumber)

Parameters:

set - code

set - name

set - comment

random - type is 'PERCENTAGE' or 'NUMBER'

random - number

Returns:

createSet4RandomAudit

public ScriptResult createSet4RandomAudit(java.lang.String setCode,
                                 java.lang.String setName,
                                 java.lang.String setComment,
                                 RandomAuditRuleScriptModel randomAuditRuleScriptModel)

getNewRandomAuditRuleModel

public ScriptResult getNewRandomAuditRuleModel()

add

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

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

Add method.

Specified by:

add in interface com.accela.aa.emse.dom.service.SetScriptService

Parameters:

setCode - the set code

capID - an object of CapIDModel

Returns:

the script result

add

public ScriptResult add(java.lang.String setCode,
               java.lang.String entType,
               com.accela.aa.aamain.cap.CapIDModel capID,
               java.lang.String entID)

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

Add method.

Specified by:

add in interface com.accela.aa.emse.dom.service.SetScriptService

Parameters:

setCode - the set code

entType - the entType

capID - an object of CapIDModel

entID - the entID

Returns:

the script result

getSetByPK

public ScriptResult getSetByPK(java.lang.String setCode)

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

Get set by primary key set code.

Specified by:

getSetByPK in interface com.accela.aa.emse.dom.service.SetScriptService

Parameters:

setCode - the set code

Returns:

ScriptResult

getCAPSetMembersByPK

public ScriptResult getCAPSetMembersByPK(java.lang.String setCode)

Gets the cAP set members by pk.

Parameters:

setCode - the set code

Returns:

the cAP set members by pk

getParcelSetMembersByPK

public ScriptResult getParcelSetMembersByPK(java.lang.String setCode)

Gets the parcel set members by pk.

Parameters:

setCode - the set code

Returns:

the parcel set members by pk

getAddressSetMembersByPK

public ScriptResult getAddressSetMembersByPK(java.lang.String setCode)

Gets the address set members by pk.

Parameters:

setCode - the set code

Returns:

the address set members by pk

getSetSetMembersByPK

public ScriptResult getSetSetMembersByPK(java.lang.String setCode)

Gets the sets the set members by pk.

Parameters:

setCode - the set code

Returns:

the sets the set members by pk

getLPSetMembersByPK

public ScriptResult getLPSetMembersByPK(java.lang.String setCode)

Gets the lP set members by pk.

Parameters:

setCode - the set code

Returns:

the lP set members by pk

updateSet

public ScriptResult updateSet(java.lang.String setCode,
                     java.lang.String setName,
                     java.lang.String setComments)

Update Set detail information.

Parameters:

setCode - the set code

setName - the set name

setComments - the set comments

Returns:

the script result

getSetHeadersListByAddress

public ScriptResult getSetHeadersListByAddress(java.lang.Long addressNBR)

Gets the sets the headers list by address.

Parameters:

addressNBR - the address number

Returns:

the sets the headers list by address

getSetHeadersListByParcel

public ScriptResult getSetHeadersListByParcel(java.lang.String parcelNBR)

Gets the sets the headers list by parcel.

Parameters:

parcelNBR - the parcel number

Returns:

the sets the headers list by parcel

getSetHeadersListByLP

public ScriptResult getSetHeadersListByLP(java.lang.Long lpNBR)

Gets the sets the headers list by license professional.

Parameters:

lpNBR - the license professional number

Returns:

the sets the headers list by license professional

getSetHeadersListByChildSet

public ScriptResult getSetHeadersListByChildSet(java.lang.String childID)

Gets the sets the headers list by child set.

Parameters:

childID - the child id

Returns:

the sets the headers list by child set

getSetHeadersListByMember

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

Gets the sets the headers list by member.

Parameters:

capIDModel - the cap id model

Returns:

the sets the headers list by member

removeSetHeadersListByAddress

public ScriptResult removeSetHeadersListByAddress(java.lang.String setCode,
                                         java.lang.Long addressNBR)

Removes the set headers list by address.

Parameters:

setCode - the set code

addressNBR - the address number

Returns:

the script result

removeSetHeadersListByParcel

public ScriptResult removeSetHeadersListByParcel(java.lang.String setCode,
                                        java.lang.String parcelNBR)

Removes the set headers list by parcel.

Parameters:

setCode - the set code

parcelNBR - the parcel number

Returns:

the script result

removeSetHeadersListByLP

public ScriptResult removeSetHeadersListByLP(java.lang.String setCode,
                                    java.lang.Long lpNBR)

Removes the set headers list by license professional.

Parameters:

setCode - the set code

lpNBR - the license professional number

Returns:

the script result

removeSetHeadersListByCap

public ScriptResult removeSetHeadersListByCap(java.lang.String setCode,
                                     com.accela.aa.aamain.cap.CapIDModel capIDModel)

Removes the set headers list by cap.

Parameters:

setCode - the set code

capIDModel - the cap id model

Returns:

the script result

removeSetHeadersListByChild

public ScriptResult removeSetHeadersListByChild(java.lang.String setCode,
                                       java.lang.String clildSetID)

Removes the set headers list by child.

Parameters:

setCode - the set code

clildSetID - the clild set id

Returns:

the script result

addSetofSetMember

public ScriptResult addSetofSetMember(java.lang.String setCode,
                             java.lang.String clildSetID)

Adds the setof set member.

Parameters:

setCode - the set code

clildSetID - the clild set id

Returns:

the script result

addCapSetMember

public ScriptResult addCapSetMember(java.lang.String setCode,
                           com.accela.aa.aamain.cap.CapIDModel capIDModel)

Adds the cap set member.

Parameters:

setCode - the set code

capIDModel - the cap id model

Returns:

the script result

addParcelSetMember

public ScriptResult addParcelSetMember(java.lang.String setCode,
                              java.lang.String parcelNumber)

Adds the parcel set member.

Parameters:

setCode - the set code

parcelNumber - the parcel number

Returns:

the script result

addAddressSetMember

public ScriptResult addAddressSetMember(java.lang.String setCode,
                               java.lang.Long addressNBR)

Adds the address set member.

Parameters:

setCode - the set code

addressNBR - the address nbr

Returns:

the script result

addLPSetMember

public ScriptResult addLPSetMember(java.lang.String setCode,
                          java.lang.Long licenseSeqNBR)

Adds the lp set member.

Parameters:

setCode - the set code

licenseSeqNBR - the license seq nbr

Returns:

the script result

getSetHeaderScriptModel

public ScriptResult getSetHeaderScriptModel()

Get new SetHeaderScriptModel.

Returns:

the ScriptResult SetHeaderScriptModel

getSetDetailsScriptModel

public ScriptResult getSetDetailsScriptModel()

Get new SetDetailsScriptModel.

Returns:

the ScriptResult SetDeatilsScriptModel

createSetHeader

public ScriptResult createSetHeader(SetHeaderScriptModel setHeaderScriptModel)

Create SetHeaderModel

Parameters:

setHeaderScripModel - SetHeader Script Model

Returns:

the Script Result SetHeaderScriptModel

getSetHeaderListByModel

public ScriptResult getSetHeaderListByModel(SetHeaderScriptModel setHeaderScriptModel)

Get Set Header List by Model

Parameters:

setHeaderScriptModel - SetHeaderScriptModel

Returns:

List of Set in ScriptResult

updateSetHeader

public ScriptResult updateSetHeader(SetHeaderScriptModel setHeaderScriptModel)

Update SetHeaderModel. SetID is required.

Parameters:

setDetailsScriptModel - SetHeaderScriptModel

Returns:

the script result

removeSetHeader

public ScriptResult removeSetHeader(java.lang.String setCode)

Remove Set by Set ID.

Parameters:

setCode -

Returns:

addRecordSetMembers

public ScriptResult addRecordSetMembers(java.util.List<com.accela.aa.aamain.cap.SetDetailsModel> setDetailsList)

Add Set Member List for Set

Parameters:

setDetailsList - a List of SetDetailsModel.

Returns:

getSetMembers

public ScriptResult getSetMembers(SetDetailsScriptModel setDetailsScriptModel)

Get SetMember List

Parameters:

setDetailsScriptModel -

Returns:

updateSetMemberStatus

public ScriptResult updateSetMemberStatus(SetDetailsScriptModel setDetailsScriptModel)

Update Set Member Status and Set Member Status Date

Parameters:

setDetailsModel - SetDetailsModel

Returns:

deleteSetMembers

public ScriptResult deleteSetMembers(SetDetailsScriptModel setDetailsScriptModel)

Delete Set Members.

Parameters:

setDetailsScriptModel - SetDetailsScriptModel

Returns:

the script result removeCount

getSetBySetMember

public ScriptResult getSetBySetMember(SetDetailsScriptModel setDetailsScriptModel)

Get set list which contain the specify set member

Parameters:

setDetailsScriptModel -

Returns: