com.sap.portal.httpconnectivity.urlfetcherservice.params

Interface IURLParameter


public interface IURLParameter

The interface defines methods for holding URL Parameter data such as - param name, value, param method (each parameter can be passed with different method) and etc.


Method Summary
 IConstants.Method getParamMethod()
          Method returns parameter method
 String getParamName()
          Method returns parameter name
 String getParamNiceName()
          Method returns parameter nice/friendly name (for personalization)
 IConstants.ParameterType getParamType()
           
 String getParamValue()
          Method returns parameter value
 boolean isPersonalized()
          Method checks if parameter can be personolized,
 boolean isReadOnly()
          Method checks if parameter will be displayed as read only in the personalizasion area.
 void setIsPersonalized(boolean isPersonalized)
          Method defines if parameter can be personolized,
 void setIsReadOnly(boolean isReadOnly)
          Method defines if parameter will be displayed as read only in the personalizasion area.
 void setParamMethod(IConstants.Method methodType)
          Method sets parameter method type
 void setParamName(String paramName)
          Method sets parameter name
 void setParamNiceName(String paramNiceName)
          Method sets parameter nice/friendly name (for personalization).If nice name was supplied - parameter automaticaly enabled for personalization.
 void setParamType(IConstants.ParameterType type)
          Method sets parameter type.
 void setParamValue(String paramName)
          Method sets parameter value
 

Method Detail

setParamName

void setParamName(String paramName)
Method sets parameter name

Parameters:
paramName - parameter name value

setParamValue

void setParamValue(String paramName)
Method sets parameter value

Parameters:
paramName - parameter value

setParamMethod

void setParamMethod(IConstants.Method methodType)
Method sets parameter method type

Parameters:
methodType -

getParamName

String getParamName()
Method returns parameter name

Returns:
parameter name

getParamValue

String getParamValue()
Method returns parameter value

Returns:
parameter value

getParamMethod

IConstants.Method getParamMethod()
Method returns parameter method

Returns:
method

setIsPersonalized

void setIsPersonalized(boolean isPersonalized)
Method defines if parameter can be personolized,


isPersonalized

boolean isPersonalized()
Method checks if parameter can be personolized,

Returns:
description

setIsReadOnly

void setIsReadOnly(boolean isReadOnly)
Method defines if parameter will be displayed as read only in the personalizasion area. Obviously, if a parameter is read only, then it is also personalized. Therefore, if this parameter is set to be read only, then it will also be set to be personalized. And if the parameter is set to be not personalized, then it will also be set to be not read only.

Parameters:
isReadOnly -

isReadOnly

boolean isReadOnly()
Method checks if parameter will be displayed as read only in the personalizasion area. Obviously, if a parameter is read only, then it is also personalized (the method isPersonalized will return true). And if a parameter is not personalized, then this method will return false.

Returns:
- whether the parameter is read only, or can be personalized.

getParamNiceName

String getParamNiceName()
Method returns parameter nice/friendly name (for personalization)

Returns:
description

setParamNiceName

void setParamNiceName(String paramNiceName)
Method sets parameter nice/friendly name (for personalization).If nice name was supplied - parameter automaticaly enabled for personalization.

Parameters:
paramNiceName -

getParamType

IConstants.ParameterType getParamType()

setParamType

void setParamType(IConstants.ParameterType type)
Method sets parameter type. Type may be a string, mapped user or mapped password.

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


Copyright 2011 SAP AG Complete Copyright Notice