|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Field
com.crystaldecisions.sdk.occa.report.data.ParameterField
public class ParameterField
This object enables you to get and set values
for the parameter field. When possible, use the
IParameterField interface, to manipulate this object.
Parameters prompt the user of a report to enter information.
Think of a parameter as a question that the user needs to answer before the report is generated. The information users enter, or the way they respond, determines what appears in the report. For example, in a report used by sales people, there might be a parameter that asks the user to choose a region. The report would return the results for the specific region instead of returning the results for all of the regions.
By using parameter fields in formulas, selection formulas, and in the report itself, you can create a single report that you can modify whenever your needs change. Parameter fields can also be used in subreports. Parameter values are discrete or ranged. A discrete value represents a particular, single value, while a range value represents a value between a certain range. Additionally, parameters can have one value (discrete or ranged) or multiple values (discrete or ranged).
Parameters fields can be set to optional. If an optional parameter field is given a Values collection that contains a null object reference the user will not be prompted to enter a value, but if an optional parameter is given a Values collection that is empty, the user will be prompted.
The ParameterField object allows you to manipulate
a parameter in the report.
| Constructor Summary | |
|---|---|
ParameterField()
|
|
ParameterField(IParameterField src)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
enablePromptWithDescriptionOnly(boolean enable)
For internal use only |
boolean |
getAllowCustomCurrentValues()
Returns true if the user can enter
custom values for a parameter
when the report is refreshed and false otherwise. |
boolean |
getAllowMultiValue()
Returns true if the user
can select more than one value for a parameter when
the report is refreshed; returns false
if the user can only choose one value for the parameter. |
boolean |
getAllowNullValue()
Returns true if the value for the parameter may be NULL
and false otherwise. |
IField |
getBrowseField()
Returns the database field whose values are being used as default values for the parameter. |
Values |
getCurrentValues()
Returns the values that are currently being used for the parameter. |
ParameterDefaultValueDisplayType |
getDefaultValueDisplayType()
For internal use only |
Values |
getDefaultValues()
Returns the default values that may be used for the parameter. |
ParameterSortMethod |
getDefaultValueSortMethod()
Returns whether the default values are sorted by value or by the value's description. |
ParameterSortOrder |
getDefaultValueSortOrder()
Returns the manner in which the values or the values' descriptions are sorted. |
java.util.List |
getDirectPrerequisiteParameterNames()
For internal use only |
java.lang.String |
getEditMask()
Returns the edit mask for the parameter values. |
java.lang.String |
getId()
For internal use only |
java.lang.String |
getImageKey()
For internal use only. |
Values |
getInitialValues()
For internal use only |
ParameterInitialValuesFunction |
getInitialValuesFunction()
For internal use only |
boolean |
getIsAllowHierarchyValues()
For internal use only |
boolean |
getIsAutoCreated()
For internal use only |
boolean |
getIsDataFoundationParameter()
For internal use only |
boolean |
getIsDataParameter()
For internal use only |
boolean |
getIsEditableOnPanel()
Gets whether the parameter is editable on viewer parameter panel. |
boolean |
getIsKeepLastValueSelected()
For internal use only |
boolean |
getIsLinkedParameter()
For internal use only |
boolean |
getIsOptionalPrompt()
Gets whether the parameter is optional. |
boolean |
getIsPromptToUser()
For internal use only |
boolean |
getIsShownOnPanel()
Gets whether the parameter is shown on the viewer parameter panel. |
FieldKind |
getKind()
Returns what kind of field this is. |
ILOVInfo |
getLOVInfo()
For internal use only |
IParameterFieldDiscreteValue |
getMaximumValue()
Returns the maximum value the parameter can have, providing that a minimum value is also specified. |
IParameterFieldDiscreteValue |
getMinimumValue()
Returns the minimum value the parameter can have, providing that a maximum value is also specified. |
ParameterFieldType |
getParameterType()
Returns how the parameter is being used as a type value. |
java.lang.String |
getReportName()
Returns the name of the report to which the parameter belongs. |
java.lang.String |
getShortName(java.util.Locale locale)
Returns the short name of the field. |
java.util.List |
getTranslatableChildren()
For internal use only |
IClone |
getTranslatableObject()
For internal use only |
java.lang.String |
getTranslatableString(TranslatableStringId id)
For internal use only |
java.util.List |
getTranslatableStringIds()
For internal use only |
java.lang.String |
getTranslatableStringLabelResourceID(TranslatableStringId id)
For internal use only |
int |
getUsage()
For internal use only |
ParameterValueRangeKind |
getValueRangeKind()
Returns whether the parameter is discrete, ranged, or both. |
Values |
getValues()
Returns the current values for the parameter, or the default values if no current values are defined. |
boolean |
hasContent(java.lang.Object srcParameterField)
|
boolean |
isPromptWithDescriptionOnlyEnabled()
For internal use only |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setAllowCustomCurrentValues(boolean allowCustomCurrentValues)
Sets if the user can enter custom values for a parameter when the report is refreshed. |
void |
setAllowHierarchyValues(boolean allowHierarchyValues)
For internal use only |
void |
setAllowMultiValue(boolean allowMultiValue)
Sets if the user can select more than one value for a parameter when the report is refreshed. |
void |
setAllowNullValue(boolean allowNullValue)
Set to true if the value for the parameter may be NULL
and false otherwise. |
void |
setBrowseField(IField browseField)
Sets the database field whose values are being used as default values for the parameter. |
void |
setCurrentValues(Values currentValues)
Sets the values that are currently being used for the parameter. |
void |
setDataFoundationParameter(boolean dataFoundationParameter)
For internal use only |
void |
setDefaultValueDisplayType(ParameterDefaultValueDisplayType type)
For internal use only |
void |
setDefaultValues(Values defaultValues)
Sets the default values that may be used for the parameter. |
void |
setDefaultValueSortMethod(ParameterSortMethod defaultValueSortMethod)
Sets whether the default values are sorted by value or by the value's description. |
void |
setDefaultValueSortOrder(ParameterSortOrder defaultValueSortOrder)
Sets the manner in which the values or the values' descriptions are sorted. |
void |
setDirectPrerequisiteParameterNames(java.util.List newPrerequisiteParameterNames)
For internal use only |
void |
setEditMask(java.lang.String editMask)
Sets the edit mask for the parameter values. |
void |
setId(java.lang.String id)
For internal use only |
void |
setInitialValues(Values initialValues)
For internal use only |
void |
setInitialValuesFunction(ParameterInitialValuesFunction initialValuesFunction)
For internal use only |
void |
setIsAutoCreated(boolean isAutoCreated)
For internal use only |
void |
setIsEditableOnPanel(boolean isEditableOnPanel)
Sets whether the parameter is editable on viewer parameter panel. |
void |
setIsOptionalPrompt(boolean isOptionalPrompt)
Sets whether the parameter is optional. |
void |
setIsShownOnPanel(boolean isShownOnPanel)
Sets whether the parameter is shown on the viewer parameter panel. |
void |
setKeepLastValueSelected(boolean keepLastValueSelected)
For internal use only |
void |
setLOVInfo(ILOVInfo lovInfo)
For internal use only |
void |
setMaximumValue(IParameterFieldDiscreteValue maximumValue)
Sets the maximum value the parameter can have, providing that a minimum value is also specified. |
void |
setMinimumValue(IParameterFieldDiscreteValue minimumValue)
Sets the minimum value the parameter can have, providing that a maximum value is also specified. |
void |
setParameterType(ParameterFieldType parameterType)
Sets how the parameter is being used as a type value. |
void |
setPromptToUser(boolean promptToUser)
For internal use only. |
void |
setReportName(java.lang.String reportName)
Sets the name of the report to which the parameter belongs. |
void |
setTranslatableString(TranslatableStringId id,
java.lang.String newText)
For internal use only |
void |
setType(FieldValueType valueType)
For internal use only |
void |
setUsage(int usage)
For internal use only |
void |
setValueRangeKind(ParameterValueRangeKind valueRangeKind)
Sets whether the parameter is discrete, ranged, or both. |
| Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
|---|
endElement, getAttributes, getDescription, getDisplayName, getFormulaForm, getHeadingText, getIsPrintTime, getIsRecurring, getLength, getLongName, getName, getType, getValueTypeForFormatOption, setAttributes, setDescription, setHeadingText, setLength, setName, startElement |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField |
|---|
getDescription, getDisplayName, getFormulaForm, getHeadingText, getIsRecurring, getLength, getLongName, getName, getType, getValueTypeForFormatOption, setDescription, setHeadingText, setLength, setName |
| Constructor Detail |
|---|
public ParameterField(IParameterField src)
public ParameterField()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class Field
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class Field
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only.
createMember in class Fieldpublic boolean getAllowCustomCurrentValues()
IParameterFieldReturns true if the user can enter
custom values for a parameter
when the report is refreshed and false otherwise.
If this property is True, users can enter any value
for the parameter. If it is False, they must choose from one
of the default values.
getAllowCustomCurrentValues in interface IParameterFieldtrue if the user can enter
custom values for a parameter
when the report is refreshed, and false otherwise.public boolean getAllowMultiValue()
IParameterFieldReturns true if the user
can select more than one value for a parameter when
the report is refreshed; returns false
if the user can only choose one value for the parameter.
getAllowMultiValue in interface IParameterFieldtrue if the user
can select more than one value for a parameter when
the report is refreshed, and false otherwise.public boolean getAllowNullValue()
IParameterField
Returns true if the value for the parameter may be NULL
and false otherwise.
This is used only for stored SQL procedures.
getAllowNullValue in interface IParameterFieldtrue if the value for the parameter may be NULL,
and false otherwise.public IField getBrowseField()
IParameterFieldReturns the database field whose values are being used as default values for the parameter. This is used for UI-display purposes.
getBrowseField in interface IParameterFieldIField interface.public Values getCurrentValues()
IParameterFieldReturns the values that are currently being used
for the parameter. Use the
ParameterFieldController.setCurrentValues(String, String, Object[])
method to set the current values.
getCurrentValues in interface IParameterFieldValues object.public ParameterDefaultValueDisplayType getDefaultValueDisplayType()
getDefaultValueDisplayType in interface IParameterFieldParameterDefaultValueDisplayType object.public ParameterInitialValuesFunction getInitialValuesFunction()
IParameterField
getInitialValuesFunction in interface IParameterFieldpublic Values getDefaultValues()
IParameterFieldReturns the default values that may be used for the parameter.
getDefaultValues in interface IParameterFieldValues object.public ParameterSortMethod getDefaultValueSortMethod()
IParameterFieldReturns whether the default values are sorted by value or by the value's description. This is used for UI-display purposes.
getDefaultValueSortMethod in interface IParameterFieldParameterSortMethod object.public ParameterSortOrder getDefaultValueSortOrder()
IParameterFieldReturns the manner in which the values or the values' descriptions are sorted.
getDefaultValueSortOrder in interface IParameterFieldParameterSortOrder object.public java.util.List getDirectPrerequisiteParameterNames()
IParameterField
getDirectPrerequisiteParameterNames in interface IParameterFieldpublic java.lang.String getEditMask()
IParameterFieldReturns the edit mask for the parameter values. This is used for UI-display purposes. The edit mask can be any of a set of masking characters used to restrict the values you can enter as parameter values. The edit mask also limits the values you can enter as default prompting values.
Note: The value of the edit mask is not checked if you use the SDK to change parameter values. You must check to ensure that any values the user enters respect the edit mask. If a user enters an invalid value according to the edit mask, it will not be possible to view or schedule the report.
The edit mask follows the following guidelines:
Note: Some of the edit mask characters require that you enter a character in their place (when entering a parameter value), while others allow you to leave a space, if needed. For example, if the edit mask is 000099, you can enter a parameter value with four digits, five digits, or six digits, since the '9' edit mask character does not require the entry of a character. However, since '0' does require such an entry, you could not enter a parameter value with less than four digits.
getEditMask in interface IParameterFieldString.public FieldKind getKind()
IFieldReturns what kind of field this is. Do not confuse this property with Type. Kind identifies what sort of report field this is, while Type identifies what the field is composed of. For example, a bitmap, string, chart, number, date, and so on.
getKind in interface IFieldString that specifies what kind of field this is.public IParameterFieldDiscreteValue getMaximumValue()
IParameterFieldReturns the maximum value the parameter can have, providing that a minimum value is also specified.
If the parameter is discrete, the discrete values must be between the minimum and maximum values. If the parameter has a range limit, both the maximum and minimum values are defined. The BeginValue and/or EndValue of each ranged value must be between the minimum and maximum values.
If the parameter is a number, this property represents the largest allowable number the parameter may have. If it is a string, this is the maximum length the string may be. If it is a Date/Time value, this is the earliest date and time the parameter may be. This property does not apply to Boolean values.
getMaximumValue in interface IParameterFieldIParameterFieldDiscreteValue object.public IParameterFieldDiscreteValue getMinimumValue()
IParameterFieldReturns the minimum value the parameter can have, providing that a maximum value is also specified.
If the parameter is discrete, the discrete values must be between the minimum and maximum values. If the parameter has a range limit, both the maximum and minimum values are defined. The BeginValue and/or EndValue of each ranged value must be between the minimum and maximum values.
If the parameter is a number, this property represents the smallest allowable number the parameter may have. If it is a string, this is the minimum length the string may be. If it is a Date/Time value, this is the earliest date and time the parameter may be. This property does not apply to Boolean values.
getMinimumValue in interface IParameterFieldIParameterFieldDiscreteValue object.public ParameterFieldType getParameterType()
IParameterFieldReturns how the parameter is being used as a type value.
getParameterType in interface IParameterFieldParameterFieldType object.public java.lang.String getReportName()
IParameterFieldReturns the name of the report to which the parameter belongs. This string is empty if the parameter belongs in a main report; if the parameter is contained in a subreport, this contains the name of the subreport.
getReportName in interface IParameterFieldString.public java.lang.String getShortName(java.util.Locale locale)
IFieldReturns the short name of the field.
getShortName in interface IFieldgetShortName in class Fieldlocale - The locale that will be used to localize the field name.
String containing the short name of the field.public int getUsage()
public ParameterValueRangeKind getValueRangeKind()
IParameterFieldReturns whether the parameter is discrete, ranged, or both.
getValueRangeKind in interface IParameterFieldParameterValueRangeKind object.public Values getValues()
IParameterFieldReturns the current values for the parameter, or the default
values if no current values are defined.
This is equivalent to the IParameterField.getCurrentValues() method
unless it is empty, in which case it is equivalent
to the IParameterField.getDefaultValues() method.
getValues in interface IParameterFieldValues object.public boolean hasContent(java.lang.Object srcParameterField)
hasContent in class Fieldpublic boolean getIsAllowHierarchyValues()
IParameterField
getIsAllowHierarchyValues in interface IParameterFieldpublic boolean getIsDataFoundationParameter()
IParameterField
getIsDataFoundationParameter in interface IParameterFieldpublic boolean getIsKeepLastValueSelected()
IParameterField
getIsKeepLastValueSelected in interface IParameterFieldpublic boolean getIsPromptToUser()
IParameterField
getIsPromptToUser in interface IParameterField
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only.
readElement in class Field
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
save in class Fieldjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
save in class Fieldjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
saveContents in class Fieldjava.io.IOExceptionpublic void setAllowCustomCurrentValues(boolean allowCustomCurrentValues)
IParameterFieldSets if the user can enter custom values for a parameter when the report is refreshed. If this property is True, users can enter any value for the parameter. If it is False, they must choose from one of the default values.
setAllowCustomCurrentValues in interface IParameterFieldallowCustomCurrentValues - true if the user can enter
custom values for a parameter
when the report is refreshed, and false otherwise.public void setAllowHierarchyValues(boolean allowHierarchyValues)
IParameterField
setAllowHierarchyValues in interface IParameterFieldpublic void setAllowMultiValue(boolean allowMultiValue)
IParameterFieldSets if the user can select more than one value for a parameter when the report is refreshed.
setAllowMultiValue in interface IParameterFieldallowMultiValue - true if the user
can select more than one value for a parameter when
the report is refreshed, and false otherwise.public void setAllowNullValue(boolean allowNullValue)
IParameterField
Set to true if the value for the parameter may be NULL
and false otherwise.
This is used only for stored SQL procedures.
setAllowNullValue in interface IParameterFieldallowNullValue - true if the value for the parameter may be NULL,
and false otherwise.public void setBrowseField(IField browseField)
IParameterFieldSets the database field whose values are being used as default values for the parameter. This is used for UI-display purposes.
setBrowseField in interface IParameterFieldbrowseField - The database field whose values are being used as
default values for the parameter as an IField interface.public void setCurrentValues(Values currentValues)
IParameterFieldSets the values that are currently being used
for the parameter. Use the
ParameterFieldController.setCurrentValues(String, String, Object[])
method to set the current values.
setCurrentValues in interface IParameterFieldcurrentValues - The current values as a Values object.public void setDefaultValueDisplayType(ParameterDefaultValueDisplayType type)
setDefaultValueDisplayType in interface IParameterFieldtype - the default value display type as a ParameterDefaultValueDisplayType objectpublic void setInitialValuesFunction(ParameterInitialValuesFunction initialValuesFunction)
IParameterField
setInitialValuesFunction in interface IParameterFieldpublic void setDefaultValues(Values defaultValues)
IParameterFieldSets the default values that may be used for the parameter.
setDefaultValues in interface IParameterFielddefaultValues - The default values that may be used for the parameter
as a Values object.public void setDefaultValueSortMethod(ParameterSortMethod defaultValueSortMethod)
IParameterFieldSets whether the default values are sorted by value or by the value's description. This is used for UI-display purposes.
setDefaultValueSortMethod in interface IParameterFielddefaultValueSortMethod - Whether the default values are sorted by value
or by the value's description as a
ParameterSortMethod object.public void setDefaultValueSortOrder(ParameterSortOrder defaultValueSortOrder)
IParameterFieldSets the manner in which the values or the values' descriptions are sorted.
setDefaultValueSortOrder in interface IParameterFielddefaultValueSortOrder - The manner in which the values or the values'
descriptions are sorted as a ParameterSortOrder object.public void setDirectPrerequisiteParameterNames(java.util.List newPrerequisiteParameterNames)
IParameterField
setDirectPrerequisiteParameterNames in interface IParameterFieldpublic void setEditMask(java.lang.String editMask)
IParameterFieldSets the edit mask for the parameter values. This is used for UI-display purposes. The edit mask can be any of a set of masking characters used to restrict the values you can enter as parameter values. The edit mask also limits the values you can enter as default prompting values.
Note: The value of the edit mask is not checked if you use the SDK to change parameter values. You must check to ensure that any values the user enters respect the edit mask. If a user enters an invalid value according to the edit mask, it will not be possible to view or schedule the report.
The edit mask follows the following guidelines:
Note: Some of the edit mask characters require that you enter a character in their place (when entering a parameter value), while others allow you to leave a space, if needed. For example, if the Edit Mask is 000099, you can enter a parameter value with four digits, five digits, or six digits, since the '9' edit mask character does not require the entry of a character. However, since '0' does require such an entry, you could not enter a parameter value with less than four digits.
setEditMask in interface IParameterFieldeditMask - The edit mask as a String.public void setKeepLastValueSelected(boolean keepLastValueSelected)
IParameterField
setKeepLastValueSelected in interface IParameterFieldpublic void setMaximumValue(IParameterFieldDiscreteValue maximumValue)
IParameterFieldSets the maximum value the parameter can have, providing that a minimum value is also specified.
If the parameter is discrete, the discrete values must be between the minimum and maximum values. If the parameter has a range limit, both the maximum and minimum values are defined. The BeginValue and/or EndValue of each ranged value must be between the minimum and maximum values.
If the parameter is a number, this property represents the largest allowable number the parameter may have. If it is a string, this is the maximum length the string may be. If it is a Date/Time value, this is the earliest date and time the parameter may be. This property does not apply to Boolean values.
setMaximumValue in interface IParameterFieldmaximumValue - The IParameterFieldDiscreteValue object.public void setMinimumValue(IParameterFieldDiscreteValue minimumValue)
IParameterFieldSets the minimum value the parameter can have, providing that a maximum value is also specified.
If the parameter is discrete, the discrete values must be between the minimum and maximum values. If the parameter has a range limit, both the maximum and minimum values are defined. The BeginValue and/or EndValue of each ranged value must be between the minimum and maximum values.
If the parameter is a number, this property represents the smallest allowable number the parameter may have. If it is a string, this is the minimum length the string may be. If it is a Date/Time value, this is the earliest date and time the parameter may be. This property does not apply to Boolean values.
setMinimumValue in interface IParameterFieldminimumValue - The IParameterFieldDiscreteValue object.public void setParameterType(ParameterFieldType parameterType)
IParameterFieldSets how the parameter is being used as a type value.
setParameterType in interface IParameterFieldparameterType - The parameter field type as a
ParameterFieldType object.public void setPromptToUser(boolean promptToUser)
IParameterField
setPromptToUser in interface IParameterFieldpublic void setReportName(java.lang.String reportName)
IParameterFieldSets the name of the report to which the parameter belongs. This string is empty if the parameter belongs in a main report; if the parameter is contained in a subreport, this contains the name of the subreport.
setReportName in interface IParameterFieldreportName - The name of the report as a String.
Set this string as empty if the parameter belongs in a main report;
if the parameter is contained in a subreport, set
this to contain the name of the subreport.public void setUsage(int usage)
public void setValueRangeKind(ParameterValueRangeKind valueRangeKind)
IParameterFieldSets whether the parameter is discrete, ranged, or both.
setValueRangeKind in interface IParameterFieldvalueRangeKind - Whether the parameter is discrete, ranged, or both
as a ParameterValueRangeKind object.public boolean getIsOptionalPrompt()
IParameterFieldGets whether the parameter is optional.
Optional parameter prompts do not require a parameter value to be provided. No visual cue in the parameter dialog indicates that a parameter is optional; however, the report designer may add custom text to the prompt text indicating it is optional.
If an optional parameter prompt is given a Values collection whose “IsNoValue” property is set to true, the user will not be prompted to enter a value.
getIsOptionalPrompt in interface IParameterFieldtrue if the parameter is optional.getIsNoValue(),
setIsNoValue()public void setIsOptionalPrompt(boolean isOptionalPrompt)
IParameterFieldSets whether the parameter is optional.
Optional parameter prompts do not require a parameter value to be provided. No visual cue in the parameter dialog indicates that a parameter is optional; however, the report designer may add custom text to the prompt text indicating it is optional.
If an optional parameter prompt is given a Values collection whose “IsNoValue” property is set to true, the user will not be prompted to enter a value.
setIsOptionalPrompt in interface IParameterFieldisOptionalPrompt - booleangetIsNoValue(),
setIsNoValue()public boolean isPromptWithDescriptionOnlyEnabled()
IParameterField
isPromptWithDescriptionOnlyEnabled in interface IParameterFieldpublic void enablePromptWithDescriptionOnly(boolean enable)
IParameterField
enablePromptWithDescriptionOnly in interface IParameterFieldpublic java.lang.String getId()
public void setId(java.lang.String id)
public boolean getIsAutoCreated()
public void setIsAutoCreated(boolean isAutoCreated)
public void setType(FieldValueType valueType)
setType in interface IFieldsetType in class FieldvalueType - A FieldValueType object that specifies what type of field
this is.public boolean getIsShownOnPanel()
IParameterFieldGets whether the parameter is shown on the viewer parameter panel.
getIsShownOnPanel in interface IParameterFieldtrue if the parameter is shown on panel.public void setIsShownOnPanel(boolean isShownOnPanel)
IParameterFieldSets whether the parameter is shown on the viewer parameter panel.
setIsShownOnPanel in interface IParameterFieldisShownOnPanel - booleanpublic boolean getIsEditableOnPanel()
IParameterFieldGets whether the parameter is editable on viewer parameter panel.
getIsEditableOnPanel in interface IParameterFieldtrue if the parameter is editable.public void setIsEditableOnPanel(boolean isEditableOnPanel)
IParameterFieldSets whether the parameter is editable on viewer parameter panel.
setIsEditableOnPanel in interface IParameterFieldisEditableOnPanel - booleanpublic Values getInitialValues()
IParameterField
getInitialValues in interface IParameterFieldpublic void setInitialValues(Values initialValues)
IParameterField
setInitialValues in interface IParameterFieldpublic ILOVInfo getLOVInfo()
IParameterField
getLOVInfo in interface IParameterFieldpublic void setLOVInfo(ILOVInfo lovInfo)
setLOVInfo in interface IParameterFieldpublic boolean getIsLinkedParameter()
IParameterField
getIsLinkedParameter in interface IParameterFieldpublic boolean getIsDataParameter()
IParameterField
getIsDataParameter in interface IParameterFieldpublic void setDataFoundationParameter(boolean dataFoundationParameter)
public java.util.List getTranslatableStringIds()
public java.lang.String getTranslatableString(TranslatableStringId id)
public void setTranslatableString(TranslatableStringId id,
java.lang.String newText)
public java.lang.String getTranslatableStringLabelResourceID(TranslatableStringId id)
public IClone getTranslatableObject()
public java.util.List getTranslatableChildren()
public java.lang.String getImageKey()
For internal use only.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||