|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.webservice.WebServiceRenderer.ParameterBinding oracle.portal.provider.v2.webservice.WebServiceRenderer.DefaultableParameterBinding
public abstract static class WebServiceRenderer.DefaultableParameterBinding
Superclass for ParameterBinding
s that can have a default
value.
Constructor Summary | |
---|---|
WebServiceRenderer.DefaultableParameterBinding()
|
|
WebServiceRenderer.DefaultableParameterBinding(java.lang.String name,
java.lang.String deflt,
boolean isMandatory)
Constructs a DefaultableParameterBinding using the
specified properties. |
Method Summary | |
---|---|
abstract java.lang.String |
getActualValue(WebServiceRenderRequest wrr)
Evaluates this binding in the context of the given WebServiceRenderRequest , without taking into
account any defaults. |
java.lang.String |
getValue(WebServiceRenderRequest wrr)
Evaluates this binding in the context of the given WebServiceRenderRequest , taking into account any
defaults. |
boolean |
isMandatory()
Determines whether this ParameterBinding is
mandatory. |
void |
setDefault(java.lang.String deflt)
Sets the default value for this binding, returned by getValue(oracle.portal.provider.v2.webservice.WebServiceRenderRequest) when the binding value is null or the empty string. |
void |
setMandatory(boolean isMandatory)
Controls whether this binding is mandatory. |
void |
setMandatory(java.lang.String isMandatory)
Controls whether this binding is mandatory. |
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 |
---|
public WebServiceRenderer.DefaultableParameterBinding()
public WebServiceRenderer.DefaultableParameterBinding(java.lang.String name, java.lang.String deflt, boolean isMandatory)
DefaultableParameterBinding
using the
specified properties.
name
- the binding namedeflt
- default value to use when actual binding value is null
or the empty stringisMandatory
- is this a mandatory parameter?Method Detail |
---|
public final void setDefault(java.lang.String deflt)
getValue(oracle.portal.provider.v2.webservice.WebServiceRenderRequest)
when the binding value is null or the empty string.
deflt
- the default value for this bindingpublic final java.lang.String getValue(WebServiceRenderRequest wrr) throws PortletException
WebServiceRenderRequest
, taking into account any
defaults.
getValue
in class WebServiceRenderer.ParameterBinding
WebServiceRenderRequest
.
PortletException
- if an exception occurs while evaluating
the binding.public abstract java.lang.String getActualValue(WebServiceRenderRequest wrr) throws PortletException
WebServiceRenderRequest
, without taking into
account any defaults. Called by getValue(oracle.portal.provider.v2.webservice.WebServiceRenderRequest)
to determine
whether the default should be returned. Subclasses should implement.
WebServiceRenderRequest
or null
if one
does not yet exist.
PortletException
- if an exception occurs while evaluating
the binding.public final void setMandatory(boolean isMandatory)
WebServiceRenderer
has any mandatory parameter
bindings, its web service will not be invoked until all its bindings
have a value which is non-null and not equal to the empty string. By
default, all parameters are non-mandatory.
isMandatory
- true
if this binding is mandatory,
false
otherwise.public final void setMandatory(java.lang.String isMandatory)
WebServiceRenderer
has any mandatory parameter
bindings, its web service will not be invoked until all its bindings
have a value which is non-null and not equal to the empty string. By
default, all parameters are non-mandatory.
isMandatory
- String representation of boolean value. Should be
"true"
if this binding is mandatory,
"false"
otherwise.public boolean isMandatory()
ParameterBinding
is
mandatory. If a WebServiceRenderer
has any mandatory
parameter bindings, its web service will not be invoked until all
its bindings have a value which is non-null and not equal to the
empty string. By default, all parameters are non-mandatory.
isMandatory
in class WebServiceRenderer.ParameterBinding
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |