com.sap.portal.httpconnectivity.urlfetcherservice

Interface IURLFetcherProperties

public interface IURLFetcherProperties

DOCUMENT ME!

Method Summary

String	getAnchor() Get the anchor.
String	getBasicUrl() Get the url without parameters
IConstants.Method	getMethod() DOCUMENT ME!
String	getOutputEncoding() Get output encoding .
IURLParameters	getParameters() Get all the URL parametes (IURLParameters consist of the list of IURLParameter , which holds the parameter details )
String	getPassword() Get password
String	getSystem() Get the System name.
String	getUrl() Get the url
String	getUserName() Get the user name value retreived from the system.
boolean	isClientSideFetching() The function returns the value that indicates if to redirect request(client side fetching mode) or not (DEFAULT - server side fetching ).
void	save(IDataHandler dataHandler) Method save(IDataHandler dataHandler)
void	save(IDataHandler dataHandler, boolean hideAttributesInPropEditor) Deprecated. Not in used
void	save(IDataHandler dataHandler, String prefix)
void	setAnchor(String anchor) Set the anchor.
void	setIsClientSideFetching(boolean isToRedirect) Define if the request should be redirected or not (Client/Server side fetching).
void	setMethod(IConstants.Method string) Set method type.
void	setOutputEncoding(String encoding) Set output encoding .
void	setParameters(IURLParameters params) Set the URL parameters(IURLParameters should be filled before ).
void	setPassword(String string) Set password
void	setRequest(IPortalComponentRequest request)
void	setSystem(String systemAlias) Set System name.
void	setSystem(String systemAlias, IUserContext user) Set System name.
void	setUrl(String url) Set the url entered url is parsed.
void	setUserName(String string) Set the user name value in order automatically to connect to the backend source.

Method Detail

getBasicUrl

String getBasicUrl()

Get the url without parameters

Returns:

URL

getUrl

String getUrl()

Get the url

Returns:

URL

setUrl

void setUrl(String url)

Set the url entered url is parsed. Basic URL retrieved and if URL contain parameters they automatically parsed and filled in URLParameters object.

isClientSideFetching

boolean isClientSideFetching()

The function returns the value that indicates if to redirect request(client side fetching mode) or not (DEFAULT - server side fetching ).

Returns:

fetch mode

getMethod

IConstants.Method getMethod()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getParameters

IURLParameters getParameters()

Get all the URL parametes (IURLParameters consist of the list of IURLParameter , which holds the parameter details )

Returns:

parameters.

setIsClientSideFetching

void setIsClientSideFetching(boolean isToRedirect)

Define if the request should be redirected or not (Client/Server side fetching).

Parameters:

isToRedirect -

setMethod

void setMethod(IConstants.Method string)

Set method type.

Parameters:

string -

setParameters

void setParameters(IURLParameters params)

Set the URL parameters(IURLParameters should be filled before ).

Parameters:

params -

getUserName

String getUserName()

Get the user name value retreived from the system.

Returns:

user name

setUserName

void setUserName(String string)

Set the user name value in order automatically to connect to the backend source.

Parameters:

string -

getPassword

String getPassword()

Get password

Returns:

string

setPassword

void setPassword(String string)

Set password

Parameters:

string -

getOutputEncoding

String getOutputEncoding()

Get output encoding . All the data received from the URLFetcherService converted to supplied encoding. If no encoding was supplied - data returned as is.

Returns:

charset value.

setOutputEncoding

void setOutputEncoding(String encoding)

Set output encoding . All the data received from the URLFetcherService converted to supplied encoding. If no encoding was supplied - data returned as is.

getSystem

String getSystem()

Get the System name.

Returns:

System name value.

setSystem

void setSystem(String systemAlias)

Set System name.

Parameters:

systemAlias - System name value.

setSystem

void setSystem(String systemAlias,
               IUserContext user)

Set System name. After calling this function the user and password retreived from the User Mapping properties of supplied user.

Parameters:

systemAlias - System name value.

user -

setAnchor

void setAnchor(String anchor)

Set the anchor.

getAnchor

String getAnchor()

Get the anchor.

setRequest

void setRequest(IPortalComponentRequest request)

save

void save(IDataHandler dataHandler,
          boolean hideAttributesInPropEditor)

Deprecated. Not in used

Parameters:

dataHandler -

hideAttributesInPropEditor -

See Also:

save(com.sap.portal.httpconnectivity.urlfetcherservice.IDataHandler)

save

void save(IDataHandler dataHandler)

Method save(IDataHandler dataHandler)

Parameters:

dataHandler -

save

void save(IDataHandler dataHandler,
          String prefix)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-ADMIN	[sap.com] tc/ep/admin/api/extd	api	EP-PIN