com.sapportals.wcm.service.reporting

Class ReportInput

java.lang.Object
  com.sapportals.wcm.service.reporting.ReportInput

All Implemented Interfaces:

IReportInput

public final class ReportInput
extends Object
implements IReportInput

Represents input for a report execution.

Copyright (c) SAP AG 2003

Field Summary

Fields inherited from interface com.sapportals.wcm.service.reporting.IReportInput

UNLIMITED_RESULTS

Method Summary

List	getCommandInputs() Get list of IReportCommandInputs.
static ReportInput	getInstance(com.sapportals.wcm.util.name.IName report, IPropertyMap params, List inputs)
static ReportInput	getInstance(com.sapportals.wcm.util.name.IName report, List scope)
static ReportInput	getInstance(com.sapportals.wcm.util.name.IName report, List scope, int maxResults, IPropertyMap params, List inputs)
int	getMaxResults() Get the maximum number of results the report should produce.
IPropertyMap	getParameters() Get parameters for the report itself.
com.sapportals.wcm.util.name.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.
String	toString() Returns a string representation of this ReportInput object and values of its member variables.
IReportInputError	verify(IResourceContext context) Verify that input is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static ReportInput getInstance(com.sapportals.wcm.util.name.IName report,
                                      List scope,
                                      int maxResults,
                                      IPropertyMap params,
                                      List inputs)

getInstance

public static ReportInput getInstance(com.sapportals.wcm.util.name.IName report,
                                      IPropertyMap params,
                                      List inputs)

getInstance

public static ReportInput getInstance(com.sapportals.wcm.util.name.IName report,
                                      List scope)

getReportName

public com.sapportals.wcm.util.name.IName getReportName()

Description copied from interface: IReportInput

Get name of report that should handle this input

Specified by:

getReportName in interface IReportInput

Returns:

name of handling report

getScope

public List getScope()

Description copied from interface: IReportInput

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

Specified by:

getScope in interface IReportInput

Returns:

list of RIDs with scope

getParameters

public IPropertyMap getParameters()

Description copied from interface: IReportInput

Get parameters for the report itself.

Specified by:

getParameters in interface IReportInput

Returns:

parameters for the report

getCommandInputs

public List getCommandInputs()

Description copied from interface: IReportInput

Get list of IReportCommandInputs.

Specified by:

getCommandInputs in interface IReportInput

Returns:

list of IReportCommandInputs

getMaxResults

public int getMaxResults()

Description copied from interface: IReportInput

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.

Specified by:

getMaxResults in interface IReportInput

Returns:

maximum number of results

setScope

public IReportInput setScope(List scope)

Description copied from interface: IReportInput

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

Specified by:

setScope in interface IReportInput

Parameters:

scope - list of RIDs with scope

Returns:

IReportInput with given parameters

setParameters

public IReportInput setParameters(IPropertyMap params)

Description copied from interface: IReportInput

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

Specified by:

setParameters in interface IReportInput

Parameters:

params - new input parameter

Returns:

IReportInput with given parameters

setCommandInputs

public IReportInput setCommandInputs(List commandInputs)

Description copied from interface: IReportInput

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

Specified by:

setCommandInputs in interface IReportInput

Parameters:

commandInputs - new input for commands

Returns:

IReportInput with given command inputs

setMaxResults

public IReportInput setMaxResults(int max)

Description copied from interface: IReportInput

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

Specified by:

setMaxResults in interface IReportInput

Parameters:

max - results to produce

Returns:

IReportInput with given maxmimum results

verify

public IReportInputError verify(IResourceContext context)
                         throws ResourceException

Description copied from interface: IReportInput

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.

Specified by:

verify in interface IReportInput

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

toString

public String toString()

Returns a string representation of this ReportInput object and values of its member variables.

Overrides:

toString in class Object

Returns:

a string representation of this ReportInput object and values of its member variables.

Access Rights

This class can be accessed from:

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