The ReportObjectFactory class is the entry point to application report object manipulation. This factory manages access to reports via API, updating that report’s schedules when required (rename, delete), and creation of new reports. This class logically sits on top of ReportMgmtBase and ReportScheduler for higher level report management.
The ReportObjectFactory has the following properties:
The ReportObjectFactory has the following methods:
Description |
Create a new report object, it has yet to be saved into the report repository |
Remarks |
The created report object is made the active report object on return. Both the Report class and the DashboardReport class inherit from ReportObject, a cast to the appropriate child class is required for more specific access to the report. |
Description |
Load an existing report object from the report repository. |
Remarks |
The loaded report object is made the active report object on return. Both the Report class and the DashboardReport class inherit from ReportObject, a cast to the appropriate child class is required for more specific access to the report. |
Description |
Delete the provided report from the report repository. |
Remarks |
The deleted report object is made the active report object on return. |
Description |
Delete the provided report object the report repository. |
Remarks |
The deleted report object is made the active report object on return. |
Description |
Delete the currently active report object from the report repository. |
Description |
Rename the provided report in the report repository. |
Remarks |
The renamed report object is made the active report object on return. |
Description |
Rename the provided report object in the report repository. |
Remarks |
The renamed report object is made the active report object on return. |
Description |
Rename the currently active report object in the report repository. |
Description |
Copy the provided report in the report repository to another location in the report repository. |
Description |
Copy the provided report object to another location in the report repository. |
Description |
Save the provided report object to the report repository. If it already exists it will be overwritten. |
Description |
Save the provided report object to an API area which can be accessed by the application once it’s given control via Api.GetUrlParamString |
The ReportObject class is an abstract class that all report objects derive from. It contains all properties and methods that are common for any type of report within the application.
The ReportObject has the following properties: