com.crystaldecisions.sdk.plugin.desktop.common
Interface IReportParameter


public interface IReportParameter

The IReportParameter interface represents a single parameter for a particular report. It allows you to view detailed information about the parameter, and to also add new values to the parameter values list.


Nested Class Summary
static interface IReportParameter.ParameterPickListSortMethod
          Deprecated.  
static interface IReportParameter.ReportVariableValueType
          The type of the parameter value.
 
Method Summary
 IReportParameterValues getCurrentValues()
           Returns a collection of the values currently chosen for the parameter.
 IReportParameterValues getDefaultValues()
           Returns a collection of the default values that may be chosen to be the current value for the parameter.
 byte[] getDynamicCascadePromptData()
           Returns a collection that contains dynamic cascading prompt data.
 java.lang.String getDynamicCascadePromptGroupID()
           Returns a dynamic cascade prompt group ID.
 java.lang.String getEditMask()
           Returns the mask that defines the format of the value to be input for the prompt.
 int getGroupNumber()
           Returns the number of the group that the parameter belongs to.
 java.lang.Object getMaximumValue()
           Returns the maximum value a parameter may have.
 java.lang.Object getMinimumValue()
           Returns the minimum value a parameter may have.
 ParameterField getParameterField()
           Returns a ParameterField object that is equivalent to the current IReportParameter object.
 java.lang.String getParameterName()
           Returns the name of the parameter.
 java.lang.String getPrompt()
           Returns the text that prompts the user to enter a value for the parameter.
 java.lang.String getReportName()
           Returns the name of the report to which the parameter belongs.
 java.lang.String getValueDisplayString(java.util.Locale locale)
           Returns a localized String representation of the parameter's value.
 int getValueType()
           Returns the type of the parameter.
 boolean isCurrentValueSet()
           Shows whether the current value is set or not.
 boolean isDefaultValueSet()
           Shows whether there are any default values.
 boolean isDiscreteValueSupported()
           Indicates whether or not the parameter supports discrete values.
 boolean isDynamicCascadePromptAvailable()
           Returns a boolean that indicates if this object has dynamic cascading prompts.
 boolean isEditingDisallowed()
           Returns the flag that indicates whether or not a value that is not a default value can be chosen.
 boolean isExclusiveGroupEnabled()
           Indicates whether the group the parameter belongs to is mutually exclusive.
 boolean isInUse()
           Returns a boolean that indicates whether this parameter is in use.
 boolean isMultipleValuesEnabled()
           Returns whether the user has the choice of having multiple current values for the parameter.
 boolean isNullValueEnabled()
           Returns whether the user can choose null current values.
 boolean isPartOfGroup()
           Returns whether or not the parameter is part of a group.
 boolean isPromptOnDemandViewing()
           Indicates whether or not parameter values should be prompted for when viewing on-demand reports.
 boolean isRangeLimitEnabled()
           Returns whether a limit is enabled within which the current value, and default value, will be confined.
 boolean isRangeValueSupported()
           Indicates whether or not the parameter supports range values.
 boolean isShowDescriptionOnlyEnabled()
           Returns whether BusinessObjects Enterprise will display only the current value's description, and not its value.
 boolean isSortBasedOnDescEnabled()
           Returns whether or not the current and default values are sorted based on description.
 void setPromptOnDemandViewing(boolean bPromptOnDemand)
           Sets whether or not parameter values should be prompted for when viewing on-demand reports.
 

Method Detail

getCurrentValues

public IReportParameterValues getCurrentValues()

Returns a collection of the values currently chosen for the parameter.

Returns:
An IReportParameterValues object containing the values currently chosen for the parameter.

getDefaultValues

public IReportParameterValues getDefaultValues()

Returns a collection of the default values that may be chosen to be the current value for the parameter.

Returns:
An IReportParameterValues object containing the values currently chosen for the parameter.

isEditingDisallowed

public boolean isEditingDisallowed()

Returns the flag that indicates whether or not a value that is not a default value can be chosen.

Returns:
A boolean specifying whether or not a value can be chosen that is not one of the default values.

getEditMask

public java.lang.String getEditMask()

Returns the mask that defines the format of the value to be input for the prompt.

Returns:
A String containing the mask that defines the format of the value to be input for the prompt.

isExclusiveGroupEnabled

public boolean isExclusiveGroupEnabled()

Indicates whether the group the parameter belongs to is mutually exclusive.

Returns:
A boolean specifying whether the group the parameter belongs to is mutually exclusive.

isMultipleValuesEnabled

public boolean isMultipleValuesEnabled()

Returns whether the user has the choice of having multiple current values for the parameter.

Returns:
A boolean specifying whether the user has the choice of having multiple current values for the parameter.

isNullValueEnabled

public boolean isNullValueEnabled()

