public interface IReport
IReportResult
s on
execution.
A IReport has a name, a set of possible input parameters and a set of
IReportCommand
s which can
be triggered on execution in order to find and manipulate resources.
Parameters and commands are gathered in a
IReportInput
instance which can be verified by the report and executed to produce a result.
Reports are instantiated by using the default constructor of an implementing class. Instantiation can happen at any time. There is no limit on the number of concurrent instances of a certain class, nor on the lifetime of such objects.
Copyright (c) SAP AG 2003-2004
Modifier and Type | Method and Description |
---|---|
IReportResult |
execute(IReportInput input,
IResourceContext context,
IResultReceiver receiver)
Execute a
IReportInput immediately in the given context. |
IReportResult |
execute(IRIDIterator iter,
IReportInput input,
IResourceContext context,
IResultReceiver receiver)
Execute a
IReport on a number of resources. |
List |
getApplicableCommands(IReportResult result)
Retrieves the list of
IReportCommand s which are applicable to
the given report result. |
IReportCommand |
getCommand(IName name)
Return a specific report command by name which belongs to this report.
|
List |
getCommands()
Return the list of all commands belonging to this report.
|
String |
getDescription(IName name,
Locale locale)
Get description of report with given locale for given parameter.
|
String |
getDescription(Locale locale)
Get description of report with given locale.
|
String |
getDisplayName(IName name,
Locale locale)
Get name for display in user interface with given locale for given parameter.
|
String |
getDisplayName(Locale locale)
Get name for display in user interface with given locale.
|
IReportInputMeta |
getMeta()
Get meta information about input to this report.
|
IName |
getName()
Get name of report
|
IScopeController |
getScopeController(IResourceContext context)
Returns the controller of scope information for this report, if available.
|
IReportInputError |
verify(IReportInput input,
IResourceContext context)
Verify that input is valid for this report.
|
IName getName()
String getDisplayName(Locale locale)
locale
- to get name forString getDescription(Locale locale)
locale
- to get description forString getDisplayName(IName name, Locale locale) throws MissingResourceException
name
- of propertylocale
- to get name forMissingResourceException
String getDescription(IName name, Locale locale) throws MissingResourceException
name
- to get description forlocale
- to get description forMissingResourceException
IReportCommand getCommand(IName name) throws ResourceException
name
- of commandnull
if not found.ResourceException
List getCommands() throws ResourceException
IReportCommand
sResourceException
IReportInputMeta getMeta() throws ResourceException
ResourceException
IReportInputError verify(IReportInput input, IResourceContext context) throws ResourceException
input
- to verifycontext
- the execution shall happen and the input needs to be valid in.null
on success and detailed error description otherwise.ResourceException
IReportResult execute(IReportInput input, IResourceContext context, IResultReceiver receiver) throws ResourceException, InterruptedException
IReportInput
immediately in the given context. The report will
add all found result items to the receiver and use the receiver to generate
the IReportResult
return value.input
- parameters for executioncontext
- to work inreceiver
- for managing intermediate resultsInterruptedException
- when report was terminated by outside agentResourceException
List getApplicableCommands(IReportResult result) throws ResourceException
IReportCommand
s which are applicable to
the given report result. The list maybe empty to indicate that no command
may be executed on the given result.result
- to get applicable commands forIReportCommand
sResourceException
- on internal failuresIReportResult execute(IRIDIterator iter, IReportInput input, IResourceContext context, IResultReceiver receiver) throws ResourceException, InterruptedException
IReport
on a number of resources. For each RID from
the iterator, apply the report as if the RID was found during scope search.iter
- iterator over RID
s where
command shall be appliedinput
- to apply on resourcescontext
- to work imreceiver
- for managing intermediate resultsInterruptedException
- when report was terminated by outside agentResourceException
IScopeController getScopeController(IResourceContext context)
IScopeController
may be null
.A report without scope controller must be prepared to accept all possible resource identifiers as input to report execution. If the report only operates on specific resources, it should provice a scope controller to narrow down the user selection to that set of resources.
context
- of user for scope informationIScopeController
or null
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