com.accela.aa.emse.dom

Class AddressConditionScript

java.lang.Object

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

com.accela.aa.emse.dom.ConditionScript

com.accela.aa.emse.dom.AddressConditionScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.AddressConditionScriptService, com.accela.aa.emse.dom.service.ConditionScriptService, com.accela.aa.emse.dom.service.ScriptAble

public class AddressConditionScript
extends ConditionScript
implements com.accela.aa.emse.dom.service.AddressConditionScriptService

 
 Accela Automation
 File: AddressConditionScript.java
 
 Accela, Inc.
 Copyright (C): 2001-2014
 
 Description:
 Provides the "aa.AddressCondition" object through which script writers can
 operate on an retrieve AddressCondition related objects.
 
 Notes:
 
 
 Revision History:
 2002-12-06 Kelvin Wu           initial version.
 11/01/2006 Michael Mao cache service object.
 
 

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	addAddressCondition(long addressNumber, java.lang.String conditionType, java.lang.String conditionDescription, java.lang.String conditionComment, java.lang.String refNumber1, java.lang.String refNumber2, java.lang.String impactCode, java.lang.String conditionStatus, com.accela.aa.emse.util.ScriptDateTime effectDate, com.accela.aa.emse.util.ScriptDateTime expireDate, com.accela.aa.emse.util.ScriptDateTime issuedDate, com.accela.aa.emse.util.ScriptDateTime statusDate, com.accela.aa.aamain.people.SysUserModel issuedByUser, com.accela.aa.aamain.people.SysUserModel statusByUser) Add one address condition.
ScriptResult	addAddressCondition(long addressNumber, java.lang.String conditionType, java.lang.String conditionDescription, java.lang.String conditionComment, java.lang.String refNumber1, java.lang.String refNumber2, java.lang.String impactCode, java.lang.String conditionStatus, com.accela.aa.emse.util.ScriptDateTime effectDate, com.accela.aa.emse.util.ScriptDateTime expireDate, com.accela.aa.emse.util.ScriptDateTime issuedDate, com.accela.aa.emse.util.ScriptDateTime statusDate, com.accela.aa.aamain.people.SysUserModel issuedByUser, com.accela.aa.aamain.people.SysUserModel statusByUser, java.lang.String conditionStatusType, java.lang.String displayConditionNotice, java.lang.String includeInConditionName, java.lang.String includeInShortDescription, java.lang.String inheritable, java.lang.String longDescripton, java.lang.String publicDisplayMessage, java.lang.String resolutionAction) Add one address condition (Added in V6.5).
ScriptResult	addAddressCondition(long addressNumber, java.lang.String conditionType, java.lang.String conditionDescription, java.lang.String conditionComment, java.lang.String refNumber1, java.lang.String refNumber2, java.lang.String impactCode, java.lang.String conditionStatus, com.accela.aa.emse.util.ScriptDateTime effectDate, com.accela.aa.emse.util.ScriptDateTime expireDate, com.accela.aa.emse.util.ScriptDateTime issuedDate, com.accela.aa.emse.util.ScriptDateTime statusDate, com.accela.aa.aamain.people.SysUserModel issuedByUser, com.accela.aa.aamain.people.SysUserModel statusByUser, java.lang.String conditionStatusType, java.lang.String displayConditionNotice, java.lang.String includeInConditionName, java.lang.String includeInShortDescription, java.lang.String inheritable, java.lang.String longDescripton, java.lang.String publicDisplayMessage, java.lang.String resolutionAction, java.lang.String conditionGroup, java.lang.String displayNoticeOnACA, java.lang.String displayNoticeOnACAFee) Add condition group (Added in V6.6).
ScriptResult	createAddressCondition(AddressConditionScriptModel condition) create Address Condition.
ScriptResult	editAddressCondition(AddressConditionScriptModel addressCondition) Update on address condition by address condition primary key.
ScriptResult	getAddressCondition(java.lang.String refAddressID, long conditionNumber) Return one address condition by address condition primary key.
ScriptResult	getAddressConditions(java.lang.String refAddressID) Fetch address conditions for an address.
ScriptResult	getNewConditionScriptModel() get New ConditionScriptModel.
ScriptResult	removeAddressCondition(long addressNumber, long conditionNumber) Delete one address condition by address condition primary key.

Methods inherited from class com.accela.aa.emse.dom.ConditionScript

createCondition, createCondition, createCondition, createConditionFromStdCondition, createConditionFromStdCondition, createConditionWithMulLangs, editField4TemplateForm, editTableValue4TemplateTable, getAssetCondition, getCondition, getCondition, getFields4TemplateForm, getFields4TemplateTable, getNewAssetConditionScriptModel, getNewOwnerConditionScriptModel, getOwnerCondition

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

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

createCondition, createCondition, createCondition, createConditionFromStdCondition, createConditionFromStdCondition, createConditionWithMulLangs, editField4TemplateForm, editTableValue4TemplateTable, getAssetCondition, getCondition, getCondition, getFields4TemplateForm, getFields4TemplateTable, getOwnerCondition

Constructor Detail

AddressConditionScript

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

Constructor for AddressConditionScript.

Throws:

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

AddressConditionScript

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

The Constructor for AddressConditionScript.

Parameters:

serviceProviderCode - agency name

auditID - the caller id

Throws:

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

Method Detail

addAddressCondition

