public class ReportParameter
extends java.lang.Object
ReportDefinition
.
A ReportParameter
instance can be acquired as part
of the collection belonging to a ReportDefinition
using the ReportDefinition.getReportParameters
method.
Constructor and Description |
---|
ReportParameter(java.lang.String name,
boolean isRequired)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addValues(java.lang.String id,
java.lang.String value,
java.lang.String localKey)
Adds a new parameter value to this instance.
|
java.lang.String |
getAvailValue(java.lang.String valueId)
Returns the parameter value associated with the given identifier.
|
java.util.List<java.lang.String> |
getAvailValueIds()
Returns a collection of
String identifiers representing
key values to this parameter's value map. |
java.lang.String |
getAvailValueLocalizationKey(java.lang.String valueId)
Returns a localization key for the specified parameter value.
|
java.lang.String |
getName()
Returns the name value for this parameter.
|
boolean |
isRequired()
Indicates whether or not this particular parameter is required.
|
void |
setName(java.lang.String name)
Sets the name value for this parameter.
|
void |
setRequired(boolean isRequired)
Sets whether or not this parameter is required.
|
public ReportParameter(java.lang.String name, boolean isRequired)
name
- a String
value representing the name for this parameter.isRequired
- true
if this parameter is required; false
otherwise.public java.lang.String getName()
String
value.public void setName(java.lang.String name)
name
- a String
value. This entry cannot be null
.public boolean isRequired()
true
if this parameter is required; false
otherwise.public void setRequired(boolean isRequired)
isRequired
- true
if this parameter is required; false
otherwise.public java.util.List<java.lang.String> getAvailValueIds()
String
identifiers representing
key values to this parameter's value map.List
of String
instances. This entry can be empty.public java.lang.String getAvailValue(java.lang.String valueId)
valueId
- a String
value identifier.
This entry cannot be null
.String
value. This entry can be null
.public java.lang.String getAvailValueLocalizationKey(java.lang.String valueId)
valueId
- a String
value identifier.
This entry cannot be null
.String
value. This entry can be null
.public void addValues(java.lang.String id, java.lang.String value, java.lang.String localKey)
id
- a String
value identifier.
This entry cannot be null
.value
- a String
value. This entry can be null
.localKey
- a String
localization key. This entry can be null
.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.