Returns whether the user can choose null current values.

Returns:
A boolean specifying whether the user can choose null current values.

isRangeLimitEnabled

public boolean isRangeLimitEnabled()

Returns whether a limit is enabled within which the current value, and default value, will be confined.

Returns:
true if a limit is enabled, false otherwise.

isShowDescriptionOnlyEnabled

public boolean isShowDescriptionOnlyEnabled()

Returns whether BusinessObjects Enterprise will display only the current value's description, and not its value.

Returns:
true if only the description will be displayed, false otherwise.

isSortBasedOnDescEnabled

public boolean isSortBasedOnDescEnabled()

Returns whether or not the current and default values are sorted based on description.

Returns:
true if the values will be sorted by description, false otherwise.

getGroupNumber

public int getGroupNumber()

Returns the number of the group that the parameter belongs to.

Returns:
An int specifying the number of the group that the parameter belongs to.

isCurrentValueSet

public boolean isCurrentValueSet()

Shows whether the current value is set or not.

Returns:
true if the value is set, false otherwise.

isDefaultValueSet

public boolean isDefaultValueSet()

Shows whether there are any default values.

Returns:
true if the value is set, false otherwise.

getMaximumValue

public java.lang.Object getMaximumValue()

Returns the maximum value a parameter may have. In the case of strings this is the length. This value is only enforced if range checking is enabled.

Returns:
An Object containing the maximum value that a parameter may have.

getMinimumValue

public java.lang.Object getMinimumValue()

Returns the minimum value a parameter may have. In the case of strings this is the length. This value is only enforced if range checking is enabled.

Returns:
An Object containing the minimum value that a parameter may have.

getParameterField

public ParameterField getParameterField()

Returns a ParameterField object that is equivalent to the current IReportParameter object. This allows manipulation of report parameters for use with the Java Crystal Report Web Viewer.

Returns:
The equivalent ParameterField object.

getParameterName

public java.lang.String getParameterName()

Returns the name of the parameter.

Returns:
A String specifying the name of the parameter.

isPartOfGroup

public boolean isPartOfGroup()

Returns whether or not the parameter is part of a group.

Returns:
true if the parameter is part of a group, false otherwise.

isPromptOnDemandViewing

public boolean isPromptOnDemandViewing()

Indicates whether or not parameter values should be prompted for when viewing on-demand reports.

Returns:
true if parameter values should be prompted for when viewing on-demand.

setPromptOnDemandViewing

public void setPromptOnDemandViewing(boolean bPromptOnDemand)

Sets whether or not parameter values should be prompted for when viewing on-demand reports.

Parameters:
bPromptOnDemand - true if parameter values should be prompted for when viewing on-demand.

getPrompt

public java.lang.String getPrompt()

Returns the text that prompts the user to enter a value for the parameter.

Returns:
A String containing the text that prompts the user to enter a value for the parameter.

getReportName

public java.lang.String getReportName()

Returns the name of the report to which the parameter belongs.

Returns:
A String containing the name of the report to which the parameter belongs.

isDiscreteValueSupported

public boolean isDiscreteValueSupported()

Indicates whether or not the parameter supports discrete values.

Returns:
true if the parameter supports discrete values, false otherwise.

isRangeValueSupported

public boolean isRangeValueSupported()

Indicates whether or not the parameter supports range values.

Returns:
true if the parameter supports range values, false otherwise.

getValueDisplayString

public java.lang.String getValueDisplayString(java.util.Locale locale)

Returns a localized String representation of the parameter's value.

Parameters:
locale - A Locale object specifying the locale for which the String should be displayed.
Returns:
A localized String representation of the parameter's value.

getValueType

public int getValueType()

Returns the type of the parameter. This value is a ReportVariableValueType constant.

Returns:
An int specifying the type of the parameter. This value is of type ReportVariableValueType.
See Also:
IReportParameter.ReportVariableValueType

isInUse

public boolean isInUse()

Returns a boolean that indicates whether this parameter is in use.

Returns:
true if the parameter is in use, and false otherwise.

isDynamicCascadePromptAvailable

public boolean isDynamicCascadePromptAvailable()

Returns a boolean that indicates if this object has dynamic cascading prompts.

Returns:
true if this object has dynamic cascading prompts, and false otherwise.

getDynamicCascadePromptData

public byte[] getDynamicCascadePromptData()
                                   throws SDKException

Returns a collection that contains dynamic cascading prompt data.

Returns:
A byte[] array that contains dynamic cascading prompt data.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getDynamicCascadePromptGroupID

public java.lang.String getDynamicCascadePromptGroupID()
                                                throws SDKException

Returns a dynamic cascade prompt group ID.

Returns:
A String that identifies the dynamic cascade prompt group ID.
Throws:
SDKException - This is thrown if the process is unsuccessful.