|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Parameter
An action (encapsulated in the Action
interface)
is associated with several parameters
(encapsulated in the Parameter
interface), and each parameter is associated
with a property (encapsulated in the Property
interface).
This interface is used to provide additional information about how
a property is to be passed to/from the specific action it is associated with.
This interface has no dependence on a specific runtime environment such as WebSphere Portal,
as it is intended for reuse in any runtime environment where brokered communication may be
supported for components.
In the WebSphere Portal runtime environment,
Action
, Property
and associated Parameter
objects
may be programmatically constructed using PropertyBrokerService
, followed
by invoking the setters, or may be implicitly created by the runtime from information provided
through a WSDL file.
The implementation class for this interface must implement Serializable.
PropertyBrokerService
,
Action
,
Property
,
ActionController
,
ParameterController
Method Summary | |
---|---|
Action |
getAction()
Returns the associated Action object. |
ParameterBindingType |
getBindingType()
Returns where the parameter is bound. |
java.lang.String |
getDescription(java.util.Locale locale)
Returns a string containing a description of the parameter, suitable for display by tools or as help text. |
java.lang.String |
getName()
Returns the parameter name. |
Property |
getProperty()
Returns the associated Property object. |
java.util.Locale[] |
getSupportedLocales()
Returns the locales supported for the displayable text associated with the parameter, such as its title and description. |
java.lang.String |
getTitle(java.util.Locale locale)
Returns a string containing a short description of the parameter, suitable for display by tools or as help text. |
boolean |
isPresentIfNullValue()
Returns a boolean value indicating if a null value for the current parameter should still trigger associated actions (for example, due to wires having been created) i.e, the broker uses this to determine if a parameter which is present but null, should be treated as if it is absent. |
Method Detail |
---|
Property getProperty()
Property
object.
The return value will not be null.
Property
objectProperty
Action getAction()
Action
object.
The return value will not be null.
Action
objectAction
java.lang.String getName()
Property
name.
String
containing the name of the parameter.ParameterBindingType getBindingType()
ParameterBindingType
that specifies where the parameter is bound.
ParameterBindingType
also defines specific constant
values which are recognized in the WebSphere Portal runtime
environment.ParameterBindingType
java.lang.String getTitle(java.util.Locale locale)
locale
- the current locale
String
containing a short description of the parameter.java.lang.String getDescription(java.util.Locale locale)
locale
- the current locale
String
containing a description of the parameter.java.util.Locale[] getSupportedLocales()
boolean isPresentIfNullValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |