public interface IReportingService
Copyright (c) SAP AG 2003-2004
Modifier and Type | Method and Description |
---|---|
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
IReport s. |
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.
|
IReport getReport(IName name, IResourceContext context) throws ResourceException
name
- of the reportnull
if not found.ResourceException
Set getReports(IResourceContext context) throws ResourceException
IReport
s. The list
is unmodifiable and not live, e.g. will not reflect future
changes.IReport
sResourceException
IResource getResource(IReport report, IResourceContext context) throws ResourceException
report
- to get resource forResourceNotFoundException
- if resource does not existResourceException
IReportResult update(IReportResult result, IResourceContext context) throws ResourceException
result
- to persistcontext
- to work inResourceNotFoundException
- if report could not be locatedNotSupportedException
- if report resource does not support persistenceResourceException
IScheduledReport update(IScheduledReport sr, IResource resource) throws ResourceException
sr
- scheduled report to persistresource
- to updateResourceNotFoundException
- if report could not be locatedNotSupportedException
- if report resource does not support persistenceResourceException
IScheduledReport create(IScheduledReport sr, IResourceContext context) throws ResourceException
sr
- scheduled report to persistcontext
- to use for persistenceResourceNotFoundException
- if report could not be locatedNotSupportedException
- if report resource does not support persistenceResourceException
IScheduledReport getScheduledReport(IResource resource) throws ResourceException
IScheduledReport
.resource
- to convertIScheduledReport
represented by given resource or null
if resource is of wrong typeResourceException
IReportResult getReportResult(IResource resource) throws ResourceException
IReportResult
.resource
- to convertIReportResult
represented by given resource or null
if resource is of wrong typeResourceException
List getRunningReports(IResourceContext context) throws ResourceException
context
- to work inIRunningReport
sResourceException
IRunningReport getRunningReport(String id, IResourceContext context) throws ResourceException
id
- of running reportcontext
- to work innull
if not found.ResourceException
RID getRunningReportsCollection() throws ResourceException
ResourceException
IRunningReport run(String name, IReportInput input, IResourceContext context) throws ResourceException
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
.name
- of running report and result resourceinput
- report input to executecontext
- to work inResourceException
IRunningReport run(String name, IReportInput input, IRIDIterator iter, IResourceContext context) throws ResourceException
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
.name
- of running report and result resourceinput
- for report executioniter
- gives RIDs of resource to apply report tocontext
- to work inResourceException
RID getReportsCollection() throws ResourceException
ResourceException
RID getActiveSchedulesCollection() throws ResourceException
ResourceException
RID registerIDMapping(IName name) throws ResourceException
name
- to register id mapping forResourceException
- when mapping could not be persistedAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice