Interface IReportService

Namespace: BoldReports.ServerProcessor

Assembly: BoldReports.Web.dll

Syntax

public interface IReportService

Properties

IsExecuted

Indicates whether the processing task has been executed.

Declaration

bool IsExecuted { get; set; }

Property Value

Type	Description
System.Boolean	True if the task has been executed; otherwise, false.

Methods

CreateReportDefinition(String, String, Byte[])

Creates a report definition in the specified folder with the provided name and data.

Declaration

bool CreateReportDefinition(string reportname, string folderName, byte[] reportData)

Parameters

Type	Name	Description
System.String	reportname	The name of the report to be created.
System.String	folderName	The name of the folder where the report will be stored.
System.Byte[]	reportData	A byte array containing the report's data.

Returns

Type	Description
System.Boolean	A boolean value indicating the success or failure of the operation.

GetCatalogItem(String)

Retrieves a list of catalog items from the specified folder.

Declaration

List<CatalogItem> GetCatalogItem(string folderName)

Parameters

Type	Name	Description
System.String	folderName	The name of the folder from which to retrieve the catalog items.

Returns

Type	Description
System.Collections.Generic.List<BoldReports.ServerProcessor.CatalogItem>	A list of BoldReports.ServerProcessor.CatalogItem objects contained within the specified folder.

GetDataSourceDefinition(String)

Retrieves the data source definition for a given data source name.

Declaration

DataSourceDefinition GetDataSourceDefinition(string dataSource)

Parameters

Type	Name	Description
System.String	dataSource	The name of the data source for which the definition is to be retrieved.

Returns

Type	Description
BoldReports.ServerProcessor.DataSourceDefinition	A BoldReports.ServerProcessor.DataSourceDefinition object that contains the detailed configuration of the specified data source.

GetReportDefinition()

Retrieves the report definition as a byte array.

Declaration

byte[] GetReportDefinition()

Returns

Type	Description
System.Byte[]	A byte array that represents the report definition.

GetSharedDataSet(String)

Retrieves information about a shared dataset based on the specified path.

Declaration

SharedDatasetinfo GetSharedDataSet(string path)

Parameters

Type	Name	Description
System.String	path	The path to locate the shared dataset.

Returns

Type	Description
BoldReports.ServerProcessor.SharedDatasetinfo	A SharedDatasetinfo object containing details of the shared dataset found at the given path.

SetReportDefinition(Byte[])

Sets the report definition by accepting a byte array of report data.

Declaration

bool SetReportDefinition(byte[] reportData)

Parameters

Type	Name	Description
System.Byte[]	reportData

Returns

Type	Description
System.Boolean	Returns a boolean indicating success (true) or failure (false) of setting the report definition.