com.accela.aa.emse.dom

Class ScriptRoot

java.lang.Object

com.accela.aa.emse.dom.ScriptRoot

public class ScriptRoot
extends java.lang.Object

 
 Accela Automation
 File: ScriptRoot.java
 
 Accela, Inc.
 Copyright (C): 2007-2013
 
 Description:
 Provides the root of the object model exposed to scripts running
 on the scripting engine. Known to the script writer as the top
 level "aa" object.
 
 Notes:
 $Id: ScriptRoot.java 253988 2013-07-15 02:32:44Z ..\edwin.lin $
 
 
 Revision History:
 12/6/01, Emil Andresen, Initial Version
 02/27/02,Carl Zhu     , Add one Script Object: PeopleScript
 04/30/02,DavidZheng   , Add one "import" senetence, one variable "gis" and init a vlaue to "gis" at constructor.
 04/30/02,George xu    , Add two Script Objects: BStructureScript,GStructureScript.
 06/12/02,George xu    , Comment FeeScript.
 09/20/02,Johnny Zhou,   Change to new Architecture
 10/27/02,Owen  Yang,    Add EvetnLogScript
 07/28/03 Stone shi      Add some method for BatchJob Related Enhancemnent
 07/28/03 Sunny Wu       Add method runOracleReport for running oracle report and sending the resulting.
 07/28/03 Tony xian      Add two script
 07/28/03,Moricky Mo   , Add AddressScript
 07/30/03,Moricky Mo   , Add InvoiceScript
 Aug 1,2003     Joey.lv         add FinanceScript
 08/06/2003,Sliver      ,  Add CapContactScript
 Aug 12,2003    kyle            add ParcelScript
 09/19/2003   Stone shi  Add ExpirationScript
 09/07/2004     Sunny Wu        Add LicenseProfessionalScript
 03/16/2005 Lytton Cheng Delete the Sliver's test Code
 07/11/2005 Peter Lu            Add taskSpecificInfo script
 02/18/2006 Anna  Yu     Add TrustAccountScript
 03/30/2006 Benson liu   Add appSpecificTableScript
 11/06/2006 saul fang    Add EPaymentScript
 01/30/2007 troy.yang    Add ActivitySpecInfoScript
 02/01/2007 Jason.Wang   Add RunReportScript
 10/10/2012 Samuel.huang Add MeetingScript
 

Field Summary

Fields

Modifier and Type	Field and Description
com.accela.aa.emse.dom.service.ActivityScriptService	activity activity
com.accela.aa.emse.dom.service.ActivitySpecInfoScriptService	activitySpecInfo The activity spec info.
com.accela.aa.emse.dom.service.AdditionalInfoScriptService	additionalInfo The additional info.
com.accela.aa.emse.dom.service.AddressScriptService	address The address.
com.accela.aa.emse.dom.service.AddressConditionScriptService	addressCondition The address condition.
com.accela.aa.emse.dom.service.AppSpecificInfoScriptService	appSpecificInfo The app specific info.
com.accela.aa.emse.dom.service.AppSpecificTableScriptService	appSpecificTableScript The app specific table script.
com.accela.aa.emse.dom.service.AssetScriptService	asset The asset.
AssetCAScript	assetCA The asset condition assessment.
com.accela.aa.emse.dom.service.BatchJobScriptService	batchJob The batch job.
com.accela.aa.emse.dom.service.BizDomainScriptService	bizDomain The biz domain.
BStructureScript	bStructure
com.accela.aa.emse.dom.service.CAEConditionScriptService	caeCondition The cae condition.
com.accela.aa.emse.dom.service.CalendarScriptService	calendar The calendar.
com.accela.aa.emse.dom.service.CapScriptService	cap The cap.
com.accela.aa.emse.dom.service.CapConditionScriptService	capCondition The cap condition.
com.accela.aa.emse.dom.service.CashierScriptService	cashier The cashier.
CommonConditionScript	commonCondition
com.accela.aa.emse.dom.service.CommunicationScriptService	communication The communication.
com.accela.aa.emse.dom.service.ConditionScriptService	condition Condition
ContinuingEducationScript	continuingEducation
com.accela.aa.emse.dom.service.ContractorLicenseScriptService	contractorLicense The contractor license.
com.accela.aa.emse.util.ScriptDateTimeUtil	date The date.
DocumentScript	document
EducationScript	education
com.accela.aa.emse.emse.ScriptEnvironment	env The env.
com.accela.aa.emse.dom.service.EPaymentScriptService	ePayment The e payment.
com.accela.aa.emse.dom.service.EventLogScriptService	eventLog The event log.
ExaminationScript	examination
com.accela.aa.emse.dom.service.ExchangeScriptService	exchange The exchange.
com.accela.aa.emse.dom.service.ExpirationScriptService	expiration The expiration.
com.accela.aa.emse.dom.service.FeeScriptService	fee The fee.
com.accela.aa.emse.dom.service.FinanceScriptService	finance The finance.
GenericQueryScript	genericQuery The generic query.
com.accela.aa.emse.dom.service.GenericTemplateScriptService	genericTemplate The generic template.
com.accela.aa.emse.dom.service.GISScriptService	gis The gis.
GlobalSearchScript	globalSearch
GStructureScript	gStructure
com.accela.aa.emse.dom.service.GuidesheetScriptService	guidesheet Guidesheet script.
com.accela.aa.emse.dom.service.HttpClientScriptService	httpClient The http client.
com.accela.aa.emse.dom.service.InspectionScriptService	inspection The inspection.
com.accela.aa.emse.dom.service.InvoiceScriptService	invoice The invoice.
com.accela.aa.emse.dom.service.LicenseProfessionalScriptService	licenseProfessional The license professional.
com.accela.aa.emse.dom.service.LicenseScriptService	licenseScript The license script.
com.accela.aa.emse.dom.service.LicenseProfessionalScriptService	m_licenseProfessional The m_license professional.
com.accela.aa.emse.dom.service.MeetingScriptService	meeting The meeting.
EMSETextMessageResourcesScript	messageResources The message resources.
com.accela.aa.emse.dom.service.OAuthClientScriptService	oAuthClient The o auth client.
com.accela.aa.emse.dom.service.OwnerScriptService	owner The owner.
com.accela.aa.emse.dom.service.OwnerConditionScriptService	ownerCondition Owner Condition
com.accela.aa.emse.dom.service.ParcelScriptService	parcel The parcel.
com.accela.aa.emse.dom.service.ParcelConditionScriptService	parcelCondition The parcel condition.
PartTransactionScript	partTransaction The part transaction.
com.accela.aa.emse.dom.service.PeopleScriptService	people The people.
com.accela.aa.emse.dom.service.PersonScriptService	person The person.
com.accela.aa.emse.dom.service.ProxyInvokerService	proxyInvoker The proxy invoker.
com.accela.aa.emse.dom.service.PublicUserScriptService	publicUser The public user.
com.accela.aa.emse.dom.service.RatingFormulaScriptService	ratingFormula The rating formula.
com.accela.aa.emse.dom.service.ReconciliationScriptService	reconciliationScript The reconciliation script.
com.accela.aa.emse.dom.service.RunReportScriptService	reportManager The report manager.
com.accela.aa.emse.dom.service.ServiceProviderScriptService	serviceProvider The service provider.
com.accela.aa.emse.dom.service.SetScriptService	set The set.
ShoppingCartScript	shoppingCart
com.accela.aa.emse.dom.service.SmartNoticeScriptService	smartNotice The smart notice.
com.accela.aa.emse.dom.service.SpecialSearchScriptService	specialSearch The special search.
com.accela.aa.emse.dom.service.StructureEstablishmentScriptService	structEstabScript The struct estab script.
java.lang.String	tagStart The tag start.
com.accela.aa.emse.dom.service.TaskSpecificInfoScriptService	taskSpecificInfo The task specific info.
com.accela.aa.emse.dom.service.TimeAccountingScriptService	timeAccounting The time accounting.
long	timeStart The time start.
com.accela.aa.emse.dom.service.TrustAccountScriptService	trustAccount The trust account.
com.accela.aa.emse.dom.service.UserRightScriptService	userright The userright.
com.accela.aa.emse.dom.service.UtilScriptService	util The util.
com.accela.aa.emse.dom.service.WorkflowScriptService	workflow The workflow.
WSConsumerScript	wsConsumer

Constructor Summary

Constructors

Constructor and Description
ScriptRoot(java.lang.String serviceProviderCode, java.util.Hashtable additionalParameters, java.lang.String auditID) Creates a new ScriptRoot.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortScript() Abort Script.
void	debug(java.lang.String tag, java.lang.Object object) To debug the emse script, can set break point here to inspect the object variable.
java.lang.String	getAuditID() Returns the auditID.
java.lang.String	getDebugOutput() Gets the potentially multi-line debug output.
ScriptResult	getHashtable(java.lang.String names, java.lang.String values) Get Hashtable.
java.lang.String	getServiceProviderCode() Returns the serviceProviderCode.
void	log(java.lang.String content) Log given content to EMSE output and debug it to system logger.
void	print(java.lang.String debugOutputLine) Appends a line to the debug output of the script.
void	resetDelegateAgencyCode() Reset the delegate agency code.
ScriptResult	runAdHoc(java.lang.String reportTitle, java.util.Hashtable reportParam, java.lang.String fileType, java.lang.String fileFormat, java.lang.String emailAddress) Invokes the Ad Hoc Report and send the output file through email.
void	runAsyncScript(java.lang.String scriptID, java.util.HashMap envParams) Allows a user to execute another script asynchronously via JMS.
ScriptResult	runOracleReport(java.lang.String desType, java.lang.String reportName, java.lang.String desFormat, java.util.Hashtable reportParam, java.lang.String emailAddress) Invokes the Oracle Report and send the output file through email.
void	runScript(java.lang.String scriptID) Allows a user to execute another script.
void	runScriptInNewTransaction(java.lang.String scriptID) Run ScriptInNewTransaction.
ScriptResult	sendEmail(java.lang.String FROM, java.lang.String TO, java.lang.String CC, java.lang.String SUBJECT, java.lang.String CONTENT, java.lang.String FILENAME) Send Email.
ScriptResult	sendEmailWithAttachedFiles(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String content, java.lang.String[] fileNames) Send Email with multiple attachments.
ScriptResult	sendMail(java.lang.String FROM, java.lang.String TO, java.lang.String CC, java.lang.String SUBJECT, java.lang.String CONTENT) Send Mail.
void	setDelegateAgencyCode(java.lang.String delegateAgencyCode) Set the delegate agency code.
void	sleep(long time) Interrupted the emse script for a while.
void	timerEnd(java.lang.String tag) Calculate the time elapsed from last meterStart().
void	timerStart(java.lang.String tag) Start time meter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messageResources

public final EMSETextMessageResourcesScript messageResources

The message resources.

set

public final com.accela.aa.emse.dom.service.SetScriptService set

The set.

batchJob

public final com.accela.aa.emse.dom.service.BatchJobScriptService batchJob

The batch job.

env

public final com.accela.aa.emse.emse.ScriptEnvironment env

The env.

cap

public final com.accela.aa.emse.dom.service.CapScriptService cap

The cap.

person

public final com.accela.aa.emse.dom.service.PersonScriptService person

The person.

workflow

public final com.accela.aa.emse.dom.service.WorkflowScriptService workflow

The workflow.

fee

public final com.accela.aa.emse.dom.service.FeeScriptService fee

The fee.

smartNotice

public final com.accela.aa.emse.dom.service.SmartNoticeScriptService smartNotice

The smart notice.

inspection

public final com.accela.aa.emse.dom.service.InspectionScriptService inspection

The inspection.

capCondition

public final com.accela.aa.emse.dom.service.CapConditionScriptService capCondition

The cap condition.

parcel

public final com.accela.aa.emse.dom.service.ParcelScriptService parcel

The parcel.

parcelCondition

public final com.accela.aa.emse.dom.service.ParcelConditionScriptService parcelCondition

The parcel condition.

date

public com.accela.aa.emse.util.ScriptDateTimeUtil date

The date.

cashier

public final com.accela.aa.emse.dom.service.CashierScriptService cashier

The cashier.

eventLog

