com.businessobjects.jsf.sdk.components
Class UIReportDatabaseLogon

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

public class UIReportDatabaseLogon
extends UIBaseScheduleControl

Enables a user to specify report logon credentials for accessing a report database when a scheduled report is run.

Field Summary

static java.lang.String	DATABASENAME
static java.lang.String	DEFAULT_PASSWORD
static java.lang.String	PASSWORD
static java.lang.String	SERVERNAME
static java.lang.String	TYPE
static java.lang.String	USERNAME

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

DEFAULT_FORM, SUBMIT

Constructor Summary

UIReportDatabaseLogon()

Method Summary

boolean	checkItemType() For internal use only.
void	decode(FacesContext context) For internal use only.
java.lang.String	getDatabaseNameText() Gets the text to display beside the database name input field label.
java.lang.String	getFamily() For internal use only.
java.lang.String	getNotReportText() Gets the message to display when the Report is not of a valid type.
java.lang.String	getPasswordText() Gets the text to display beside the password input field label.
java.lang.String	getServerNameText() Gets the text to display beside the server name input field label.
java.lang.String	getUserNameText() Gets the text to display beside the user name input field label.
void	restoreState(FacesContext context, java.lang.Object state) For internal use only.
java.lang.Object	saveState(FacesContext context) For internal use only.
void	setDatabaseNameText(java.lang.String databaseNameText) Sets the text to display beside the database name input field label.
void	setItemSource(IItemSource itemSource) Sets the source of the item bound to the component.
void	setNotReportText(java.lang.String notReportText) Sets the message to display when the Report is not of a valid type.
void	setPasswordText(java.lang.String passwordText) Sets the text to display beside the password input field label.
void	setServerNameText(java.lang.String serverNameText) Sets the text to display beside the server name input field label.
void	setUserNameText(java.lang.String userNameText) Sets the text to display beside the user name input field label.

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

SERVERNAME

public static final java.lang.String SERVERNAME

See Also:

Constant Field Values

DATABASENAME

public static final java.lang.String DATABASENAME

See Also:

Constant Field Values

USERNAME

public static final java.lang.String USERNAME

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final java.lang.String DEFAULT_PASSWORD

See Also:

Constant Field Values

Constructor Detail

UIReportDatabaseLogon

public UIReportDatabaseLogon()

Method Detail

setItemSource

public void setItemSource(IItemSource itemSource)

Sets the source of the item bound to the component.

The itemsource is a bean that implements either IEnterpriseItem or IEnterpriseItems.

Overrides:

setItemSource in class UIBaseControl

Parameters:

itemsource - An IItemSource bean.

getNotReportText

public java.lang.String getNotReportText()

Gets the message to display when the Report is not of a valid type.

Returns:

A String containing the error message.

setNotReportText

public void setNotReportText(java.lang.String notReportText)

Sets the message to display when the Report is not of a valid type.

Parameters:

notReportText - A String containing the error message.

getServerNameText

public java.lang.String getServerNameText()

Gets the text to display beside the server name input field label.

Returns:

A String containing the text to display beside the server name input field label.

setServerNameText

public void setServerNameText(java.lang.String serverNameText)

Sets the text to display beside the server name input field label.

Parameters:

serverNameText - A String containing the text to display beside the server name input field label.

getDatabaseNameText

public java.lang.String getDatabaseNameText()

Gets the text to display beside the database name input field label.

Returns:

A String containing the text to display beside the database name input field label.

setDatabaseNameText

public void setDatabaseNameText(java.lang.String databaseNameText)

Sets the text to display beside the database name input field label.

Parameters:

databaseNameText - A String containing the text to display beside the database name input field label.

getUserNameText

public java.lang.String getUserNameText()

Gets the text to display beside the user name input field label.

The minimum information required to use the ReportDatabaseLogon control is a user name input field and a password input field. The getUserNameText method is used to customize the text on the user name input field label.

Returns:

A String containing the text to display beside the user name input field label.

setUserNameText

public void setUserNameText(java.lang.String userNameText)

Sets the text to display beside the user name input field label.

The minimum information required to use the ReportDatabaseLogon control is a user name input field and a password input field. The setUserNameText method is used to customize the text on the user name input field label.

Parameters:

userNameText - A String containing the text to display beside the user name input field label.

getPasswordText

public java.lang.String getPasswordText()

Gets the text to display beside the password input field label.

The minimum information required to use the ReportDatabaseLogon control is a user name input field and a password input field. The getPasswordText method is used to customize the text on the password input field label.

Returns:

A String containing the text to display beside the password input field label.

setPasswordText

public void setPasswordText(java.lang.String passwordText)

Sets the text to display beside the password input field label.

The minimum information required to use the ReportDatabaseLogon control is a user name input field and a password input field. The setPasswordText method is used to customize the text on the password input field label.

Parameters:

passwordText - A String containing the text to display beside the password input field label.

decode

public void decode(FacesContext context)

For internal use only.

checkItemType

public boolean checkItemType()

For internal use only.

Specified by:

checkItemType in class UIBaseScheduleControl

getFamily

public java.lang.String getFamily()

For internal use only.

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