com.sap.tc.webdynpro.services.sal.url.api
Interface IWDWebResource

All Superinterfaces:

IWDService

All Known Subinterfaces:

IWDCachedWebResource

public interface IWDWebResource

extends IWDService

The interface IWDWebResource represents a web resource used by a Web Dynpro application. A web resource belongs to a specified deployable object and application, has a certain name and MIME type. Besides that, it is possible to associate name/value pairs to the web resource and to generate the String that points to the web resource. The generated String then contains the specified name/value pairs as String query parameters.

See Also:

WDWebResource

Method Summary

void	addParameter(java.lang.String name, java.lang.String value) Adds a parameter to this web resource.
void	addParameters(java.util.Map params) Adds the parameters supplied as input parameter to this web resource.
java.lang.String	getAbsoluteURL() Return is the absoluteURL (containing protocol specification) that points to the web resource specified by this IWebResource object.
WDDeployableObjectPart	getDeployableObjectPart() Return is the deployable object part to which the web resource belongs.
java.lang.String	getObjectName() Return is the name of the deployable object to which the web resource belongs.
java.lang.String	getResourceName() Return is the resource name of the web resource.
WDWebResourceType	getResourceType() Return is the resource type as defined by WDWebResourceType.
java.lang.String	getURL() Return is the URL that points to the web resource specified by this IWebResource object.
void	removeParameter(java.lang.String name) Removes an already added parameter.

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

getURL

public java.lang.String getURL()
                        throws WDURLException

Return is the URL that points to the web resource specified by this IWebResource object.

Returns:

the URL to the specified web resource

Throws:

WDStringException - if the String generation failed

getAbsoluteURL

public java.lang.String getAbsoluteURL()
                                throws WDURLException

Return is the absoluteURL (containing protocol specification) that points to the web resource specified by this IWebResource object.

Returns:

the URL to the specified web resource

Throws:

WDStringException - if the String generation failed

getObjectName

public java.lang.String getObjectName()

Return is the name of the deployable object to which the web resource belongs.

Returns:

the name of the deployable object to which the web resource belongs

getDeployableObjectPart

public WDDeployableObjectPart getDeployableObjectPart()

Return is the deployable object part to which the web resource belongs.

Returns:

the deployable object part where the web resource is used

getResourceType

public WDWebResourceType getResourceType()

Return is the resource type as defined by WDWebResourceType.

Returns:

the resource type of the web resource

getResourceName

public java.lang.String getResourceName()

Return is the resource name of the web resource.

Returns:

the resource name

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

Adds a parameter to this web resource. When calling the method getString(), the created String for this web resource contains the added parameters as query part of the String.

Parameters:

name - the name of the parameter

value - the value of the parameter

removeParameter

public void removeParameter(java.lang.String name)

Removes an already added parameter.

Parameters:

name - the name of the parameter

addParameters

public void addParameters(java.util.Map params)

Adds the parameters supplied as input parameter to this web resource. When calling the method getString(), the created String for this web resource contains the added parameters as query part of the String. If one of the keys contained in params already exists, the new parameter overwrites the old one.

Parameters:

params - the parameters added to this web resource