C# Class ASR.Interface.Report

Show file Open project: Sitecore/AdvancedSystemReporter Class Usage Examples

Public Methods

Method Description
AddFilter ( ASR.DomainObjects.FilterItem filter ) : void

Add a filter to the report

AddScanner ( ASR.DomainObjects.ScannerItem scanner ) : void

Add a Scanner to the report

AddViewer ( ASR.DomainObjects.ViewerItem viewer ) : void

Add a viewer to the report

Filter ( ) : void

Filters the results. All filters are "and" so an item needs to pass all filters to appear on the report.

FlushCache ( ) : void

flush the buffer for the scanner, so next time the report runs, scanner will be queried again.

FlushFilterCache ( ) : void

Flush the cache for the filtered elements, next time the filters will be called again.

GetResultElements ( ) : IEnumerable

Gets the results in this report. Will call Run() if it hasn't been called yet.

GetResultElements ( int start, int count ) : IEnumerable

Gets only a selection of the results elements. Useful for paging.

Report ( ) : System
ResultsCount ( ) : int

Total number of results.

Run ( ) : void

Run the report. It will only requery the Scanner if FlushCache has been used before calling this method.

Private Methods

Method Description
IntializeDisplayElement ( object resultItem ) : DisplayElement
ParseDate ( string value ) : object
Sort ( IEnumerable tmp ) : IEnumerable

Method Details

AddFilter() public method

Add a filter to the report
public AddFilter ( ASR.DomainObjects.FilterItem filter ) : void
filter ASR.DomainObjects.FilterItem
return void

AddScanner() public method

Add a Scanner to the report
public AddScanner ( ASR.DomainObjects.ScannerItem scanner ) : void
scanner ASR.DomainObjects.ScannerItem
return void

AddViewer() public method

Add a viewer to the report
public AddViewer ( ASR.DomainObjects.ViewerItem viewer ) : void
viewer ASR.DomainObjects.ViewerItem
return void

Filter() public method

Filters the results. All filters are "and" so an item needs to pass all filters to appear on the report.
public Filter ( ) : void
return void

FlushCache() public method

flush the buffer for the scanner, so next time the report runs, scanner will be queried again.
public FlushCache ( ) : void
return void

FlushFilterCache() public method

Flush the cache for the filtered elements, next time the filters will be called again.
public FlushFilterCache ( ) : void
return void

GetResultElements() public method

Gets the results in this report. Will call Run() if it hasn't been called yet.
public GetResultElements ( ) : IEnumerable
return IEnumerable

GetResultElements() public method

Gets only a selection of the results elements. Useful for paging.
public GetResultElements ( int start, int count ) : IEnumerable
start int first result to return
count int number of results to return
return IEnumerable

Report() public method

public Report ( ) : System
return System

ResultsCount() public method

Total number of results.
public ResultsCount ( ) : int
return int

Run() public method

Run the report. It will only requery the Scanner if FlushCache has been used before calling this method.
public Run ( ) : void
return void