com.accela.aa.emse.dom

Class CommonConditionScript

java.lang.Object

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

com.accela.aa.emse.dom.ConditionScript

com.accela.aa.emse.dom.CommonConditionScript

All Implemented Interfaces:

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

public class CommonConditionScript
extends ConditionScript
implements com.accela.aa.emse.dom.service.ConditionScriptService

 
  Accela Automation
  File: CommonConditionScript.java
 
  Accela, Inc.
  Copyright (C): 2009-2013
 
  Description:
  Provides the "aa.CommonCondition" object through which script writers can
  operate on an retrieve CommonCondition related objects.
 
  Notes:
 
 
  Revision History:
 
 

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	addCommonCondition(com.accela.aa.condition.condition.CommonConditionModel conditionModel) Add a common condition.
ScriptResult	addCommonCondition(CommonConditionScriptModel conditionModel) add CommonCondition.
ScriptResult	editCommonCondition(CommonConditionScriptModel commonCondition) Update the common condition according to the entityType and entityID.
ScriptResult	getCapIDsByRefConditionIDAndType(long conditionID, java.lang.String conditionType) Get CAP list by condition ID and condition type.
ScriptResult	getCommonCondition(java.lang.String entityType, java.lang.String entityID, long conditionNumber) Get a common condition according the PK values.
ScriptResult	getCommonConditions(java.lang.String entityType, java.lang.String entityID) Get common conditions according to entityType and entityID.
ScriptResult	getNewCommonConditionModel() Create a new common condition object.
ScriptResult	getNewConditionScriptModel() get New ConditionScriptModel.
ScriptResult	removeCommonCondition(java.lang.String entityType, java.lang.String entityID, long conditionNumber) Delete a common condition according to the pk.

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.ConditionScriptService

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

Constructor Detail

CommonConditionScript

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

Constructor for CommonConditionScript.

Parameters:

serviceProviderCode - agency name

auditID - the caller id

Throws:

com.accela.aa.exception.AAException

Method Detail

getNewCommonConditionModel

public ScriptResult getNewCommonConditionModel()

Create a new common condition object.

Returns:

ScriptResult

addCommonCondition

public ScriptResult addCommonCondition(CommonConditionScriptModel conditionModel)

add CommonCondition.

Parameters:

conditionModel - the condition model

Returns:

the script result

addCommonCondition

public ScriptResult addCommonCondition(com.accela.aa.condition.condition.CommonConditionModel conditionModel)

Add a common condition.

Parameters:

conditionModel - the condition model

Returns:

the script result

editCommonCondition

public ScriptResult editCommonCondition(CommonConditionScriptModel commonCondition)

Update the common condition according to the entityType and entityID.

Parameters:

commonCondition - the common condition

Returns:

the script result

removeCommonCondition

public ScriptResult removeCommonCondition(java.lang.String entityType,
                                 java.lang.String entityID,
                                 long conditionNumber)

Delete a common condition according to the pk.

Parameters:

entityType - the entity type

entityID - the entity id

conditionNumber - the condition number

Returns:

the script result

getCommonCondition

public ScriptResult getCommonCondition(java.lang.String entityType,
                              java.lang.String entityID,
                              long conditionNumber)

Get a common condition according the PK values.

Parameters:

entityType - the entity type

entityID - the entity id

conditionNumber - the condition number

Returns:

the common condition

getCommonConditions

public ScriptResult getCommonConditions(java.lang.String entityType,
                               java.lang.String entityID)

Get common conditions according to entityType and entityID.

Parameters:

entityType - the entity type

entityID - the entity id

Returns:

the common conditions

getCapIDsByRefConditionIDAndType

public ScriptResult getCapIDsByRefConditionIDAndType(long conditionID,
                                            java.lang.String conditionType)

Get CAP list by condition ID and condition type.

Parameters:

conditionID - the condition id

conditionType - the condition type such as: ASSET_CONDITION, PARCEL_CONDITION, ADDRESS_CONDITION, OWNER_CONDITION, STRUCTURE_CONDITION, PEOPLE_CONDITION, STRUCTURE_ESTABL_CONDITION

Returns:

the capIDs by reference condition id and 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