Thor.API.Operations
Interface ReportOperationsIntf

public interface ReportOperationsIntf

Method Summary

Thor.API.tcResultSet	findReportsFiltered(java.util.Map attributeMap, java.lang.String[] fieldList) Returns a list of reports (in the form of a tcResultSet) that matches the provided attribute list.
Thor.API.tcResultSet	getCSVReportData(com.thortech.xl.vo.report.ReportInput reportInput) This method will return the data to be included in the CSV file
Thor.API.tcResultSet	getHistoricalReports(long userKey) Returns a list of historical reports (in the form of a tcResultSet) that are avaliable for the provided user
Thor.API.tcResultSet	getOperationalReports(long userKey) Returns a list of Operational reports (in the form of a tcResultSet) that are avaliable for the provided user
Thor.API.tcResultSet	getPagedReportData(com.thortech.xl.vo.report.ReportInput reportInput) Returns one page of report data as a result set.
com.thortech.xl.vo.report.ReportMeta	getReportMetadata(long reportKey) Gets the meta data for the report represented by the provided report key

Method Detail

getOperationalReports

public Thor.API.tcResultSet getOperationalReports(long userKey)
                                           throws Thor.API.Exceptions.tcUserNotFoundException,
                                                  Thor.API.Exceptions.tcAPIException,
                                                  tcAPIException

Returns a list of Operational reports (in the form of a tcResultSet) that are avaliable for the provided user

Parameters:

userKey - Key of the user for whom the reports need to be returned

Returns:

A tcResultSet in which each row holds details about each report that has been returned

Throws:

tcAPIException

Thor.API.Exceptions.tcUserNotFoundException

getHistoricalReports

public Thor.API.tcResultSet getHistoricalReports(long userKey)
                                          throws Thor.API.Exceptions.tcUserNotFoundException,
                                                 Thor.API.Exceptions.tcAPIException,
                                                 tcAPIException

Returns a list of historical reports (in the form of a tcResultSet) that are avaliable for the provided user

Parameters:

userKey - Key of the user for whom the reports need to be returned

Returns:

A tcResultSet in which each row holds details about each report that has been returned

Throws:

tcAPIException

Thor.API.Exceptions.tcUserNotFoundException

getReportMetadata

public com.thortech.xl.vo.report.ReportMeta getReportMetadata(long reportKey)
                                                       throws Thor.API.Exceptions.tcAPIException,
                                                              tcAPIException

Gets the meta data for the report represented by the provided report key

Parameters:

reportKey - Key of the report whose meta data is required

Returns:

A ReportMeta object which represents the meta data for the report

Throws:

tcAPIException

getPagedReportData

public Thor.API.tcResultSet getPagedReportData(com.thortech.xl.vo.report.ReportInput reportInput)
                                        throws Thor.API.Exceptions.tcAPIException,
                                               tcAPIException

Returns one page of report data as a result set. The page size will be provided in the ReportInput VO

Parameters:

reportInput - Contains all the information required by the API method to call the stored procedure

Returns:

A Result Set containing the report data for the queried page

Throws:

tcAPIException

getCSVReportData

public Thor.API.tcResultSet getCSVReportData(com.thortech.xl.vo.report.ReportInput reportInput)
                                      throws Thor.API.Exceptions.tcAPIException,
                                             tcAPIException

This method will return the data to be included in the CSV file

Parameters:

reportInput - Contains all the information required by the API method to call the stored procedure

Returns:

A Result Set containing the report data for the queried page

Throws:

tcAPIException

findReportsFiltered

public Thor.API.tcResultSet findReportsFiltered(java.util.Map attributeMap,
                                                java.lang.String[] fieldList)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Returns a list of reports (in the form of a tcResultSet) that matches the provided attribute list.

Parameters:

attributeMap - A map of attribute-value pairs

fieldList - A list of fields which need to be returned

Returns:

A tcResultSet in which each row holds details about the groups that were found

Throws:

tcAPIException