|
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.ParameterDefinition
public class ParameterDefinition
A ParameterDefinition is the definition of a parameter used either as an input parameter to the portlet's renderer, or as a parameter passed out of the portlet when an event is raised. As with Portlets, parameters have string elements which should be stored in a resource bundle so that they are translated. The following attributes can be retrieved from a resource bundle: displayName and description If using a resource bundle, be sure to set the key for lookup using setDisplayNameKey and setDescriptionKey respectively.
Constructor Summary | |
---|---|
ParameterDefinition()
Default constructor. |
Method Summary | |
---|---|
java.lang.String |
getDescription(java.util.Locale l)
|
java.lang.String |
getDescriptionKey()
|
java.lang.String |
getDisplayName(java.util.Locale l)
|
java.lang.String |
getDisplayNameKey()
|
java.lang.String |
getName()
|
java.util.ResourceBundle |
getResourceBundle(java.util.Locale l)
Gets the resource bundle for this Portlet in the given Locale. |
void |
setDescription(java.lang.String description)
Sets the parameter's description. |
void |
setDescriptionKey(java.lang.String descriptionKey)
Sets the parameter's description key. |
void |
setDisplayName(java.lang.String displayName)
Sets the parameter's display name. |
void |
setDisplayNameKey(java.lang.String displayNameKey)
Sets the parameter's display name key. |
void |
setName(java.lang.String name)
Sets the parameter's name. |
void |
setResource(java.lang.String resourceClassName)
Sets the name of the default resource bundle class for this parameter |
void |
validate(java.lang.String context,
ValidationError errors)
Validates the internal state of this ParameterDefinition
instance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ParameterDefinition()
Method Detail |
---|
public java.util.ResourceBundle getResourceBundle(java.util.Locale l)
l
- the Locale of the resource bundle being requested.
public void setResource(java.lang.String resourceClassName)
resourceClassName
- full name of class extending ResourceBundle
.public java.lang.String getName()
public void setName(java.lang.String name)
name
- the parameter's name.public java.lang.String getDisplayName(java.util.Locale l)
public void setDisplayName(java.lang.String displayName)
displayName
- a friendly name to be used in the Portal UI.public java.lang.String getDisplayNameKey()
public void setDisplayNameKey(java.lang.String displayNameKey)
displayNameKey
- the string value for the key used to look up
the parameter's display name in a resource bundle.public java.lang.String getDescription(java.util.Locale l)
public void setDescription(java.lang.String description)
description
- a short description of what this parameter is.public java.lang.String getDescriptionKey()
public void setDescriptionKey(java.lang.String descriptionKey)
descriptionKey
- the string value for the key used to look up
the parameter's description in a resource bundle.public void validate(java.lang.String context, ValidationError errors)
ParameterDefinition
instance. Errors found are reported using the supplied ValidationError
instance.
validate
in interface Validateable
context
- The context of the calling instance.errors
- The current list of errors.
|
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 |