com.businessobjects.jsf.sdk.components
Class UIReportParameters

java.lang.Object
  UICommand
      com.businessobjects.jsf.sdk.components.UIBaseControl
          com.businessobjects.jsf.sdk.components.UIBaseScheduleControl
              com.businessobjects.jsf.sdk.components.UIReportParameters

public class UIReportParameters
extends UIBaseScheduleControl

Enables a user to add and remove parameters that determine the information passed into a scheduled report when it is run.

Field Summary

static java.lang.String	CR_EMPTY
static java.lang.String	CR_MULT
static java.lang.String	CR_NULL
static java.lang.String	CR_RANGE
static java.lang.String	DEFAULT_PASSWORD
static java.lang.String	promptPrefix
static java.lang.String	TYPE

Fields inherited from class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

DEFAULT_FORM, SUBMIT

Constructor Summary

UIReportParameters()

Method Summary

boolean	checkItemType() For internal use only.
void	decode(FacesContext context) For internal use only.
ButtonProps	getAddButton() Gets the properties of the Add button.
java.lang.String	getFamily() For internal use only.
java.lang.String	getNotReportText() Gets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.
java.util.List	getParameters() For internal use only.
java.lang.String	getParametersText() Gets the text label to display beside the Parameters box.
java.lang.String	getProgramArgs() For internal use only.
ButtonProps	getRemoveButton() Gets the properties of the Remove button.
java.lang.String	getValueText() Gets the text label to display beside the Value box.
void	restoreState(FacesContext context, java.lang.Object state) For internal use only.
java.lang.Object	saveState(FacesContext context) For internal use only.
void	setAddButton(ButtonProps addButton) Sets the properties of the Add button.
void	setItemSource(IItemSource itemSource) Sets the source of the item to be bound to the component.
void	setNotReportText(java.lang.String notReportText) Sets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.
void	setParametersText(java.lang.String parametersText) Sets the text label to display beside the Parameters box.
void	setRemoveButton(ButtonProps removeButton) Sets the properties of the Remove button.
void	setValueText(java.lang.String valueText) Sets the text label to display beside the Value box.

Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

getEmptyText, getItemSource, getLabelAlignment, getLoggedOffText, getStyleClass, getSubmitButton, setAutoHandleEvents, setEmptyText, setLabelAlignment, setLoggedOffText, setStyleClass, setSubmitButton, submit

Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseControl

encodeBegin, getLocale, getTitle, isAutoHandleEvents, isEnabled, setEnabled, setLocale, setTitle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

CR_RANGE

public static final java.lang.String CR_RANGE

See Also:

Constant Field Values

CR_MULT

public static final java.lang.String CR_MULT

See Also:

Constant Field Values

CR_EMPTY

public static final java.lang.String CR_EMPTY

See Also:

Constant Field Values

CR_NULL

public static final java.lang.String CR_NULL

See Also:

Constant Field Values

promptPrefix

public static final java.lang.String promptPrefix

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final java.lang.String DEFAULT_PASSWORD

See Also:

Constant Field Values

Constructor Detail

UIReportParameters

public UIReportParameters()

Method Detail

setItemSource

public void setItemSource(IItemSource itemSource)

Sets the source of the item to be bound to the component.

The item source is a bean that implements either IEnterpriseItem or IEnterpriseItems.

Overrides:

setItemSource in class UIBaseControl

Parameters:

itemsource - An IItemSource object.

getAddButton

public ButtonProps getAddButton()

Gets the properties of the Add button.

Returns:

A ButtonProps object that contains the properties of the Add button.

setAddButton

public void setAddButton(ButtonProps addButton)

Sets the properties of the Add button.

Parameters:

addButton - a ButtonProps object that contains the properties of the Add button.

getRemoveButton

public ButtonProps getRemoveButton()

Gets the properties of the Remove button.

Returns:

A ButtonProps object that contains the properties of the Remove button.

setRemoveButton

public void setRemoveButton(ButtonProps removeButton)

Sets the properties of the Remove button.

Parameters:

removeButton - a ButtonProps object that contains the properties of the Remove button.

getNotReportText

public java.lang.String getNotReportText()

Gets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.

Returns:

A String containing text to display when the item is not a report.

setNotReportText

public void setNotReportText(java.lang.String notReportText)

Sets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.

Parameters:

notReportText - A String containing text to display when the item is not a report.

getValueText

public java.lang.String getValueText()

Gets the text label to display beside the Value box.

Returns:

A String that contains the text label to display beside the Value box.

setValueText

public void setValueText(java.lang.String valueText)

Sets the text label to display beside the Value box.

Parameters:

valueText - a String that contains the text label to display beside the Value box.

getParametersText

public java.lang.String getParametersText()

Gets the text label to display beside the Parameters box.

Returns:

A String containing the text label to display beside the Parameters box.

setParametersText

public void setParametersText(java.lang.String parametersText)

Sets the text label to display beside the Parameters box.

Parameters:

parametersText - a Stringcontaining the text label to display beside the Parameters box.

getParameters

public java.util.List getParameters()

For internal use only.

getProgramArgs

public java.lang.String getProgramArgs()

For internal use only.

decode

public void decode(FacesContext context)

For internal use only.

getFamily

public java.lang.String getFamily()

For internal use only.

checkItemType

public boolean checkItemType()

For internal use only.

Specified by:

checkItemType in class UIBaseScheduleControl

saveState

public java.lang.Object saveState(FacesContext context)

For internal use only.

Overrides:

saveState in class UIBaseScheduleControl

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

For internal use only.

Overrides:

restoreState in class UIBaseScheduleControl