SrsReportRunInterface Interface [AX 2012]
This class is an interface and provides a set of APIs to integrate running a report programmatically.
| Method | Description | |
|---|---|---|
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| getParameterGroupInfo | |
| getRdpReportParameter | Gets the report parameter instance for the contract data member method name. |
| getReportRunAdapter | Gets an instance of the SrsReportRunAdapter class that is required to view the report in the viewer. |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| initializeContract | Initializes the underlying report contracts |
| new | Initializes a new instance of the Object class. (Inherited from Object.) |
| notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
| notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
| objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| parmIsInBatch | Gets or sets a value that indicates whether the report is running inside a batch job. |
| parmReportContract | Gets or sets the SrsReportDataContract object for the report. |
| postRunReport | Runs any post processing that is required after running the report. |
| preRunReport | Runs any processing that is needed before the report is run. |
| runReport | Runs the report using the data contract. |
| saveReportArchive | Saves a report in a print archive. |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
| validateContract | Validates the contract values. |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
This interface should be used when you want to run a report from your form or code. Application developers who want to take complete control over the rendering and running of a report should use these APIs.
Some of the use cases could be:
-
Custom form that must run the report.
-
Custom implementation of the Controller class of the SysOperation framework.
-
Batch printing – An example is to iterate over each customer record and print the invoice for the customer.
-
Change the report design that is being used at runtime.
-
Change the culture or company that is being used at runtime.
This is a framework class. Customizing this class may cause problems with future upgrades to the software.