com.sapportals.wcm.service.reporting

Interface IReportResult

public interface IReportResult

Represents result of a report execution.

Copyright (c) SAP AG 2003-2004

Method Summary

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) Get list of result items, starting at given offset with given maximum length.
String	getName() Return name (not necessarily unique) of this result
IName	getReportName() Get the name of the report which produced this result
IResource	getResource() Get IResource this result is persisted in, if at all.
List	getResultPropertyNames() Get 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() Get description of result status.
List	getSummaryProperties() Get the list of IPropertys which give a summary of the report execution.
IResultIterator	iterator() Get iterator over all individual IResultItems
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

Method Detail

getName

public String getName()

Return name (not necessarily unique) of this result

Returns:

name of this result

getReportName

public IName getReportName()
                    throws ResourceException

Get the name of the report which produced this result

Returns:

name of report which producec this result

Throws:

ResourceException

getInput

public IReportInput getInput()
                      throws ResourceException

Get input data used for the generation of this result

Returns:

input used for result generation

Throws:

ResourceException

wasExecuted

public Date wasExecuted()
                 throws ResourceException

Get date the report was executed

Returns:

exection date of report

Throws:

ResourceException

took

public long took()
          throws ResourceException

Get execution time of the report (milliseconds)

Returns:

duration of the report exection (milliseconds)

Throws:

ResourceException

getStatus

public ReportStatus getStatus()

Determines status of report.

Returns:

status of report

getStatusDescription

public String getStatusDescription()

Get description of result status.

Returns:

description of result status

getResultPropertyNames

public List getResultPropertyNames()
                            throws ResourceException

Get the list of property names which are set for each result item.

Returns:

list of IPropertyNames

Throws:

ResourceException

getSummaryProperties

public List getSummaryProperties()
                          throws ResourceException

Get the list of IPropertys which give a summary of the report execution. The list maybe empty but is not null.

Returns:

list of IPropertys

Throws:

ResourceException

getResultSize

public int getResultSize()
                  throws ResourceException

Get number of individual items reported.

Returns:

number of contained result items

Throws:

ResourceException

iterator

public IResultIterator iterator()
                         throws ResourceException

Get iterator over all individual IResultItems

Returns:

iterator over individual IResultItems

Throws:

ResourceException

getItems

public List getItems(int offset,
                     int length)
              throws ResourceException

Get list of result items, starting at given offset with given maximum length.

Parameters:

offset - to start list at

length - maximum length of returned list

Returns:

sublist of IResultItems

Throws:

ResourceException

getItem

public IResultItem getItem(int index)
                    throws ResourceException

Retrieve index-th result item.

Parameters:

index - of result item to get

Returns:

index-th result item

Throws:

ResourceException - on general failures

getResource

public IResource getResource()
                      throws ResourceException

Get IResource this result is persisted in, if at all.

Returns:

IResource this result is persisted in or null if result was not persisted (yet)

Throws:

ResourceException

setResource

public IReportResult setResource(IResource resource)

Create a IReportResult which is a clone of the current result with the resource set to the given value.

Parameters:

resource - to set in result

Returns:

IReportResult with given resource

setName

public IReportResult setName(String name)

Create a IReportResult which is a clone of the current result with the name set to the given value.

Parameters:

name - to set in result

Returns:

IReportResult with given name

showResultItemRID

public boolean showResultItemRID()

Hint for display the RIDs of result items to the user.

Returns:

iff result item RIDs should be displayed to the user

showResultItemDescription

public boolean showResultItemDescription()

Hint for display the descriptions of result items to the user.

Returns:

iff result item descriptions should be displayed to the user