com.sapportals.wcm.service.reporting

Interface IReportCollection

public interface IReportCollection

Manages a collection of IReports.

Copyright (c) SAP AG 2003-2004

Method Summary

Modifier and Type	Method and Description
RID	getActiveSchedulesCollection() Get collection, containing all active scheduled reports
IReport	getReport(IName name, IResourceContext context) Return IReport with given name or null if not found.
RID	getReportCollection() Get collection, containing all reports
RID	getReportRID(IName name) Return RID of report resource with given name or null if not found.
Set	getReportSet(IResourceContext context) Return set of available IReports.
IRunningReportCollection	getRunningReportCollection() Get running collection, managing all running reports
Set	getSchedulesDue() Get set of IScheduledReports which are due for execution.
RID	registerIDMapping(IName name, IResourceContext context) Reserves a unique and persistent namespace prefix for the given name.

Method Detail

getReportSet

Set getReportSet(IResourceContext context)
          throws ResourceException

Return set of available IReports.

Parameters:

context - to operate in

Returns:

set of available IReports

Throws:

ResourceException - on general failure

getReport

IReport getReport(IName name,
                  IResourceContext context)
           throws ResourceException

Return IReport with given name or null if not found.

Parameters:

name - of report to look up

context - The context to operate in

Returns:

IReport with given name or null

Throws:

ResourceException - on general failure

getReportRID

RID getReportRID(IName name)
          throws ResourceException

Return RID of report resource with given name or null if not found.

Parameters:

name - of report to look up RID for

Returns:

RID if report with given name or null

Throws:

ResourceException - on general failure

getRunningReportCollection

IRunningReportCollection getRunningReportCollection()

Get running collection, managing all running reports

Returns:

RID of running collection

getReportCollection

RID getReportCollection()

Get collection, containing all reports

Returns:

RID of reports collection

getActiveSchedulesCollection

RID getActiveSchedulesCollection()

Get collection, containing all active scheduled reports

Returns:

RID of active scheduled reports collection

getSchedulesDue

Set getSchedulesDue()
             throws ResourceException

Get set of IScheduledReports which are due for execution.

Returns:

set of IScheduledReports due for execution

Throws:

ResourceException - if an error occurred

registerIDMapping

RID registerIDMapping(IName name,
                      IResourceContext context)
               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

context - The context to operate in

Returns:

RID prefix reserved for this name

Throws:

ResourceException - when mapping could not be persisted