com.businessobjects.jsf.sdk.components
Class UIDestination

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

public class UIDestination
extends UIBaseScheduleControl

Enables the user to specify the output destination of a scheduled job.

Field Summary

static java.lang.String

TYPE

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

DEFAULT_FORM, SUBMIT

Constructor Summary

UIDestination()

Method Summary

boolean	checkItemType() For internal use only.
void	decode(FacesContext context) For internal use only.
java.lang.String	getCannotScheduleText() Gets the message to display when an item cannot be scheduled.
java.lang.String	getDestinationText() Gets the destination text label to be displayed beside the Destination options list.
EmailProps	getEmail() Gets the text label to be displayed when the user selects the "Specific email recipients" option from the Destination list.
java.lang.String	getFamily() For internal use only.
FileProps	getFile() Gets the text label to be displayed when the user selects the Specific file location option from the Destination list.
FTPProps	getFTP() Gets the text label to be displayed when the user selects the Specific FTP server option from the Destination list.
int	getSelectedDestination() Gets which of the options within the Destination list appears highlighted when the page is initially loaded.
java.lang.String	getVisibleDestinations() Gets the destinations that will appear in the Destination list.
void	restoreState(FacesContext context, java.lang.Object state) For internal use only.
java.lang.Object	saveState(FacesContext context) For internal use only.
void	setCannotScheduleText(java.lang.String cannotScheduleText) Sets the message to display when an item cannot be scheduled.
void	setDestinationText(java.lang.String destinationText) Sets the destination text label to be displayed beside the Destination options list.
void	setEmail(EmailProps email) Sets the text label to be displayed when the user selects the Specific email recipients option from the Destination list.
void	setFile(FileProps file) Sets the text label to be displayed when users select the Specific file location option from the Destination list.
void	setFTP(FTPProps FTP) Sets the text label to be displayed when the user selects the Specific FTP server option from the Destination list.
void	setItemSource(IItemSource itemSource) Sets the source of the item to be bound to the component.
void	setSelectedDestination(int selectedDestination) Sets which of the options within the Destination list appears highlighted when the page is initially loaded.
void	setVisibleDestinations(java.lang.String visibleDestinations) Sets the destinations that appear in the Destination list.
void	submit(IItemSource item) For internal use only.

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

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

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

Constructor Detail

UIDestination

public UIDestination()

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.

getCannotScheduleText

public java.lang.String getCannotScheduleText()

Gets the message to display when an item cannot be scheduled.

Returns:

A String that specifies the text to display when an item cannot be scheduled.

setCannotScheduleText

public void setCannotScheduleText(java.lang.String cannotScheduleText)

Sets the message to display when an item cannot be scheduled.

Parameters:

cannotScheduleText - A String that specifies the text to display when an item cannot be scheduled.

getDestinationText

public java.lang.String getDestinationText()

Gets the destination text label to be displayed beside the Destination options list.

Returns:

A String specifying the destination text label.

setDestinationText

public void setDestinationText(java.lang.String destinationText)

Sets the destination text label to be displayed beside the Destination options list.

Parameters:

destinationText - A String specifying the destination text label.

getEmail

public EmailProps getEmail()

Gets the text label to be displayed when the user selects the "Specific email recipients" option from the Destination list.

getEmail only sets the text label to be displayed. The actual default email addresses are either retrieved from the InfoObject in the EntepriseItem or set to default values.

Returns:

An EmailProps object indicating the text label to be displayed.

setEmail

public void setEmail(EmailProps email)

Sets the text label to be displayed when the user selects the Specific email recipients option from the Destination list.

setEmail only sets the text label to be displayed. The actual default email addresses are either retrieved from the InfoObject in the EntepriseItem or set to default values.

Parameters:

email - An EmailProps object indicating the text label to be displayed.

getFile

public FileProps getFile()

Gets the text label to be displayed when the user selects the Specific file location option from the Destination list.

getFile only sets the text label to be displayed. The actual default file locations are either retrieved from the InfoObject in the EntepriseItem or set to default values.

Returns:

A FileProps object indicating the text label to be displayed.

setFile

public void setFile(FileProps file)

Sets the text label to be displayed when users select the Specific file location option from the Destination list.

setFile only sets the text label to be displayed. The actual default file locations are either retrieved from the InfoObject in the EntepriseItem or set to default values.

Parameters:

file - A FileProps object indicating the text label to be displayed.

getFTP

public FTPProps getFTP()

Gets the text label to be displayed when the user selects the Specific FTP server option from the Destination list.

getFTP only sets the text label to be displayed. The actual default FTP properties are either retrieved from the InfoObject in the EntepriseItem or set to default values.

Returns:

A FTPProps object indicating the text label to be displayed.

setFTP

public void setFTP(FTPProps FTP)

Sets the text label to be displayed when the user selects the Specific FTP server option from the Destination list.

setFTP only sets the text label to be displayed. The actual default FTP properties are either retrieved from the InfoObject in the EntepriseItem or set to default values.

Parameters:

FTP - A FTPProps object indicating the text label to be displayed.

getSelectedDestination

public int getSelectedDestination()

Gets which of the options within the Destination list appears highlighted when the page is initially loaded.

Returns:

An int that indicates which option is initially highlighted in the Destination list.

See Also:

DestinationType

setSelectedDestination

public void setSelectedDestination(int selectedDestination)

Sets which of the options within the Destination list appears highlighted when the page is initially loaded.

Parameters:

selectedDestination - An int that indicates which option is initially highlighted in the Destination list. It is one of the values listed in com.businessobjects.jsf.sdk.properties.DestinationType

See Also:

DestinationType

getVisibleDestinations

public java.lang.String getVisibleDestinations()

Gets the destinations that will appear in the Destination list.

Returns:

A String that indicates the destinations that should appear in the Destination list.

setVisibleDestinations

public void setVisibleDestinations(java.lang.String visibleDestinations)

Sets the destinations that appear in the Destination list.

The setVisibleDestinations property is used to select the appropriate default and specific locations. By default, all types of destinations are displayed in the list.

Parameters:

visibleDestinations - A String that indicates the destinations that should appear in the Destination list.

decode

public void decode(FacesContext context)

For internal use only.

submit

public void submit(IItemSource item)
            throws SDKException

For internal use only.

Overrides:

submit in class UIBaseScheduleControl

Throws:

SDKException

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