public ScriptResult addAddressCondition(long addressNumber,
                               java.lang.String conditionType,
                               java.lang.String conditionDescription,
                               java.lang.String conditionComment,
                               java.lang.String refNumber1,
                               java.lang.String refNumber2,
                               java.lang.String impactCode,
                               java.lang.String conditionStatus,
                               com.accela.aa.emse.util.ScriptDateTime effectDate,
                               com.accela.aa.emse.util.ScriptDateTime expireDate,
                               com.accela.aa.emse.util.ScriptDateTime issuedDate,
                               com.accela.aa.emse.util.ScriptDateTime statusDate,
                               com.accela.aa.aamain.people.SysUserModel issuedByUser,
                               com.accela.aa.aamain.people.SysUserModel statusByUser)

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

Add one address condition.

Specified by:

addAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Parameters:

addressNumber - address number

conditionType - condition type

conditionDescription - condition description

conditionComment - condition comment

refNumber1 - ref number1

refNumber2 - ref number2

impactCode - impact code

conditionStatus - condition status

effectDate - effect date

expireDate - expire date

issuedDate - issue date

statusDate - status date

issuedByUser - issued user

statusByUser - status user

Returns:

ScriptResult

createAddressCondition

public ScriptResult createAddressCondition(AddressConditionScriptModel condition)

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

create Address Condition.

Specified by:

createAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Parameters:

condition - AddressConditionScriptModel

Returns:

ScriptResult

addAddressCondition

public ScriptResult addAddressCondition(long addressNumber,
                               java.lang.String conditionType,
                               java.lang.String conditionDescription,
                               java.lang.String conditionComment,
                               java.lang.String refNumber1,
                               java.lang.String refNumber2,
                               java.lang.String impactCode,
                               java.lang.String conditionStatus,
                               com.accela.aa.emse.util.ScriptDateTime effectDate,
                               com.accela.aa.emse.util.ScriptDateTime expireDate,
                               com.accela.aa.emse.util.ScriptDateTime issuedDate,
                               com.accela.aa.emse.util.ScriptDateTime statusDate,
                               com.accela.aa.aamain.people.SysUserModel issuedByUser,
                               com.accela.aa.aamain.people.SysUserModel statusByUser,
                               java.lang.String conditionStatusType,
                               java.lang.String displayConditionNotice,
                               java.lang.String includeInConditionName,
                               java.lang.String includeInShortDescription,
                               java.lang.String inheritable,
                               java.lang.String longDescripton,
                               java.lang.String publicDisplayMessage,
                               java.lang.String resolutionAction)

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

Add one address condition (Added in V6.5).

Specified by:

addAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Returns:

ScriptResult

addAddressCondition

public ScriptResult addAddressCondition(long addressNumber,
                               java.lang.String conditionType,
                               java.lang.String conditionDescription,
                               java.lang.String conditionComment,
                               java.lang.String refNumber1,
                               java.lang.String refNumber2,
                               java.lang.String impactCode,
                               java.lang.String conditionStatus,
                               com.accela.aa.emse.util.ScriptDateTime effectDate,
                               com.accela.aa.emse.util.ScriptDateTime expireDate,
                               com.accela.aa.emse.util.ScriptDateTime issuedDate,
                               com.accela.aa.emse.util.ScriptDateTime statusDate,
                               com.accela.aa.aamain.people.SysUserModel issuedByUser,
                               com.accela.aa.aamain.people.SysUserModel statusByUser,
                               java.lang.String conditionStatusType,
                               java.lang.String displayConditionNotice,
                               java.lang.String includeInConditionName,
                               java.lang.String includeInShortDescription,
                               java.lang.String inheritable,
                               java.lang.String longDescripton,
                               java.lang.String publicDisplayMessage,
                               java.lang.String resolutionAction,
                               java.lang.String conditionGroup,
                               java.lang.String displayNoticeOnACA,
                               java.lang.String displayNoticeOnACAFee)

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

Add condition group (Added in V6.6).

Specified by:

addAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Returns:

ScriptResult

editAddressCondition

public ScriptResult editAddressCondition(AddressConditionScriptModel addressCondition)

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

Update on address condition by address condition primary key.

Specified by:

editAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Parameters:

addressCondition - AddressConditionScriptModel

Returns:

ScriptResult Object - see documentation for this type

removeAddressCondition

public ScriptResult removeAddressCondition(long addressNumber,
                                  long conditionNumber)

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

Delete one address condition by address condition primary key.

Specified by:

removeAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Parameters:

addressNumber - address number

conditionNumber - condition number

Returns:

ScriptResult Object - see documentation for this type.

getAddressCondition

public ScriptResult getAddressCondition(java.lang.String refAddressID,
                               long conditionNumber)

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

Return one address condition by address condition primary key.

Specified by:

getAddressCondition in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Parameters:

refAddressID - the ref address id

conditionNumber - the condition number

Returns:

ScriptResult Object - see documentation for this type.

getAddressConditions

public ScriptResult getAddressConditions(java.lang.String refAddressID)

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

Fetch address conditions for an address.

Specified by:

getAddressConditions in interface com.accela.aa.emse.dom.service.AddressConditionScriptService

Parameters:

refAddressID - the ref address id

Returns:

ScriptResult Object - see documentation for this type.

getNewConditionScriptModel

public ScriptResult getNewConditionScriptModel()

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

get New ConditionScriptModel.

Specified by:

getNewConditionScriptModel in interface com.accela.aa.emse.dom.service.ConditionScriptService

Overrides:

getNewConditionScriptModel in class ConditionScript

Returns:

ScriptResult