com.sapportals.wcm.service.reporting

Interface IReportInput

All Known Implementing Classes:

ReportInput

public interface IReportInput

Represents input for a report execution.

Copyright (c) SAP AG 2003-2004

Field Summary

static int

UNLIMITED_RESULTS

Method Summary

List	getCommandInputs() Get list of IReportCommandInputs.
int	getMaxResults() Get the maximum number of results the report should produce.
IPropertyMap	getParameters() Get parameters for the report itself.
IName	getReportName() Get name of report that should handle this input
List	getScope() Get scope where report should be applied.
IReportInput	setCommandInputs(List commandInputs) Create a new IReportInput with the given command inputs.
IReportInput	setMaxResults(int max) Create a new IReportInput with the given number of maximum results.
IReportInput	setParameters(IPropertyMap params) Create a new IReportInput with the given parameters.
IReportInput	setScope(List scope) Create a new IReportInput with the given scope.
IReportInputError	verify(IResourceContext context) Verify that input is valid.

Field Detail

UNLIMITED_RESULTS

public static final int UNLIMITED_RESULTS

See Also:

Constant Field Values

Method Detail

getReportName

public IName getReportName()

Get name of report that should handle this input

Returns:

name of handling report

getParameters

public IPropertyMap getParameters()

Get parameters for the report itself.

Returns:

parameters for the report

getCommandInputs

public List getCommandInputs()

Get list of IReportCommandInputs.

Returns:

list of IReportCommandInputs

verify

public IReportInputError verify(IResourceContext context)
                         throws ResourceException

Verify that input is valid. The verification takes the context the report shall be executed in into account. There might be checks on access permissions or administrator rights necessary for the check.

Parameters:

context - the execution shall happen and the input needs to be valid in.

Returns:

null on success and detailed error description otherwise.

Throws:

ResourceException

getScope

public List getScope()

Get scope where report should be applied. If no special scope is set, an empty list is returned.

Returns:

list of RIDs with scope

getMaxResults

public int getMaxResults()

Get the maximum number of results the report should produce. A value of -1 indicates that there is no limit imposed on the number of produced results.

Returns:

maximum number of results

setScope

public IReportInput setScope(List scope)

Create a new IReportInput with the given scope. All other values are taken from this instance.

Parameters:

scope - list of RIDs with scope

Returns:

IReportInput with given parameters

setMaxResults

public IReportInput setMaxResults(int max)

Create a new IReportInput with the given number of maximum results.

Parameters:

max - results to produce

Returns:

IReportInput with given maxmimum results

setParameters

public IReportInput setParameters(IPropertyMap params)

Create a new IReportInput with the given parameters. All other values are taken from this instance.

Parameters:

params - new input parameter

Returns:

IReportInput with given parameters

setCommandInputs

public IReportInput setCommandInputs(List commandInputs)

Create a new IReportInput with the given command inputs. All other values are taken from this instance.

Parameters:

commandInputs - new input for commands

Returns:

IReportInput with given command inputs