i-net Clear Reports

com.inet.report.schedule
Class ExecutedReport

java.lang.Object
  extended by com.inet.report.schedule.ExecutedReport

public class ExecutedReport
extends java.lang.Object

This class stores information about a report which should be executed with this task. Usually this report will hold information about one single instance of this report which means that there is only one configuration of the properties for this report which should be executed.
If you specified an own instance of DynamicProperties then there can be more than one instance. Each instance should then hold a different combination of report properties (usually different prompt values). Each instance will then be executed for the specified action or in a custom action you can execute them yourself.

Since:
i-net Crystal-Clear 6.0

Method Summary
 java.lang.Exception getException()
          This will return the exception occurred when a DynamicProperties class is defined for this report but this class could not be used for some reason.
 ExecutedInstance getInstance(int index)
          Returns the information about one report instance and the report properties of this instance.
 int getInstanceCount()
          Returns the number of report instances which exists for this report.
 ScheduleReport getReport()
          Returns the instance of ScheduleReport which is represented by this class.
 

Method Detail

getReport

public ScheduleReport getReport()
Returns the instance of ScheduleReport which is represented by this class. This is the object where you defined the settings of the report before execution.

Returns:
The originally configured ScheduleReport instance.

getInstanceCount

public int getInstanceCount()
Returns the number of report instances which exists for this report. Ususally this will be 1. Only if you specified a DynamicProperties class for this report this value can be greater than 1.

Returns:
The number of report instances available for this report.
See Also:
getInstance(int)

getInstance

public ExecutedInstance getInstance(int index)
Returns the information about one report instance and the report properties of this instance.

Parameters:
index - The index within the list of instances of this report. Should be 0< index <getInstanceCount().
Returns:
An report instance with the report properties.
See Also:
getInstanceCount()

getException

public java.lang.Exception getException()
This will return the exception occurred when a DynamicProperties class is defined for this report but this class could not be used for some reason. If there was no DynamicProperties class defined for the report or the defined class could be used then null will be returned.

Returns:
The exception occured when trying to load a DynamicProperties class or null if no exception occured.

i-net Clear Reports

Copyright © 1999-2011 by i-net software GmbH