public interface ISelector
IUICommands
and IUIMassCommands. When a command uses the AbstractProxyControl
to render its follow-up screen, it may want to make sure, that a certain layout is used.
Also, it wants to be called, when IResources have been selected
on that screen. The third functionality with this interface is the offering
of texts to set for input fields and explanations on that follow-up screen.
The typical setup to use commands that implement this interface is as follows:
The command is clicked by the user, and it its execute method it starts
a screenflow, that uses an AbstractProxyControl to render the output.
The proxy can then retrieve the layoutset-id of the ISelector, if it
is encoded in the received WdfEvent.
If the proxy uses the ILayoutControllerFactory to retrieve an
ILayoutController and through this the Controls to render,
it can use the retrieved layoutset-id to retrieve the ILayoutController
defined in this layoutset. With this layoutset, typically certain UICommands
should be defined, that do not carry out an action themselves, but use the
getCommand method of the AbstractProxyControl to retrieve
the command (usually an instance of ISelector) to actually do the work.| Modifier and Type | Method and Description |
|---|---|
boolean |
allowUserInput()
Deprecated.
As of NetWeaver 7.1
|
IRenderingEvent |
execute(IResourceList list,
IProxy currentproxy)
Deprecated.
As of NetWeaver 7.1
|
String |
getLabel(String key)
Deprecated.
As of NetWeaver 7.1
|
String |
getLayoutSetID()
Deprecated.
As of NetWeaver 7.1
|
IMandatoryField[] |
getUserInputSpecifiers()
Deprecated.
As of NetWeaver 7.1
|
boolean |
isValidTargetResource(IResource resource)
Deprecated.
As of NetWeaver 7.1
|
void |
setLayoutSetID(String layoutSetID)
Deprecated.
As of NetWeaver 7.1
|
String getLayoutSetID()
null.void setLayoutSetID(String layoutSetID)
layoutSetID - the layoutset for this class.IRenderingEvent execute(IResourceList list, IProxy currentproxy) throws WcmException
IResourceList found in
the imported list, using the information from the current screen found inside the proxy.list - the list of IResource that act as 'targets' for the
action to perform.currentproxy - - the proxy from the current screen. Needed, as the implementing class
only holds the IProxy from the request when it was instantiated itself.null.
If the implementing class had additional fields rendered via its getUserInputSpecifiers
methodWcmExceptionString getLabel(String key)
key - the key of the text to shownull, if there is no text available for this key.
Note: There is no possibility to add variables to these texts (e.g. add the resource name)boolean allowUserInput()
true, its getUserInputSpecifiers is called to provide data
what kind of fields have to be rendered.true, if the implementing class requires input fields displayed on the screenIMandatoryField[] getUserInputSpecifiers()
allowUserInput returns true. The FieldIdentifier within
the returned fields must be unique. Several of the implementing classes might be used to
render the content of an htmlb-Screen, which requires each field to have a unique ID.
Therefore, the implementing class should add a prefix to the IDs it uses for its different fields.
The IProxys method createUniqueComponentId can be used for this.boolean isValidTargetResource(IResource resource)
true in this method, if the parameter given is a not-locked
ICollection and the current user has write-access. It will return
false, if it is a simple IResource, locked, etc...resource - the resource which is to be used as target for the command
that implements this interfaceNullPointerException, if the resource parameter is null| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice