com.accela.aa.emse.dom

Class RunReportScript

java.lang.Object

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

com.accela.aa.emse.dom.RunReportScript

All Implemented Interfaces:

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

public class RunReportScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.RunReportScriptService

 
  Accela Automation
  File: RunReportScript
 
  Accela, Inc.
  Copyright (C): 2007-2014
 
  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: RunReportScript.java 270462 2014-04-28 10:05:58Z ..\rain.wang $    
 
 
  Revision History: 
  02/01/2007 Jason.Wang   Initial
 

Constructor Summary

Constructors

Constructor and Description
RunReportScript() Instantiates a new run report script.
RunReportScript(java.lang.String serviceProviderCode, java.lang.String auditId, com.accela.aa.emse.dom.service.CachedService cachedService) Instantiates a new run report script.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	getReportDetailModel() Gets the report detail model.
ScriptResult	getReportInfoModelByName(java.lang.String reportName) Get the report model by report name.
ScriptResult	getReportModelByName(java.lang.String reportName) Get the report model by report name.
ScriptResult	getReportResult(ReportInfoScriptModel reportInfoModel) get the report result.
ScriptResult	getReportScriptModel(com.accela.v360.reports.ReportDetailModel reportDetailModel) Gets the report script model.
ScriptResult	hasPermission(java.lang.String reportName, java.lang.String userID) Check if the user has the permission on the report.
ScriptResult	runReport(java.util.HashMap paremters, ReportScriptModel reportScriptModel) Constuct the Report URI String that used to open a report window.
ScriptResult	sendReportInEmail(ReportInfoScriptModel reportInfoModel, ReportResultScriptModel reportResult) get the report result.
ScriptResult	storeReportToDisk(ReportResultScriptModel reportResult) store report to disk.

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

RunReportScript

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

Instantiates a new run report script.

Parameters:

serviceProviderCode - the service provider code

auditId - the audit id

Throws:

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

RunReportScript

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

Instantiates a new run report script.

Throws:

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

Method Detail

hasPermission

public ScriptResult hasPermission(java.lang.String reportName,
                         java.lang.String userID)

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

Check if the user has the permission on the report.

Specified by:

hasPermission in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

reportName - the report name

userID - the user id

Returns:

ScriptResult: true or false

getReportModelByName

public ScriptResult getReportModelByName(java.lang.String reportName)

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

Get the report model by report name.

Specified by:

getReportModelByName in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

reportName - the report name

Returns:

ScriptResult: ReportScriptModel

getReportInfoModelByName

public ScriptResult getReportInfoModelByName(java.lang.String reportName)

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

Get the report model by report name.

Specified by:

getReportInfoModelByName in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

reportName - the report name

Returns:

ScriptResult: ReportScriptModel

runReport

public ScriptResult runReport(java.util.HashMap paremters,
                     ReportScriptModel reportScriptModel)

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

Constuct the Report URI String that used to open a report window.

Specified by:

runReport in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

paremters - A HashMap that used to run the report.

reportScriptModel - the report script model

Returns:

ScriptResult: Report URI

getReportScriptModel

public ScriptResult getReportScriptModel(com.accela.v360.reports.ReportDetailModel reportDetailModel)

Gets the report script model.

Parameters:

reportDetailModel - the report detail model

Returns:

the report script model

getReportDetailModel

public ScriptResult getReportDetailModel()

Gets the report detail model.

Returns:

the report detail model

getReportResult

public ScriptResult getReportResult(ReportInfoScriptModel reportInfoModel)

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

get the report result.

Specified by:

getReportResult in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

reportInfoModel - the report info model

Returns:

the report result

sendReportInEmail

public ScriptResult sendReportInEmail(ReportInfoScriptModel reportInfoModel,
                             ReportResultScriptModel reportResult)

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

get the report result.

Specified by:

sendReportInEmail in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

reportInfoModel - the report info model

reportResult - the report result

Returns:

the script result

storeReportToDisk

public ScriptResult storeReportToDisk(ReportResultScriptModel reportResult)

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

store report to disk.

Specified by:

storeReportToDisk in interface com.accela.aa.emse.dom.service.RunReportScriptService

Parameters:

reportResult - the report result

Returns:

the script result