com.sapportals.wcm.service.reporting

Interface IReportingService

public interface IReportingService

Manages execution of reports and persistence of report objects.

Copyright (c) SAP AG 2003-2004

Method Summary

IScheduledReport	create(IScheduledReport sr, IResourceContext context) Create a scheduled report at a new storage location.
RID	getActiveSchedulesCollection() Get RID of collection containing active scheduled reports.
IReport	getReport(IName name, IResourceContext context) Lookup a report by name.
IReportResult	getReportResult(IResource resource) Convert a resource to a IReportResult.
Set	getReports(IResourceContext context) Get the set of all known IReports.
RID	getReportsCollection() Get RID of collection containing reports.
IResource	getResource(IReport report, IResourceContext context) Get the resource representing the report
IRunningReport	getRunningReport(String id, IResourceContext context) Get running report with given id.
List	getRunningReports(IResourceContext context) Get the list of all currently running reports.
RID	getRunningReportsCollection() Get RID of collection displaying running reports.
IScheduledReport	getScheduledReport(IResource resource) Convert a resource to a IScheduledReport.
RID	registerIDMapping(IName name) Reserves a unique and persistent namespace prefix for the given name.
IRunningReport	run(String name, IReportInput input, IResourceContext context) Run a IReportInput immediately in the given context.
IRunningReport	run(String name, IReportInput input, IRIDIterator iter, IResourceContext context) Run a IReportInput immediately in the given context.
IReportResult	update(IReportResult result, IResourceContext context) Persist a report result at the default storage location.
IScheduledReport	update(IScheduledReport sr, IResource resource) Persist a scheduled report at the resource.

Method Detail

getReport

public IReport getReport(IName name,
                         IResourceContext context)
                  throws ResourceException

Lookup a report by name.

Parameters:

name - of the report

Returns:

IReport with given name or null if not found.

Throws:

ResourceException

getReports

public Set getReports(IResourceContext context)
               throws ResourceException

Get the set of all known IReports. The list is unmodifiable and not live, e.g. will not reflect future changes.

Returns:

set of IReports

Throws:

ResourceException

getResource

public IResource getResource(IReport report,
                             IResourceContext context)
                      throws ResourceException

Get the resource representing the report

Parameters:

report - to get resource for

Returns:

resource representing report

Throws:

ResourceNotFoundException - if resource does not exist

ResourceException

update

public IReportResult update(IReportResult result,
                            IResourceContext context)
                     throws ResourceException

Persist a report result at the default storage location.

Parameters:

result - to persist

context - to work in

Returns:

IReportResult with IResource where result was persisted to

Throws:

ResourceNotFoundException - if report could not be located

NotSupportedException - if report resource does not support persistence

ResourceException

update

public IScheduledReport update(IScheduledReport sr,
                               IResource resource)
                        throws ResourceException

Persist a scheduled report at the resource.

Parameters:

sr - scheduled report to persist

resource - to update

Returns:

IScheduledReport which contains IResource it was persisted to

Throws:

ResourceNotFoundException - if report could not be located

NotSupportedException - if report resource does not support persistence

ResourceException

create

public IScheduledReport create(IScheduledReport sr,
                               IResourceContext context)
                        throws ResourceException

Create a scheduled report at a new storage location.

Parameters:

sr - scheduled report to persist

context - to use for persistence

Returns:

IScheduledReport which contains IResource it was persisted to

Throws:

ResourceNotFoundException - if report could not be located

NotSupportedException - if report resource does not support persistence

ResourceException

getScheduledReport

public IScheduledReport getScheduledReport(IResource resource)
                                    throws ResourceException

Convert a resource to a IScheduledReport.

Parameters:

resource - to convert

Returns:

IScheduledReport represented by given resource or null if resource is of wrong type

Throws:

ResourceException

getReportResult

public IReportResult getReportResult(IResource resource)
                              throws ResourceException

Convert a resource to a IReportResult.

Parameters:

resource - to convert

Returns:

IReportResult represented by given resource or null if resource is of wrong type

Throws:

ResourceException

getRunningReports

public List getRunningReports(IResourceContext context)
                       throws ResourceException

Get the list of all currently running reports.

Parameters:

context - to work in

Returns:

list of IRunningReports

Throws:

ResourceException

getRunningReport

public IRunningReport getRunningReport(String id,
                                       IResourceContext context)
                                throws ResourceException

Get running report with given id.

Parameters:

id - of running report

context - to work in

Returns:

running report with given id or null if not found.

Throws:

ResourceException

getRunningReportsCollection

public RID getRunningReportsCollection()
                                throws ResourceException

Get RID of collection displaying running reports.

Returns:

RID of collection displaying running reports

Throws:

ResourceException

run

public IRunningReport run(String name,
                          IReportInput input,
                          IResourceContext context)
                   throws ResourceException

Run a IReportInput immediately in the given context. Use the given name for the running report and its produced result. The report is run asynchronously and the method returns IRunningReport.

Parameters:

name - of running report and result resource

input - report input to execute

context - to work in

Returns:

running report

Throws:

ResourceException

run

public IRunningReport run(String name,
                          IReportInput input,
                          IRIDIterator iter,
                          IResourceContext context)
                   throws ResourceException

Run a IReportInput immediately in the given context. Use the given name for the running report and its produced result. The report is run asynchronously and the method returns IRunningReport.

Parameters:

name - of running report and result resource

input - for report execution

iter - gives RIDs of resource to apply report to

context - to work in

Returns:

running report

Throws:

ResourceException

getReportsCollection

public RID getReportsCollection()
                         throws ResourceException

Get RID of collection containing reports.

Returns:

RID of collection containing reports

Throws:

ResourceException

getActiveSchedulesCollection

public RID getActiveSchedulesCollection()
                                 throws ResourceException

Get RID of collection containing active scheduled reports.

Returns:

RID of collection containing active scheduled reports

Throws:

ResourceException

registerIDMapping

public RID registerIDMapping(IName name)
                      throws ResourceException

Reserves a unique and persistent namespace prefix for the given name. Once registered, the RID will stay the same forever on this server.

Parameters:

name - to register id mapping for

Returns:

RID prefix reserved for this name

Throws:

ResourceException - when mapping could not be persisted