public final class ReportInput extends Object implements IReportInput
Copyright (c) SAP AG 2003
UNLIMITED_RESULTS
Modifier and Type | Method and Description |
---|---|
List |
getCommandInputs()
Returns a list of
IReportCommandInput s. |
static ReportInput |
getInstance(IName report,
IPropertyMap params,
List inputs) |
static ReportInput |
getInstance(IName report,
List scope) |
static ReportInput |
getInstance(IName report,
List scope,
int maxResults,
IPropertyMap params,
List inputs) |
int |
getMaxResults()
Returns the maximum number of results the report should produce.
|
IPropertyMap |
getParameters()
Returns the parameters for the report itself.
|
IName |
getReportName()
Returns the name of report that should handle this input
|
List |
getScope()
Returns the 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.
|
public static ReportInput getInstance(IName report, List scope, int maxResults, IPropertyMap params, List inputs)
public static ReportInput getInstance(IName report, IPropertyMap params, List inputs)
public static ReportInput getInstance(IName report, List scope)
public IName getReportName()
IReportInput
getReportName
in interface IReportInput
public List getScope()
IReportInput
getScope
in interface IReportInput
RID
s with scopepublic IPropertyMap getParameters()
IReportInput
getParameters
in interface IReportInput
public List getCommandInputs()
IReportInput
IReportCommandInput
s.getCommandInputs
in interface IReportInput
IReportCommandInput
spublic int getMaxResults()
IReportInput
getMaxResults
in interface IReportInput
public IReportInput setScope(List scope)
IReportInput
setScope
in interface IReportInput
scope
- list of RID
s with scopepublic IReportInput setParameters(IPropertyMap params)
IReportInput
setParameters
in interface IReportInput
params
- new input parameterpublic IReportInput setCommandInputs(List commandInputs)
IReportInput
setCommandInputs
in interface IReportInput
commandInputs
- new input for commandspublic IReportInput setMaxResults(int max)
IReportInput
setMaxResults
in interface IReportInput
max
- results to producepublic IReportInputError verify(IResourceContext context) throws ResourceException
IReportInput
verify
in interface IReportInput
context
- the execution shall happen and the input needs to be valid in.null
on success and detailed error description otherwise.ResourceException
- if an error occurredAccess 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