oracle.portal.provider.v2.webservice
Class WebServiceRenderer.URLParam

java.lang.Object
  |
  +--oracle.portal.provider.v2.webservice.WebServiceRenderer.ParameterBinding
        |
        +--oracle.portal.provider.v2.webservice.WebServiceRenderer.DefaultableParameterBinding
              |
              +--oracle.portal.provider.v2.webservice.WebServiceRenderer.PromptedBinding
                    |
                    +--oracle.portal.provider.v2.webservice.WebServiceRenderer.URLParam

Enclosing class:

WebServiceRenderer

public static class WebServiceRenderer.URLParam

extends WebServiceRenderer.PromptedBinding

Class representing a parameter bound to the value of a parmeter in the query string of the request to the provider. The parameter may have been posted by a form generated by the portlet itself, an external parameter-passing portlet, or may be one of the parameters sent by Portal. Note that HTML form fields are automatically generated for each URLParam in the default XSL stylesheet.

Constructor Summary

WebServiceRenderer.URLParam()

WebServiceRenderer.URLParam(java.lang.String name, java.lang.String deflt, boolean isMandatory, java.lang.String prompt)
Constructs a URLParam using the specified properties.

Method Summary

java.lang.String

getActualValue(WebServiceRenderRequest wrr) Evaluates this binding in the context of the given WebServiceRenderRequest, without taking into account any defaults.

Methods inherited from class oracle.portal.provider.v2.webservice.WebServiceRenderer.PromptedBinding

getPrompt, setPrompt

Methods inherited from class oracle.portal.provider.v2.webservice.WebServiceRenderer.DefaultableParameterBinding

getValue, isMandatory, setDefault, setMandatory, setMandatory

Methods inherited from class oracle.portal.provider.v2.webservice.WebServiceRenderer.ParameterBinding

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

WebServiceRenderer.URLParam

public WebServiceRenderer.URLParam()

WebServiceRenderer.URLParam

public WebServiceRenderer.URLParam(java.lang.String name,
                                   java.lang.String deflt,
                                   boolean isMandatory,
                                   java.lang.String prompt)

Constructs a URLParam using the specified properties.

Parameters:

name - the binding name

deflt - default value to use when actual binding value is null or the empty string

isMandatory - is this a mandatory parameter?

prompt - default prompt to use for item in generated HTML form.

Method Detail

getActualValue

public java.lang.String getActualValue(WebServiceRenderRequest wrr)

Evaluates this binding in the context of the given WebServiceRenderRequest, without taking into account any defaults. In this case, the result of passing the binding name to WebServiceRenderRequest.getURLParameter(java.lang.String) is returned.

Specified by:

getActualValue in class WebServiceRenderer.PromptedBinding

Returns:

the value of this binding for the given WebServiceRenderRequest or null if one does not yet exist.

See Also:

WebServiceRenderRequest.getURLParameter(java.lang.String)