com.sapportals.wcm.control.util

Class ResourceURLCreator

java.lang.Object
  com.sapportals.wcm.control.util.ResourceURLCreator

Deprecated. As of NetWeaver 7.1

public class ResourceURLCreator
extends Object

creates the encoded target for the given resource. This target can be used as reference for an htmlb-Link. Depending on the parameters and the resource itself, the IObjectTypeHandlerService is used to calculate the valid target

Nested Class Summary

static class

ResourceURLCreator.TargetType Deprecated. As of NetWeaver 7.1

Field Summary

static String	BROKEN_LINK_PAGE Deprecated.
static ResourceURLCreator.TargetType	DETAILS Deprecated.
static String	START_URI Deprecated.
static ResourceURLCreator.TargetType	VIEW Deprecated.

Constructor Summary

ResourceURLCreator(IResource res)
Deprecated. As of NetWeaver 7.1

ResourceURLCreator(IResource res, ICollection start)
Deprecated. As of NetWeaver 7.1

ResourceURLCreator(IResource res, com.sapportals.wcm.util.uri.RID start)
Deprecated. As of NetWeaver 7.1

Method Summary

String

getURL(ResourceURLCreator.TargetType type, boolean useOTH) Deprecated. As of NetWeaver 7.1

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

START_URI

public static final String START_URI

Deprecated.

See Also:

Constant Field Values

BROKEN_LINK_PAGE

public static final String BROKEN_LINK_PAGE

Deprecated.

See Also:

Constant Field Values

VIEW

public static final ResourceURLCreator.TargetType VIEW

Deprecated.

DETAILS

public static final ResourceURLCreator.TargetType DETAILS

Deprecated.

Constructor Detail

ResourceURLCreator

public ResourceURLCreator(IResource res,
                          ICollection start)
                   throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Parameters:

res - the resource to create a target link for. Must not be null

start - defines how far back in the hierarchy the user is allowed to browse. If start is null or it is not an ancestor of the given resource, a debug information will be added to the log and the resource itself will be used as the maximum hierarchy level for navigation. If the resource is not an ICollection, the resource's parent collection will be used instead.

Throws:

com.sapportals.wcm.WcmException - if the framework can not retrieve the RID from one of the resources

ResourceURLCreator

public ResourceURLCreator(IResource res)
                   throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Parameters:

res - the resource to create a target link for. Must not be null. The resource itself will be the maximum hierarchy the user can browse to. If the resource is not an ICollection, it's parent will be used as maximum hierarchy.

Throws:

com.sapportals.wcm.WcmException - if the framework can not retrieve the RID from one of the resources

ResourceURLCreator

public ResourceURLCreator(IResource res,
                          com.sapportals.wcm.util.uri.RID start)
                   throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Parameters:

res - the resource to create a target link for. Must not be null

start - defines how far back in the hierarchy the user is allowed to browse. If start is null or it is not an ancestor of the given resource, a debug information will be added to the log and the resource itself will be used as the maximum hierarchy level for navigation. If the resource is not an ICollection, the resource's parent collection will be used instead.

Throws:

com.sapportals.wcm.WcmException - if the framework can not retrieve the RID from the resource

Method Detail

getURL

public String getURL(ResourceURLCreator.TargetType type,
                     boolean useOTH)
              throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

creates an encoded target-reference for the given resource and the given target. If the flag for the OTH is disabled, the target calculation will be done without the usage of the OTH. This will produce unusable targets for special resources but will increase performance. This might be an option for some special iViews and scenarios

Parameters:

type - defines what kind of target is needed for the resource, e.g. viewing or details, must not be null.

useOTH - enables or disables OTH usage

Returns:

Throws:

com.sapportals.wcm.WcmException - when an exception occurs in the repository framework

Access Rights

This class can be accessed from:

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