public final com.accela.aa.emse.dom.service.EventLogScriptService eventLog

The event log.

appSpecificInfo

public final com.accela.aa.emse.dom.service.AppSpecificInfoScriptService appSpecificInfo

The app specific info.

taskSpecificInfo

public final com.accela.aa.emse.dom.service.TaskSpecificInfoScriptService taskSpecificInfo

The task specific info.

people

public final com.accela.aa.emse.dom.service.PeopleScriptService people

The people.

serviceProvider

public final com.accela.aa.emse.dom.service.ServiceProviderScriptService serviceProvider

The service provider.

userright

public final com.accela.aa.emse.dom.service.UserRightScriptService userright

The userright.

calendar

public final com.accela.aa.emse.dom.service.CalendarScriptService calendar

The calendar.

meeting

public final com.accela.aa.emse.dom.service.MeetingScriptService meeting

The meeting.

genericQuery

public final GenericQueryScript genericQuery

The generic query.

gis

public final com.accela.aa.emse.dom.service.GISScriptService gis

The gis.

addressCondition

public final com.accela.aa.emse.dom.service.AddressConditionScriptService addressCondition

The address condition.

caeCondition

public final com.accela.aa.emse.dom.service.CAEConditionScriptService caeCondition

The cae condition.

address

public final com.accela.aa.emse.dom.service.AddressScriptService address

The address.

invoice

public final com.accela.aa.emse.dom.service.InvoiceScriptService invoice

The invoice.

finance

public final com.accela.aa.emse.dom.service.FinanceScriptService finance

The finance.

additionalInfo

public final com.accela.aa.emse.dom.service.AdditionalInfoScriptService additionalInfo

The additional info.

expiration

public final com.accela.aa.emse.dom.service.ExpirationScriptService expiration

The expiration.

licenseScript

public final com.accela.aa.emse.dom.service.LicenseScriptService licenseScript

The license script.

owner

public final com.accela.aa.emse.dom.service.OwnerScriptService owner

The owner.

bizDomain

public final com.accela.aa.emse.dom.service.BizDomainScriptService bizDomain

The biz domain.

util

public final com.accela.aa.emse.dom.service.UtilScriptService util

The util.

m_licenseProfessional

public final com.accela.aa.emse.dom.service.LicenseProfessionalScriptService m_licenseProfessional

The m_license professional.

licenseProfessional

public com.accela.aa.emse.dom.service.LicenseProfessionalScriptService licenseProfessional

The license professional.

bStructure

public final BStructureScript bStructure

gStructure

public final GStructureScript gStructure

trustAccount

public final com.accela.aa.emse.dom.service.TrustAccountScriptService trustAccount

The trust account.

appSpecificTableScript

public final com.accela.aa.emse.dom.service.AppSpecificTableScriptService appSpecificTableScript

The app specific table script.

exchange

public final com.accela.aa.emse.dom.service.ExchangeScriptService exchange

The exchange.

ePayment

public final com.accela.aa.emse.dom.service.EPaymentScriptService ePayment

The e payment.

reportManager

public final com.accela.aa.emse.dom.service.RunReportScriptService reportManager

The report manager.

activitySpecInfo

public final com.accela.aa.emse.dom.service.ActivitySpecInfoScriptService activitySpecInfo

The activity spec info.

asset

public final com.accela.aa.emse.dom.service.AssetScriptService asset

The asset.

communication

public final com.accela.aa.emse.dom.service.CommunicationScriptService communication

The communication.

assetCA

public final AssetCAScript assetCA

The asset condition assessment.

partTransaction

public final PartTransactionScript partTransaction

The part transaction.

timeAccounting

public final com.accela.aa.emse.dom.service.TimeAccountingScriptService timeAccounting

The time accounting.

publicUser

public final com.accela.aa.emse.dom.service.PublicUserScriptService publicUser

The public user.

proxyInvoker

public final com.accela.aa.emse.dom.service.ProxyInvokerService proxyInvoker

The proxy invoker.

httpClient

public final com.accela.aa.emse.dom.service.HttpClientScriptService httpClient

The http client.

oAuthClient

public final com.accela.aa.emse.dom.service.OAuthClientScriptService oAuthClient

The o auth client.

ratingFormula

public final com.accela.aa.emse.dom.service.RatingFormulaScriptService ratingFormula

The rating formula.

structEstabScript

public final com.accela.aa.emse.dom.service.StructureEstablishmentScriptService structEstabScript

The struct estab script.

contractorLicense

public final com.accela.aa.emse.dom.service.ContractorLicenseScriptService contractorLicense

The contractor license.

specialSearch

public final com.accela.aa.emse.dom.service.SpecialSearchScriptService specialSearch

The special search.

reconciliationScript

public final com.accela.aa.emse.dom.service.ReconciliationScriptService reconciliationScript

The reconciliation script.

shoppingCart

public final ShoppingCartScript shoppingCart

globalSearch

public final GlobalSearchScript globalSearch

commonCondition

public final CommonConditionScript commonCondition

education

public final EducationScript education

continuingEducation

public final ContinuingEducationScript continuingEducation

examination

public final ExaminationScript examination

wsConsumer

public final WSConsumerScript wsConsumer

document

public final DocumentScript document

genericTemplate

public final com.accela.aa.emse.dom.service.GenericTemplateScriptService genericTemplate

The generic template.

condition

public final com.accela.aa.emse.dom.service.ConditionScriptService condition

Condition

ownerCondition

public final com.accela.aa.emse.dom.service.OwnerConditionScriptService ownerCondition

Owner Condition

activity

public final com.accela.aa.emse.dom.service.ActivityScriptService activity

activity

guidesheet

public final com.accela.aa.emse.dom.service.GuidesheetScriptService guidesheet

Guidesheet script.

timeStart

public long timeStart

The time start.

tagStart

public java.lang.String tagStart

The tag start.

Constructor Detail

ScriptRoot

public ScriptRoot(java.lang.String serviceProviderCode,
          java.util.Hashtable additionalParameters,
          java.lang.String auditID)
           throws com.accela.aa.exception.AAException

Creates a new ScriptRoot. Contains public objects that each provide functionality accessible by script writers.

Parameters:

serviceProviderCode - agency code

additionalParameters - an Hashtable of additionalParameters

auditID - the audit id

Throws:

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

Method Detail

runScript

public void runScript(java.lang.String scriptID)
               throws java.lang.Exception

Allows a user to execute another script. The same "env" object that was in use by the script executing this method will be passed in to the script executed by this method. When the called script is finished, any changes made by the called script to the "env" will be visible to the calling script.

Parameters:

scriptID - the 'code' for the script (not the 'name')

Throws:

java.lang.Exception - the exception

runAsyncScript

public void runAsyncScript(java.lang.String scriptID,
                  java.util.HashMap envParams)
                    throws java.lang.Exception

Allows a user to execute another script asynchronously via JMS. Notice: the script will be fired only when one transaction is commited successfully.

Parameters:

scriptID - the 'code' for the script (not the 'name')

envParams - the emse parameters

Throws:

java.lang.Exception - the exception

runScriptInNewTransaction

public void runScriptInNewTransaction(java.lang.String scriptID)
                               throws java.lang.Exception

Run ScriptInNewTransaction.

Parameters:

scriptID - String

Throws:

java.lang.Exception - the exception

print

public void print(java.lang.String debugOutputLine)

Appends a line to the debug output of the script.

Parameters:

debugOutputLine - String

log

public void log(java.lang.String content)

Log given content to EMSE output and debug it to system logger.

Parameters:

content - the content

abortScript

public void abortScript()
                 throws com.accela.aa.emse.util.ScriptAbortedException

Abort Script.

Throws:

com.accela.aa.emse.util.ScriptAbortedException - the script aborted exception

getDebugOutput

public java.lang.String getDebugOutput()

Gets the potentially multi-line debug output.

Returns:

String

getServiceProviderCode

public java.lang.String getServiceProviderCode()

Returns the serviceProviderCode.

Returns:

String

runAdHoc

public ScriptResult runAdHoc(java.lang.String reportTitle,
                    java.util.Hashtable reportParam,
                    java.lang.String fileType,
                    java.lang.String fileFormat,
                    java.lang.String emailAddress)
                      throws java.lang.Exception

