com.sapportals.wcm.service.reporting

Interface IRunningReportCollection

public interface IRunningReportCollection

Manages a collection of IRunningReports.

Copyright (c) SAP AG 2003

Method Summary

com.sapportals.wcm.util.uri.RID	getRID() Get RID of collection holding all running reports.
IRunningReport	getRunningReport(String id, IResourceContext context) Get IRunningReport for given id.
List	getRunningReports(IResourceContext context) Get the list of all running reports.
IResource	start(String name, Date started, IReportInput input, IResourceContext context) Start a new running report with given parameters.
IResource	start(String name, Date started, IReportInput input, IRIDIterator iter, IResourceContext context) Start a new running report with given parameters.

Method Detail

getRID

com.sapportals.wcm.util.uri.RID getRID()

Get RID of collection holding all running reports.

Returns:

RID of running report collection.

getRunningReports

List getRunningReports(IResourceContext context)
                       throws ResourceException

Get the list of all running reports. Uses access rights of given resource context.

Parameters:

context - in which collection is read

Returns:

list of IRunningReports

Throws:

ResourceException - on failures

getRunningReport

IRunningReport getRunningReport(String id,
                                IResourceContext context)
                                throws ResourceException

Get IRunningReport for given id.

Parameters:

id - of running report

context - for access

Returns:

running report with given id or null if not found.

Throws:

ResourceException - on failures

start

IResource start(String name,
                Date started,
                IReportInput input,
                IResourceContext context)
                throws ResourceException

Start a new running report with given parameters. Returns the resource representing the running report.

Parameters:

name - of running report

started - start time of execution

input - parameters for execution

context - to operate in

Returns:

resource representing running report

Throws:

ResourceException - on failures

start

IResource start(String name,
                Date started,
                IReportInput input,
                IRIDIterator iter,
                IResourceContext context)
                throws ResourceException

Start a new running report with given parameters. Returns the resource representing the running report.

Parameters:

name - of running report

started - start time of execution

input - parameters for execution

iter - for resources report should be applied to

context - to operate in

Returns:

resource representing running report

Throws:

ResourceException - on failures

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM