public interface IReportResult
Copyright (c) SAP AG 2003-2004
Modifier and Type | Method and Description |
---|---|
IReportInput |
getInput()
Get input data used for the generation of this result
|
IResultItem |
getItem(int index)
Retrieve index-th result item.
|
List |
getItems(int offset,
int length)
Returns a list of result items, starting at given offset with given
maximum length.
|
String |
getName()
Returns the name (not necessarily unique) of this result
|
IName |
getReportName()
Returns the name of the report which produced this result
|
IResource |
getResource()
Returns an IResource this result is persisted in, if at all.
|
List |
getResultPropertyNames()
Returns the list of property names which are set for each result item.
|
int |
getResultSize()
Get number of individual items reported.
|
ReportStatus |
getStatus()
Determines status of report.
|
String |
getStatusDescription()
Returns the description of result status.
|
List |
getSummaryProperties()
Returns the list of
IProperty s which give a summary of the
report execution. |
IResultIterator |
iterator()
Get iterator over all individual
IResultItem s |
IReportResult |
setName(String name)
Create a IReportResult which is a clone of the current result with
the name set to the given value.
|
IReportResult |
setResource(IResource resource)
Create a IReportResult which is a clone of the current result with
the resource set to the given value.
|
boolean |
showResultItemDescription()
Hint for display the descriptions of result items to the user.
|
boolean |
showResultItemRID()
Hint for display the RIDs of result items to the user.
|
long |
took()
Get execution time of the report (milliseconds)
|
Date |
wasExecuted()
Get date the report was executed
|
String getName()
IName getReportName() throws ResourceException
ResourceException
- if an error occurredIReportInput getInput() throws ResourceException
ResourceException
- if an error occurredDate wasExecuted() throws ResourceException
ResourceException
- if an error occurredlong took() throws ResourceException
ResourceException
- if an error occurredReportStatus getStatus()
String getStatusDescription()
List getResultPropertyNames() throws ResourceException
IPropertyName
sResourceException
- if an error occurredList getSummaryProperties() throws ResourceException
IProperty
s which give a summary of the
report execution. The list maybe empty but is not null
.IProperty
sResourceException
- if an error occurredint getResultSize() throws ResourceException
ResourceException
- if an error occurredIResultIterator iterator() throws ResourceException
IResultItem
sIResultItem
sResourceException
- if an error occurredList getItems(int offset, int length) throws ResourceException
offset
- to start list atlength
- maximum length of returned listIResultItem
sResourceException
- if an error occurredIResultItem getItem(int index) throws ResourceException
index
- of result item to getResourceException
- on general failuresResourceException
- if an error occurredIResource getResource() throws ResourceException
null
if
result was not persisted (yet)ResourceException
- if an error occurredIReportResult setResource(IResource resource)
resource
- to set in resultIReportResult setName(String name)
name
- to set in resultboolean showResultItemRID()
boolean showResultItemDescription()
Access 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