public interface IScopeController
Copyright (c) SAP AG 2004
Modifier and Type | Interface and Description |
---|---|
static interface |
IScopeController.IScopeEntry
A scope list entry.
|
Modifier and Type | Field and Description |
---|---|
static int |
SCOPE_MODE_ANY |
static int |
SCOPE_MODE_LIST |
static int |
SCOPE_MODE_NONE |
Modifier and Type | Method and Description |
---|---|
RID |
getBrowseLocation()
In case this controller has scope mode SCOPE_MODE_ANY, returns the best
starting location for browsing resources.
|
String |
getScopeLabel()
Get a label suitable for user interfaces, for the scope list.
|
List |
getScopeList()
In case this controller has scope mode SCOPE_MODE_LIST, returns the list
of available scopes as list of
IScopeController.IScopeEntry s. |
int |
getScopeMode()
Gives the scope mode of this controller.
|
boolean |
prefersSingleSelection()
Gives preference whether single or mutiple scopes should be selected as
input to a report.
|
static final int SCOPE_MODE_NONE
static final int SCOPE_MODE_ANY
static final int SCOPE_MODE_LIST
int getScopeMode()
boolean prefersSingleSelection()
RID
. For certain reports however, selecting a single
resource may be the prefered way of operation.List getScopeList() throws ResourceException
IScopeController.IScopeEntry
s. The list may contain
each RID
only once in a IScopeController.IScopeEntry
.
For all other scope modes, the list may be null
IScopeController.IScopeEntry
sResourceException
- on failure to retrieve entry listString getScopeLabel()
null
may be returned.null
if none available.RID getBrowseLocation() throws ResourceException
null
if
the controller does not care where browsing should start.null
ResourceException
- on failure to determine locationAccess 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