Invokes the Ad Hoc Report and send the output file through email.

Parameters:

reportTitle - the exact text title of the report.

reportParam - The key-value pairs of the parameters of the report.

fileType - "Tab" or "Excel"

fileFormat - "Heading" or "No Heading".

emailAddress - Email address(es) to send the output file to. Separated with commas if more than one.

Returns:

An object. The getOutput doesnot return a value. Instead the getSuccess method should be checked, and if false the getErrorMessage method should be called to inform the user as to why sending the email failed.

Throws:

java.lang.Exception - the exception

sendMail

public ScriptResult sendMail(java.lang.String FROM,
                    java.lang.String TO,
                    java.lang.String CC,
                    java.lang.String SUBJECT,
                    java.lang.String CONTENT)

Send Mail.

Parameters:

FROM - the email address that send the email

TO - the email address to send

CC - the email address to CC, can be null

SUBJECT - the mail subject

CONTENT - the mail contexnt

Returns:

Result the Result object, getSuccess() can identify whether the email is sent succefully, if fail, getMessage() can tell why?

sendEmail

public ScriptResult sendEmail(java.lang.String FROM,
                     java.lang.String TO,
                     java.lang.String CC,
                     java.lang.String SUBJECT,
                     java.lang.String CONTENT,
                     java.lang.String FILENAME)

Send Email.

Parameters:

FROM - the email address that send the email

TO - the email address to send

CC - the email address to CC, can be null

SUBJECT - the mail subject

CONTENT - the mail contexnt

FILENAME - the fILENAME

Returns:

Result the Result object, getSuccess() can identify whether the email is sent succefully, if fail, getMessage() can tell why?

sendEmailWithAttachedFiles

public ScriptResult sendEmailWithAttachedFiles(java.lang.String from,
                                      java.lang.String to,
                                      java.lang.String cc,
                                      java.lang.String subject,
                                      java.lang.String content,
                                      java.lang.String[] fileNames)

Send Email with multiple attachments.

Parameters:

from - the email address that send the email

to - the email address to send

cc - the email address to CC, can be null

subject - the mail subject

content - the mail content

fileNames - the fileNames array

Returns:

Result the Result object, getSuccess() can identify whether the email is sent successfully, if fail, getMessage() can tell why.

getHashtable

public ScriptResult getHashtable(java.lang.String names,
                        java.lang.String values)

Get Hashtable.

Parameters:

names - String

values - String

Returns:

ScriptResult

getAuditID

public java.lang.String getAuditID()

Returns the auditID.

Returns:

String

runOracleReport

public ScriptResult runOracleReport(java.lang.String desType,
                           java.lang.String reportName,
                           java.lang.String desFormat,
                           java.util.Hashtable reportParam,
                           java.lang.String emailAddress)
                             throws java.lang.Exception

Invokes the Oracle Report and send the output file through email.

Parameters:

desType - String

reportName - the exact text title of the report.

desFormat - String

reportParam - The key-value pairs of the parameters of the report.

emailAddress - Email address(es) to send the output file to. Separated with commas if more than one.

Returns:

An object. The getOutput doesnot return a value. Instead the getSuccess method should be checked, and if false the getErrorMessage method should be called to inform the user as to why sending the email failed.

Throws:

java.lang.Exception - the exception

debug

public void debug(java.lang.String tag,
         java.lang.Object object)

To debug the emse script, can set break point here to inspect the object variable.

Parameters:

tag - tag name

object - the object you want to inspect

timerStart

public void timerStart(java.lang.String tag)

Start time meter.

Parameters:

tag - the tag

timerEnd

public void timerEnd(java.lang.String tag)

Calculate the time elapsed from last meterStart().

Parameters:

tag - the tag

sleep

public void sleep(long time)

Interrupted the emse script for a while.

Parameters:

time - how long to wait

setDelegateAgencyCode

public void setDelegateAgencyCode(java.lang.String delegateAgencyCode)

Set the delegate agency code.

Parameters:

delegateAgencyCode - the delegate agency code

resetDelegateAgencyCode

public void resetDelegateAgencyCode()

Reset the delegate agency code.