com.sapportals.wcm.control.util

Interface IProxyProvider

All Known Subinterfaces:

IProxy

All Known Implementing Classes:

AbstractProxyControl

Deprecated. As of NetWeaver 7.1

public interface IProxyProvider

Field Summary

static String	DISPATCH_EVENT Deprecated.
static String	PREVIEW_ACTION Deprecated.

Method Summary

String	createDispatchableID(String handler, ArrayList values) Deprecated. As of NetWeaver 7.1
String	createNavigationTarget(ICollection p0) Deprecated. As of NetWeaver 7.1
IProperty	getProperty(IResource resource, IPropertyName name) Deprecated. As of NetWeaver 7.1
boolean	isPreviewEnabled() Deprecated. As of NetWeaver 7.1

Field Detail

DISPATCH_EVENT

static final String DISPATCH_EVENT

Deprecated.

See Also:

Constant Field Values

PREVIEW_ACTION

static final String PREVIEW_ACTION

Deprecated.

See Also:

Constant Field Values

Method Detail

createDispatchableID

String createDispatchableID(String handler,
                            ArrayList values)
                            throws WcmException

Deprecated. As of NetWeaver 7.1

creates an id that contains dispatch information. When an Event is raised with this id, the event will be send to the implementing class, using the information of the given parameters.

Parameters:

handler - The method that will be called when the event with this id is fired.

values - The objects of this list will be encoded using their toString() method and will be available in the handler method when the event is received

Returns:

String The dispatchableControlID, usable as ID for a Component.

Throws:

WcmException - Exception raised in failure situation

<{WcmException}>

createNavigationTarget

String createNavigationTarget(ICollection p0)
                              throws WcmException

Deprecated. As of NetWeaver 7.1

creates the needed information for a Link or Button to offer navigation to the given ICollection. Depending on the used screenflow-engine, the String might be different for the same collection. The String must contain the encoded URI of the collection to navigate to and should contain the start-Path to this collection, also encoded. The start-path is the furthest ancestor of the collection that should be visible. Note, that if navigating to a collection by links, the linked URI of the collection and not its standard URI should be used. So instead of ICollection.getRID() use ICollection.getAccessRID
As several Components in an iView may specify the same navigation target, it is necessary to ensure unique IDs for each of these components. One way to do this is to add some unique string at a later position in the parameter list, such as IDCounter.currentID().

Parameters:

p0 - the folder to navigate to

Returns:

the information needed to create a navigation link to the given folder

Throws:

WcmException - if an exception occurs in the repository framework or the WDF. The exception can contain a wrapped WdfException

getProperty

IProperty getProperty(IResource resource,
                      IPropertyName name)
                      throws WcmException

Deprecated. As of NetWeaver 7.1

returns the property defined for the given resource that is accessed through the given name. If the name is not in the internal map of properties for this resource (or if no map exists up to this point), a call to the RepositoryFramework is done. If this call fails to retrieve the property, this information will be logged (as a debug or a warning, depending if an exception was thrown by the RepositoryFramework), null will be returned. At the same time, this resource/name tuple will be marked as an unavailable property. If the same combination is requested at a later time, no call to the framework is done. If one of the parameters is null, a NullPointerException will be thrown

Parameters:

resource - Description of the Parameter

name - Description of the Parameter

Returns:

the valid property or null

Throws:

WcmException

isPreviewEnabled

boolean isPreviewEnabled()

Deprecated. As of NetWeaver 7.1

returns a flag, if the layout configured inside this instance supports the viewing of documents within the same browser-window or not.

Returns:

true if documents can be previewed within the same browser-window

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM