A B C D E F G H I J L M N O P Q R S T U V W

A

addViewerListener(JSFFacesListener) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

ADOBE_ACROBAT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

AdobeAcrobat - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

An Adobe Acrobat format.

AlertClickedEvent - class com.businessobjects.jsf.sdk.event.AlertClickedEvent.

Occurs when any alert item is clicked in the ItemsGrid component.

AlertClickedEvent(UIComponent, ItemEventArgs) - Constructor for class com.businessobjects.jsf.sdk.event.AlertClickedEvent

AlertProps - class com.businessobjects.jsf.sdk.properties.AlertProps.

Contains properties for determining how alert messages are displayed in the ItemsGrid component.

AlertProps() - Constructor for class com.businessobjects.jsf.sdk.properties.AlertProps

Ascending - Static variable in class com.businessobjects.jsf.sdk.properties.SortDirection

The items are sorted in an alphanumeric ascending order (0-9, A-Z).

AuthenticationProps - class com.businessobjects.jsf.sdk.properties.AuthenticationProps.

Contains authentication input information in the Logon component.

AuthenticationProps() - Constructor for class com.businessobjects.jsf.sdk.properties.AuthenticationProps

autoLogon(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Automatically logs the user (associated with this instance of the Identity bean) on to BusinessObjects Enterprise.

B

Both - Static variable in class com.businessobjects.jsf.sdk.properties.GridLines

Use horizontal and vertical grid lines.

broadcast(FacesEvent) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

Button - Static variable in class com.businessobjects.jsf.sdk.properties.PageNumberButtonType

Normal button type.

Button - Static variable in class com.businessobjects.jsf.sdk.properties.ButtonType

A normal button type.

ButtonProps - class com.businessobjects.jsf.sdk.properties.ButtonProps.

Contains properties to specify how to display a button or a set of buttons.

ButtonProps() - Constructor for class com.businessobjects.jsf.sdk.properties.ButtonProps

ButtonProps(String) - Constructor for class com.businessobjects.jsf.sdk.properties.ButtonProps

ButtonType - class com.businessobjects.jsf.sdk.properties.ButtonType.

Contains fields that specify the button type for the ButtonProps object.

ButtonType() - Constructor for class com.businessobjects.jsf.sdk.properties.ButtonType

C

Calendar - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run according to a BusinessObjects Enterprise business calendar.

CALENDAR - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Category - Static variable in class com.businessobjects.jsf.sdk.properties.Hierarchy

The category hierarchy is active.

Center - Static variable in class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Align the element to the center.

ChangePasswordListener - class com.businessobjects.jsf.sdk.event.ChangePasswordListener.

The default listener used to handle events fired by the ChangePassword component.

ChangePasswordListener() - Constructor for class com.businessobjects.jsf.sdk.event.ChangePasswordListener

CHARACTER_SEPARATED - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

CharacterSeparated - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A character separated format.

CharacterSeparatedProps - class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps.

Contains properties for specifying character separator labels.

CharacterSeparatedProps() - Constructor for class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps

CharacterSeparatedProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

For internal use only.

checkItemType() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

For internal use only.

clearPersistedState() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Clears the existing InfoObjects collection and query settings such as itemID and parentID.

com.businessobjects.jsf.sdk.components - package com.businessobjects.jsf.sdk.components

This package contains the user interface component classes.

com.businessobjects.jsf.sdk.event - package com.businessobjects.jsf.sdk.event

This package contains the event classes.

com.businessobjects.jsf.sdk.model - package com.businessobjects.jsf.sdk.model

This package contains the interfaces used to create the EnterpriseItem, EnterpriseItems, and Identity beans.

com.businessobjects.jsf.sdk.properties - package com.businessobjects.jsf.sdk.properties

This package contains property classes and additional support classes used by the UI components.

com.crystaldecisions.report.web.jsf - package com.crystaldecisions.report.web.jsf

This package contains the UIReportPageViewer class which provides the JSF version of the DHTML report page viewer.

CommandEvent - class com.businessobjects.jsf.sdk.event.CommandEvent.

Base class used by SortClickedEvent.

CommandEvent(UIComponent, String, List) - Constructor for class com.businessobjects.jsf.sdk.event.CommandEvent

commit() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Commit any changes made to the InfoObjects collection.

COMPONENT_FAMILY - Static variable in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

COMPONENT_TYPE - Static variable in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

copyTo() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Copies the elements of EnterpriseItems to an array, starting at a particular array index.

CorporateCategory - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

Use the BusinessObjects Enterprise main corporate category as the parent item.

CR_EMPTY - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

CR_MULT - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

CR_NULL - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

CR_RANGE - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

CRYSTAL_REPORT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportPrintType

CRYSTAL_REPORT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

CrystalReport - Static variable in class com.businessobjects.jsf.sdk.properties.ReportPrintType

Print as a Crystal Report.

CrystalReport - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A Crystal Report format.

Custom - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultRootType

A parent item specified by the RootItemID property.

Custom - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

A parent item specified by the ParentItemID property.

D

Daily - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run once every day.

DAILY - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

DATABASENAME - Static variable in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIPath

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UILogon

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

For internal use only.

decode(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

For internal use only.

decode(FacesContext) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

DEFAULT_EMAIL - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

DEFAULT_ENTERPRISE - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

DEFAULT_FILE - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

DEFAULT_FORM - Static variable in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

DEFAULT_FTP - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

DEFAULT_ICON_SIZE - Static variable in class com.businessobjects.jsf.sdk.components.UIItemsGrid

For internal use only.

DEFAULT_INBOX - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

DEFAULT_PASSWORD - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

DEFAULT_PASSWORD - Static variable in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

DefaultEmail - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

A default set of email addresses specified by an administrator.

DefaultEnterprise - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

The file repository server within BusinessObjects Enterprise specified by an administrator.

DefaultFile - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

A default file location on a local machine set by an administrator.

DefaultFtp - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

The name of a default FTP server specified by an administrator.

DefaultInbox - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

A default BusinessObjects Enterprise inbox specified by an administrator.

DefaultParentType - class com.businessobjects.jsf.sdk.properties.DefaultParentType.

Contains fields that specify which item will be the parent item.

DefaultParentType() - Constructor for class com.businessobjects.jsf.sdk.properties.DefaultParentType

DefaultRootType - class com.businessobjects.jsf.sdk.properties.DefaultRootType.

Contains fields that specify the default item type of the root item.

DefaultRootType() - Constructor for class com.businessobjects.jsf.sdk.properties.DefaultRootType

Descending - Static variable in class com.businessobjects.jsf.sdk.properties.SortDirection

The items are sorted in an alphanumeric descending order (Z-A, 9-0).

DestinationType - class com.businessobjects.jsf.sdk.properties.DestinationType.

Specifies the destination type for the Destination component.

DestinationType() - Constructor for class com.businessobjects.jsf.sdk.properties.DestinationType

DrillUpClickedEvent - class com.businessobjects.jsf.sdk.event.DrillUpClickedEvent.

Occurs when the navigation up link is clicked.

DrillUpClickedEvent(UIComponent, ItemEventArgs) - Constructor for class com.businessobjects.jsf.sdk.event.DrillUpClickedEvent

E

EDITABLE_RICH_TEXT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

EditableRichText - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A robust, editable rich text format.

EmailProps - class com.businessobjects.jsf.sdk.properties.EmailProps.

Contains properties for specifying email destination options in the Destination component.

EmailProps() - Constructor for class com.businessobjects.jsf.sdk.properties.EmailProps

EmailProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.EmailProps

encodeBegin(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

For internal use only.

ExcelProps - class com.businessobjects.jsf.sdk.properties.ExcelProps.

Contains properties for specifying Microsoft Excel column properties.

ExcelProps() - Constructor for class com.businessobjects.jsf.sdk.properties.ExcelProps

ExcelProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.ExcelProps

ExcludeInstances - Static variable in class com.businessobjects.jsf.sdk.properties.InstanceFilter

All other objects are returned.

F

FileProps - class com.businessobjects.jsf.sdk.properties.FileProps.

Contains properties for specifying file destination options in the Destination component.

FileProps() - Constructor for class com.businessobjects.jsf.sdk.properties.FileProps

FileProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.FileProps

FilterProps - class com.businessobjects.jsf.sdk.properties.FilterProps.

Contains properties for the selection formulas used to retrieve and filter groups of records from a database.

FilterProps() - Constructor for class com.businessobjects.jsf.sdk.properties.FilterProps

FilterProps(String) - Constructor for class com.businessobjects.jsf.sdk.properties.FilterProps

Folder - Static variable in class com.businessobjects.jsf.sdk.properties.Hierarchy

The folder hierarchy is active.

Footer - Static variable in class com.businessobjects.jsf.sdk.properties.PagerVisibilityOption

Pager will be displayed at the footer position.

FTPProps - class com.businessobjects.jsf.sdk.properties.FTPProps.

Contains properties for specifying FTP destination options in the Destination component.

FTPProps() - Constructor for class com.businessobjects.jsf.sdk.properties.FTPProps

FTPProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.FTPProps

G

getAccountText() - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Gets the text to display for the ftp account label.

getActionType() - Method in class com.businessobjects.jsf.sdk.properties.PagingAction

Gets a value that represents the type of paging action.

getAddButton() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Gets the properties of the Add button.

getAlerts() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets an instance of the AlertProps class that determines how alert messages are displayed in the ItemsGrid component.

getAlignment() - Method in class com.businessobjects.jsf.sdk.properties.SubmitButtonProps

Gets a HorizonalAlign value that indicates how the button is aligned within a cell.

getAlternatingItemStyle() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the style properties for alternating items in the ItemsGrid component.

getAttachmentText() - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Gets the text to display for the Attachment label.

getAuthentication() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets an instance of the AuthenticationProps class that determines how the authentication input field is displayed in the Logon component.

getButton() - Method in class com.businessobjects.jsf.sdk.event.PagerClickedEvent

Gets a number that represents the pager button movement.

getCannotScheduleText() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the text to display when one or more of the items in the EnterpriseItem or EnterpriseItems beans bound to the component (via the itemSource attribute) cannot be scheduled.

getCannotScheduleText() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

getCcText() - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Gets the text to display for the Cc label.

getCellPadding() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the amount of space between the contents of a cell and the cell's border.

getCellSpacing() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the amount of space between cells.

getCharacterSeparated() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text label to display beside the Delimiter and Separator text boxes.

getCharactersText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text label to display beside the Characters Per Inch text box.

getColumnIndex() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

getColumnIndex() - Method in class com.businessobjects.jsf.sdk.event.ItemEventArgs

Gets the column index.

getColumns() - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Gets the number of columns in the group selection formula text box.

getColumnsText() - Method in class com.businessobjects.jsf.sdk.properties.ExcelProps

Gets the text to display for the Columns label.

getCommandArgument() - Method in class com.businessobjects.jsf.sdk.event.CommandEvent

Gets the arguments associated with the command.

getCommandName() - Method in class com.businessobjects.jsf.sdk.event.CommandEvent

Gets the name of the command (e.g. sort).

getConfirmText() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets the text to display for the new password confirmation label.

getContentChanged() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Returns whether the content of the ItemSource object has changed.

getCookieName() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the name of the cookie that is used to store session information in the browser.

getCopiesText() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Gets the text label to display beside the Copies box.

getCount() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the total number of items in the collection.

getCurrentPage() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the current page number.

getCurrentRangeFirstPage() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the first page number of the current page range.

getCurrentRangeLastPage() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the last page number of the current page range.

getDatabaseNameText() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

getDefaultDirectory() - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Gets the default directory location of the file destination.

getDefaultPort() - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Gets the default port number.

getDefaultRoot() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the default type of the root item, or top level item.

getDefaultRoot() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the default type of the root item, or top level item, as an integer representing the type.

getDelimiterText() - Method in class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps

Gets text to display for the delimiter label.

getDestinationText() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

getDirectoryText() - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Gets the text to display for the Directory label.

getEmail() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

getEmptyText() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the text to display when the items grid is empty.

getEmptyText() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Gets the text to display when the ItemSource connected to the schedule component is empty.

getEnableDefaultParent() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the default parent item type used to query for BusinessObjects Enterprise objects.

getEndText() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the text label to display beside the Expiry box.

getEnterpriseSession() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the Enterprise session data representing a user that has logged in to BusinessObjects Enterprise.

getErrorMsg() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the last error message.

getEventArgs() - Method in class com.businessobjects.jsf.sdk.event.PasswordChangeFailedEvent

Gets the arguments for the event.

getEventArgs() - Method in class com.businessobjects.jsf.sdk.event.ItemClickedEvent

Gets the event arguments.

getEventArgs() - Method in class com.businessobjects.jsf.sdk.event.DrillUpClickedEvent

Gets the event arguments.

getEventArgs() - Method in class com.businessobjects.jsf.sdk.event.AlertClickedEvent

Gets the event arguments.

getExcel() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the formatting properties of Microsoft Excel and Microsoft Excel (Data Only) files.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIPath

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UILogon

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

For internal use only.

getFamily() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

For internal use only.

getFamily() - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

getField() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

Gets the field used for the column data.

getFields() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Gets the list of fields (InfoObject property names) to query for.

getFile() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

getFileName() - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Gets the text to display for the file name label.

getFormats() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the list of formats.

getFormatText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text label to display beside the Format box.

getFrequencyText() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the text label to display beside the Frequency box.

getFromText() - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Gets the text to display for the From label.

getFTP() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

getGroup() - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

Gets the group.

getHeaderStyle() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the style properties of the heading section in the ItemsGrid component.

getHeaderText() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

Gets the header text that is used for the column's label.

getHierarchy() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the active hierarchy used when querying for items.

getHomeUrl() - Method in class com.businessobjects.jsf.sdk.properties.ImagesProps

Gets the URL of the image to display for the home or root item in the Path component.

getHorizontalAlign() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the horizontal alignment of the grid relative to its container.

getHostText() - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Gets the text to display for the ftp host label.

getID() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Gets the unique identifier for an instance of an ItemSource bean.

getID() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the unique identifier for an instance of an Identity bean.

getIdentity() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets the IIdentity object that is bound to the Logon component.

getIdentity() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets the Identity bean that is data bound to the ChangePassword component.

getIdentity() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Gets the Identity bean associated with this ItemSource bean.

getImageUrl() - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Gets the URL of the image to be displayed when an alert occurs.

getImageURL() - Method in class com.businessobjects.jsf.sdk.properties.ButtonProps

Gets the URL of an image to be displayed and used as the button.

getInfoObject() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

getInfoObject() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Gets or sets the InfoObject resulting from a CMS query, or an object directly set on the component.

getInfoobjects() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets an InfoObjects collection directly.

getInfoStore() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the IInfostore object associated with the enterprise session.

getInstances() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a selection that determines whether instances are returned in a query result.

getItem(int) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets an interface to an InfoObject item using the specified index.

getItemID() - Method in class com.businessobjects.jsf.sdk.event.ItemEventArgs

Gets the unique identifier of the item represented in the component.

getItemID() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Gets the InfoStore ID of the object to be retrieved.

getItemImageSize() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the size of an item's icon or thumbnail image.

getItemSource() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the source of the item bound to the Path component.

getItemSource() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the source of the item bound to the ItemsGrid component.

getItemSource() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Gets the source of the item bound to the component.

getItemSource() - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Gets the source of the item bound to the component.

getItemStyle() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the style for the items in the grid.

getItemStyle() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the style properties of the items in the ItemsGrid component.

getItemType() - Method in class com.businessobjects.jsf.sdk.event.ItemEventArgs

Gets the type of the current item.

getItemTypes() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets an array of plugin types to query for.

getLabelAlignment() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets the alignment of the label.

getLabelAlignment() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets the horizontal alignment of all labels.

getLabelAlignment() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Gets the alignment of the label.

getLayoutText() - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Gets the text to display for the Layout label.

getLineText() - Method in class com.businessobjects.jsf.sdk.properties.PaginatedTextProps

Gets the text to display for the lines per page label.

getLocale() - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Gets the component's locale.

getLocale() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the locale to use for the user.

getLoggedOffText() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the text to display when the user is logged off.

getLoggedOffText() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Gets the text to display when the user attempts to access the component while they are logged off.

getLogoffButton() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets an instance of the SubmitButtonProps class that specifies the properties of the logoff button, including optional button properties.

getLogonButton() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets an instance of the SubmitButtonProps class that specifies the properties of the logon button, including optional button properties.

getMessageText() - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Gets the text to display for the Message label.

getNewPageIndex() - Method in class com.businessobjects.jsf.sdk.event.PagerClickedEvent

Gets a number that represents the new page index.

getNewPageIndex() - Method in class com.businessobjects.jsf.sdk.event.PageChangedEvent

Gets a number that represents the new page index.

getNewPasswordText() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets the text to display for the new password label.

getNextPageButton() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets an instance of the ButtonProps class which specifies the properties of the next page button in the ItemsGrid component.

getNextRangeButton() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets an instance of the ButtonProps class which specifies the properties of the next page range button in the ItemsGrid component.

getNotReportText() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

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

getNotReportText() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

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

getNotReportText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

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

getNotReportText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

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

getNotReportText() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

getOldPasswordText() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets the text to display for the old password label.

getOptionsText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text label to display beside the Options box.

getOrientationText() - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Gets the text to display for the Orientation label.

getPageButtons() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets an instance of the PageNumberButtonProps class which specifies the properties of the page number buttons in the ItemsGrid component.

getPageLayout() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.

getPageNumber() - Method in class com.businessobjects.jsf.sdk.properties.PagingAction

Gets the page number for the paging action.

getPagerStyle() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the style properties of the paging section of the ItemsGrid component.

getPageSize() - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Gets the number of items per page.

getPageSizeText() - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Gets the text to display for the Page Size label.

getPaginatedText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text label to display beside the Paginated Text box.

getPaging() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets an instance of the PagingProps class that determines how to manage paging through items in an EnterpriseItems bean.

getParameters() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

getParametersText() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Gets the text label to display beside the Parameters box.

getParentItemID() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the identifier (ID or CUID) of the parent item used to query for objects.

getPassword() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the password to use when logging in.

getPassword() - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Gets the text to display for the password label.

getPasswordText() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

getPasswordText() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets the text to display for the password input label.

getPathToFolder() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Gets the path to the first parent folder of the item.

getPortText() - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Gets the text to display for the ftp port label.

getPreviousPageButton() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets an instance of the ButtonProps class which specifies the properties of the previous page button in the ItemsGrid component.

getPreviousRangeButton() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets an instance of the ButtonProps class which specifies the properties of the previous page range button in the ItemsGrid component.

getPrinterText() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Gets the text label to display beside the Default Printer and Custom Printer buttons.

getPrinterText() - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Gets the text to display for the Printer label.

getPrintText() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Gets the text label to display beside the main print component list.

getProgramArgs() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

getQuery() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a string used to query objects directly without using properties.

getRangeSize() - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Gets the number of pages per page range.

getRangeText() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Gets the text label to display beside the Range box.

getRangeText() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the text label to display beside the Range box.

getRecord() - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

Gets the record.

getRemoveButton() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Gets the properties of the Remove button.

getRepeatDirection() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets whether the path is rendered horizontally or vertically.

getReportServerType() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Gets the type of report server used to obtain the BusinessObjects Enterprise object.

getReportSource() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Gets the ReportSource object that represents the contents of a report.

getReportSource(int) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Gets the ReportSource object that represents the contents of a report.

getRootItemID() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the identifier (ID or CUID) of the root item, or top level item, in the path.

getRootItemID() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets the identifier (ID or CUID) of the root item, or top level item, that can be navigated to in the grid.

getRootText() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the text to display for the root item, or top level item, in the Path component.

getRowIndex() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

getRows() - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Gets the number of rows in the group selection formula text box.

getScheduleOptionText() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the text label to display beside the Schedule Options box.

getSearchFields() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a list of fields to search.

getSearchText() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets the search string used to query for objects.

getSelectedAuthentication() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the default authentication type to use when logging in.

getSelectedDestination() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

getSelectedFormat() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the default format type to be used in the list of formats.

getSelectedItemStyle() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the style for the selected item.

getSelectedPageLayout() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the default page layout type to be used in the Page Layout list.

getSelectedPrintFormat() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Gets the default print type to be used in the Format list.

getSelectedSchedule() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the default schedule type to include in the Schedule list.

getSeparatorStyle() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the style of the text used to separate items within the path.

getSeparatorText() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets the text used to separate items within the path.

getSeparatorText() - Method in class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps

Gets text to display for the separator label.

getServerNameText() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

getShowGridLines() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets a selection that determines which grid lines are visible.

getShowImages() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Gets an instance of the ImagesProps class that determines how images are displayed in the Path component.

getShowImages() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Gets how an item's image is displayed, if at all.

getShowMonthlyOptions() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the monthly date options to display in the Schedule component.

getSortBy() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets an instance of the SortProps class that determines how to sort through items in an EnterpriseItems bean.

getSortDirection() - Method in class com.businessobjects.jsf.sdk.properties.SortProps

Gets the direction of the sort.

getSortField() - Method in class com.businessobjects.jsf.sdk.properties.SortProps

Gets the field (column) of the ItemsGrid component to sort by.

getStartText() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the text label to display beside the Start box.

getStyle() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets a value that specifies the style of the pager.

getStyleClass() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets the CSS style class to be applied when this element is rendered.

getStyleClass() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets the CSS style class to be applied when this element is rendered.

getStyleClass() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Gets the CSS style class to be applied when this element is rendered.

getSubjectText() - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Gets the text to display for the Subject label.

getSubmitButton() - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Gets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

getSubmitButton() - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Gets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

getSystem() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets an instance of the SystemProps class that determines how to display the BusinessObjects Enterprise system input field in the Logon component.

getSystem() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the name of the BusinessObjects Enterprise system to log on to.

getText() - Method in class com.businessobjects.jsf.sdk.properties.SystemProps

Gets the text to display for the BusinessObjects Enterprise system label.

getText() - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Gets the text to display for the group selection formula label.

getText() - Method in class com.businessobjects.jsf.sdk.properties.ButtonProps

Gets the text to be displayed on the button.

getText() - Method in class com.businessobjects.jsf.sdk.properties.AuthenticationProps

Gets the text to display for the authentication label.

getTitle() - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Gets the title attribute for the component.

getToken() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the Enterprise session token for the logged on user.

getTokenExpiry() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the number of minutes the Enterprise session token is valid before expiring.

getToText() - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Gets the text to display for the To label.

getType() - Method in class com.businessobjects.jsf.sdk.properties.PageNumberButtonProps

Gets an instance of PageNumberButtonType, which specifies the page button type.

getType() - Method in class com.businessobjects.jsf.sdk.properties.ButtonProps

Gets the button type.

getUserName() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the name of the user to use when logging in.

getUserName() - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Gets the text to display for the user name label.

getUserNameText() - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

getUserNameText() - Method in class com.businessobjects.jsf.sdk.components.UILogon

Gets the text to display for the user name input label.

getUserRootCategory() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the identifier of the user's BusinessObjects Enterprise personal category.

getUserRootFolder() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the user's root folder.

getValueText() - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Gets the text label to display beside the Value box.

getVisibility() - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Gets a value that specifies the visibility of the pager.

getVisibleAuthentications() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the list of visible authentication types in the drop-down list.

getVisibleDestinations() - Method in class com.businessobjects.jsf.sdk.components.UIDestination

Gets the destinations that will appear in the Destination list.

getVisibleFormats() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets the list of visible formats to be displayed in the Format list.

getVisiblePrintFormats() - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Gets the list of visible print types to be displayed in the Print Types list.

getVisibleSchedules() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets the list of schedule types to be included in the Schedule list.

GridLines - class com.businessobjects.jsf.sdk.properties.GridLines.

Contains fields that specify the type of grid lines.

GridLines() - Constructor for class com.businessobjects.jsf.sdk.properties.GridLines

GROUP_FORMULA - Static variable in class com.businessobjects.jsf.sdk.components.UIReportFilters

H

hasSameValues(PagingProps) - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Returns whether or not the PagingProps object passed in has the same values as this PagingProps object.

Header - Static variable in class com.businessobjects.jsf.sdk.properties.PagerVisibilityOption

Pager will be displayed at the header position.

HeaderAndFooter - Static variable in class com.businessobjects.jsf.sdk.properties.PagerVisibilityOption

Pagers will be displayed at both the header and footer positions.

Hierarchy - class com.businessobjects.jsf.sdk.properties.Hierarchy.

Specifies the active item hierarchy in use for the IEnterpriseItems interface.

Hierarchy() - Constructor for class com.businessobjects.jsf.sdk.properties.Hierarchy

Horizontal - Static variable in class com.businessobjects.jsf.sdk.properties.RepeatDirection

Set the repeat direction to Horizontal.

Horizontal - Static variable in class com.businessobjects.jsf.sdk.properties.GridLines

Use horizontal grid lines.

HorizontalAlign - class com.businessobjects.jsf.sdk.properties.HorizontalAlign.

Contains fields that specify the horizontal alignment of an element in a component.

HorizontalAlign() - Constructor for class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Hourly - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run once every hour.

HOURLY - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

I

Icon - Static variable in class com.businessobjects.jsf.sdk.properties.Image

The icon image is displayed.

IEnterpriseItem - interface com.businessobjects.jsf.sdk.model.IEnterpriseItem.

Used to create an EnterpriseItem bean that is the source for a single BusinessObjects Enterprise object such as a report, folder, or program.

IEnterpriseItems - interface com.businessobjects.jsf.sdk.model.IEnterpriseItems.

Used to create an EnterpriseItems bean that is the source for a collection of BusinessObjects Enterprise objects such as reports, folders, or programs.

IIdentity - interface com.businessobjects.jsf.sdk.model.IIdentity.

Used to create an Identity bean that provides the capability to log on and log off BusinessObjects Enterprise, and manages internal references to BusinessObjects Enterprise.

IItemSource - interface com.businessobjects.jsf.sdk.model.IItemSource.

The source for a BusinessObjects Enterprise object or collection of objects.

Image - class com.businessobjects.jsf.sdk.properties.Image.

Contains fields that specify how to display the image representation of an item.

Image() - Constructor for class com.businessobjects.jsf.sdk.properties.Image

ImageButton - Static variable in class com.businessobjects.jsf.sdk.properties.ButtonType

An image button type.

ImagesProps - class com.businessobjects.jsf.sdk.properties.ImagesProps.

Contains properties for the images that are displayed in the Path component.

ImagesProps() - Constructor for class com.businessobjects.jsf.sdk.properties.ImagesProps

IncludeInstances - Static variable in class com.businessobjects.jsf.sdk.properties.InstanceFilter

All objects are returned, including instances.

InstanceFilter - class com.businessobjects.jsf.sdk.properties.InstanceFilter.

Contains fields that specify whether instances are returned in the query results.

InstanceFilter() - Constructor for class com.businessobjects.jsf.sdk.properties.InstanceFilter

InstancesOnly - Static variable in class com.businessobjects.jsf.sdk.properties.InstanceFilter

All instances are returned.

isAllowDrillDown() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Returns a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.

isAllowSorting() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Returns a value that indicates whether sorting on columns is enabled.

isAutoHandleEvents() - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Returns a value that indicates whether the component assumes responsibility for handling its own events.

isCustomQuery() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a value indicating whether the query has been overwritten by a custom query.

isEnableAutoLogon() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets a value indicating whether or not the Identity bean automatically logs in to BusinessObjects Enterprise.

isEnabled() - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Returns a value that indicates whether the component is enabled.

isEnabled() - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Returns a value that indicates whether paging is enabled.

isFilterByOwner() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a value indicating whether to query for BusinessObjects Enterprise objects owned by the user.

isFirstPage() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a value indicating whether a previous page of InfoObjects is available.

isFirstRange() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a value indicating whether a previous page range of InfoObjects is available.

isHyperlink() - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

Returns a value that indicates whether each item (row) in the column is clickable as a hyperlink.

isLastPage() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a value indicating whether a next page of InfoObjects is available.

isLastRange() - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Gets a value indicating whether a next page range of InfoObjects is available.

isLoggedOn() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets the logged in status of the user.

isLoggedOnAuto() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Gets whether the user was automatically logged on.

isReadOnly() - Method in class com.businessobjects.jsf.sdk.properties.SystemProps

Returns a value that indicates whether the BusinessObjects Enterprise system input is readonly.

isShowAlertMessage() - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Returns a value that indicates whether to show the message on an alert image's tooltip.

isShowAlertTime() - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Returns a value that indicates whether to show the date and time an alert occurred.

isShowCharacters() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets a value indicating whether to display a scheduling option that sets the number of characters per inch in plain text or paginted text file formats.

isShowColumns() - Method in class com.businessobjects.jsf.sdk.properties.ExcelProps

Gets a value indicating whether to display columns.

isShowDayOfMonth() - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Indicates whether to display the recurring day of month option.

isShowDayOfWeek() - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Indicates whether to display the recurring day of week option.

isShowDrillUpLink() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Returns a value that indicates whether to display a link that allows the user to navigate up the hierarchy of items.

isShowEndTime() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Gets a boolean value that specifies whether the End Time option should be displayed.

isShowHeader() - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Returns a value that indicates whether the header row is displayed in the ItemsGrid component.

isShowLastDayOfMonth() - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Indicates whether to display the recurring last day of month option.

isShowLines() - Method in class com.businessobjects.jsf.sdk.properties.PaginatedTextProps

Gets whether to display the number of lines per page.

isShowMonthlyInterval() - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Indicates whether to display the monthly interval scheduling option.

isShowOptions() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets a value indicating whether to display the options for a particular format type.

isShowPageRange() - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Gets a value indicating whether to display the page range.

isShowSelectedItem() - Method in class com.businessobjects.jsf.sdk.components.UIPath

Returns a value that indicates whether to show the selected item in the visual path.

isUserCanSeeUserFolders() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Returns whether the user can see the User Folder.

isVisible() - Method in class com.businessobjects.jsf.sdk.properties.SystemProps

Returns a value that indicates whether the BusinessObjects Enterprise system input is visible.

isVisible() - Method in class com.businessobjects.jsf.sdk.properties.SubmitButtonProps

Returns a value that indicates whether the button is visible.

isVisible() - Method in class com.businessobjects.jsf.sdk.properties.ImagesProps

Returns a value that indicates whether the image is visible.

isVisible() - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Gets a value indicating whether the group selection formula input is visible.

isVisible() - Method in class com.businessobjects.jsf.sdk.properties.AuthenticationProps

Returns a value that indicates whether the authentication label and drop-down list are visible.

isVisible() - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Returns a value that indicates whether to display alerts.

ItemClickedEvent - class com.businessobjects.jsf.sdk.event.ItemClickedEvent.

Occurs when an item is clicked.

ItemClickedEvent(UIComponent, ItemEventArgs) - Constructor for class com.businessobjects.jsf.sdk.event.ItemClickedEvent

ItemEventArgs - class com.businessobjects.jsf.sdk.event.ItemEventArgs.

Provides data for the AlertClickedEvent, ItemClickedEvent, and DrillUpClickedEvent events.

ItemEventArgs(String, String) - Constructor for class com.businessobjects.jsf.sdk.event.ItemEventArgs

ItemEventArgs(String, String, int) - Constructor for class com.businessobjects.jsf.sdk.event.ItemEventArgs

ItemsSetupListener - class com.businessobjects.jsf.sdk.event.ItemsSetupListener.

The default listener used to handle events fired by the Path and ItemsGrid components.

ItemsSetupListener() - Constructor for class com.businessobjects.jsf.sdk.event.ItemsSetupListener

J

Justify - Static variable in class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Use justified alignment.

L

Left - Static variable in class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Align the element to the left edge.

LinkButton - Static variable in class com.businessobjects.jsf.sdk.properties.PageNumberButtonType

Link button type.

LinkButton - Static variable in class com.businessobjects.jsf.sdk.properties.ButtonType

A hyperlink button type.

logoff() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Logs a user off a BusinessObjects Enterprise session.

LogoffClickedEvent - class com.businessobjects.jsf.sdk.event.LogoffClickedEvent.

Occurs when the logoff button is clicked.

LogoffClickedEvent(UIComponent) - Constructor for class com.businessobjects.jsf.sdk.event.LogoffClickedEvent

logon() - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Logs the user on to the BusinessObjects Enterprise session.

logon(String, String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Logs the user on to the BusinessObjects Enterprise session.

logon(String, String, String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Logs the user on to the BusinessObjects Enterprise session.

logon(String, String, String, String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Logs the user on to the BusinessObjects Enterprise session.

LogonClickedEvent - class com.businessobjects.jsf.sdk.event.LogonClickedEvent.

Occurs when the logon button is clicked.

LogonClickedEvent(UIComponent) - Constructor for class com.businessobjects.jsf.sdk.event.LogonClickedEvent

LogonListener - class com.businessobjects.jsf.sdk.event.LogonListener.

The default listener used to handle events fired by the Logon component.

LogonListener() - Constructor for class com.businessobjects.jsf.sdk.event.LogonListener

M

MICROSOFT_EXCEL - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

MICROSOFT_EXCELDATA - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

MICROSOFT_WORD - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

MicrosoftExcel - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A Microsoft Excel format.

MicrosoftExcelData - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A Microsoft Excel (Data Only) format.

MicrosoftWord - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A Microsoft Word format.

Monthly - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run once every month.

MONTHLY - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

MonthlyProps - class com.businessobjects.jsf.sdk.properties.MonthlyProps.

Contains properties for specifying which recurring date options to display in the Schedule component.

MonthlyProps() - Constructor for class com.businessobjects.jsf.sdk.properties.MonthlyProps

movePage(PagingAction) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Moves the pager according to the movement specified by the action parameter.

N

needToQueueModelEvents() - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

NEXTPAGE - Static variable in class com.businessobjects.jsf.sdk.properties.PagerButton

The pager is moved to the next page.

NEXTRANGE - Static variable in class com.businessobjects.jsf.sdk.properties.PagerButton

The pager is moved to the previous range of pages.

None - Static variable in class com.businessobjects.jsf.sdk.properties.ReportPrintType

Do not print the report.

None - Static variable in class com.businessobjects.jsf.sdk.properties.PagerVisibilityOption

No pager will be displayed.

None - Static variable in class com.businessobjects.jsf.sdk.properties.PageNumberButtonType

No button.

None - Static variable in class com.businessobjects.jsf.sdk.properties.Image

The image is not displayed.

None - Static variable in class com.businessobjects.jsf.sdk.properties.Hierarchy

The hierarchy is not specified.

None - Static variable in class com.businessobjects.jsf.sdk.properties.GridLines

Use no grid lines.

None - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultRootType

No root item is chosen.

None - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

No parent item is chosen.

NONE - Static variable in class com.businessobjects.jsf.sdk.properties.ReportPrintType

NONE - Static variable in class com.businessobjects.jsf.sdk.properties.PagerButton

The pager is not moved.

NotSet - Static variable in class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Horizonal alignment is not specified.

Now - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run immediately.

NOW - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

O

Once - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run only once.

ONCE - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

P

PageChangedEvent - class com.businessobjects.jsf.sdk.event.PageChangedEvent.

Occurs when the page index is finally updated.

PageChangedEvent(UIComponent, int) - Constructor for class com.businessobjects.jsf.sdk.event.PageChangedEvent

PageLayoutProps - class com.businessobjects.jsf.sdk.properties.PageLayoutProps.

Contains properties for specifying the page layout.

PageLayoutProps() - Constructor for class com.businessobjects.jsf.sdk.properties.PageLayoutProps

PageLayoutProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.PageLayoutProps

PageNumberButtonProps - class com.businessobjects.jsf.sdk.properties.PageNumberButtonProps.

Contains properties for displaying numbered pager buttons.

PageNumberButtonProps() - Constructor for class com.businessobjects.jsf.sdk.properties.PageNumberButtonProps

PageNumberButtonProps(String) - Constructor for class com.businessobjects.jsf.sdk.properties.PageNumberButtonProps

PageNumberButtonType - class com.businessobjects.jsf.sdk.properties.PageNumberButtonType.

Contains fields that specify the possible values of the page number buttons for the pager of the ItemsGrid component.

PageNumberButtonType() - Constructor for class com.businessobjects.jsf.sdk.properties.PageNumberButtonType

PagerButton - class com.businessobjects.jsf.sdk.properties.PagerButton.

Contains fields that specify all possible values for the movement of the pager within the ItemsGrid component.

PagerButton() - Constructor for class com.businessobjects.jsf.sdk.properties.PagerButton

PagerClickedEvent - class com.businessobjects.jsf.sdk.event.PagerClickedEvent.

Occurs when one of the page selection elements is clicked.

PagerClickedEvent(UIComponent, int, int) - Constructor for class com.businessobjects.jsf.sdk.event.PagerClickedEvent

PagerProps - class com.businessobjects.jsf.sdk.properties.PagerProps.

Specifies the style for the pager of the ItemsGrid component.

PagerProps() - Constructor for class com.businessobjects.jsf.sdk.properties.PagerProps

PagerVisibilityOption - class com.businessobjects.jsf.sdk.properties.PagerVisibilityOption.

Contains fields that specify the position in which the pager will be displayed.

PagerVisibilityOption() - Constructor for class com.businessobjects.jsf.sdk.properties.PagerVisibilityOption

PageServer - Static variable in class com.businessobjects.jsf.sdk.properties.ReportServerType

Use the Page Server to view reports.

PAGINATED_TEXT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

PaginatedText - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A paginated text format.

PaginatedTextProps - class com.businessobjects.jsf.sdk.properties.PaginatedTextProps.

Contains properties for displaying paginated text.

PaginatedTextProps() - Constructor for class com.businessobjects.jsf.sdk.properties.PaginatedTextProps

PaginatedTextProps(Locale) - Constructor for class com.businessobjects.jsf.sdk.properties.PaginatedTextProps

PagingAction - class com.businessobjects.jsf.sdk.properties.PagingAction.

Used by the EnterpriseItems bean for page movement.

PagingAction(int) - Constructor for class com.businessobjects.jsf.sdk.properties.PagingAction

PagingAction(int, int) - Constructor for class com.businessobjects.jsf.sdk.properties.PagingAction

PagingProps - class com.businessobjects.jsf.sdk.properties.PagingProps.

Contains properties for specifying how to perform paging.

PagingProps() - Constructor for class com.businessobjects.jsf.sdk.properties.PagingProps

PagingProps(boolean, int, int) - Constructor for class com.businessobjects.jsf.sdk.properties.PagingProps

PASSWORD - Static variable in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

PasswordChangedEvent - class com.businessobjects.jsf.sdk.event.PasswordChangedEvent.

Occurs when the user's password is successfully changed.

PasswordChangedEvent(UIComponent) - Constructor for class com.businessobjects.jsf.sdk.event.PasswordChangedEvent

PasswordChangeFailedEvent - class com.businessobjects.jsf.sdk.event.PasswordChangeFailedEvent.

Occurs when the attempt to change the user's password fails.

PasswordChangeFailedEvent(UIComponent, Object) - Constructor for class com.businessobjects.jsf.sdk.event.PasswordChangeFailedEvent

PersonalCategory - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

Use the BusinessObjects Enterprise main personal category as the parent item.

PLAIN_TEXT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

PlainText - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A plain text format.

PREVPAGE - Static variable in class com.businessobjects.jsf.sdk.properties.PagerButton

The pager is moved to the previous page.

PREVRANGE - Static variable in class com.businessobjects.jsf.sdk.properties.PagerButton

The pager is moved to the next range of pages.

processAction(ActionEvent) - Method in class com.businessobjects.jsf.sdk.event.ScheduleSubmitListener

Invoked when the action described by the specified ActionEvent occurs.

processAction(ActionEvent) - Method in class com.businessobjects.jsf.sdk.event.LogonListener

Processes the event.

processAction(ActionEvent) - Method in class com.businessobjects.jsf.sdk.event.ItemsSetupListener

Processes the event.

processAction(ActionEvent) - Method in class com.businessobjects.jsf.sdk.event.ChangePasswordListener

Processes the event.

promptPrefix - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

Q

queryForCalendars() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

R

RECORD_FORMULA - Static variable in class com.businessobjects.jsf.sdk.components.UIReportFilters

RepeatDirection - class com.businessobjects.jsf.sdk.properties.RepeatDirection.

Contains fields that specify the repeat direction for the Path component.

RepeatDirection() - Constructor for class com.businessobjects.jsf.sdk.properties.RepeatDirection

ReportApplicationServer - Static variable in class com.businessobjects.jsf.sdk.properties.ReportServerType

Use the Report Application Server to view reports.

ReportFormatType - class com.businessobjects.jsf.sdk.properties.ReportFormatType.

Specifies the report format type for the ReportFormat component.

ReportFormatType() - Constructor for class com.businessobjects.jsf.sdk.properties.ReportFormatType

ReportPrintType - class com.businessobjects.jsf.sdk.properties.ReportPrintType.

Specifies the report print type for the ReportPrint component.

ReportPrintType() - Constructor for class com.businessobjects.jsf.sdk.properties.ReportPrintType

ReportServerType - class com.businessobjects.jsf.sdk.properties.ReportServerType.

Contains fields that specify the type of server used to view reports.

ReportServerType() - Constructor for class com.businessobjects.jsf.sdk.properties.ReportServerType

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIPath

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UILogon

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

For internal use only.

restoreState(FacesContext, Object) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

For internal use only.

restoreState(FacesContext, Object) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

RICH_TEXT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

RichText - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A rich text format.

Right - Static variable in class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Align the element to the right.

RootFolder - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

Use the system's root folder as the parent item.

S

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIPath

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UILogon

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

For internal use only.

saveState(FacesContext) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

For internal use only.

saveState(FacesContext) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

schedule() - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Schedules the object(s) to run with updated properties.

ScheduleSubmitListener - class com.businessobjects.jsf.sdk.event.ScheduleSubmitListener.

Default listener for JSF scheduling components.

ScheduleSubmitListener() - Constructor for class com.businessobjects.jsf.sdk.event.ScheduleSubmitListener

ScheduleType - class com.businessobjects.jsf.sdk.properties.ScheduleType.

Specifies the schedule type for the Schedule component.

ScheduleType() - Constructor for class com.businessobjects.jsf.sdk.properties.ScheduleType

SERVERNAME - Static variable in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

setAccountText(String) - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Sets the text to display for the ftp account label.

setAddButton(ButtonProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Sets the properties of the Add button.

setAlerts(AlertProps) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets how alert messages are displayed in the ItemsGrid component.

setAlignment(int) - Method in class com.businessobjects.jsf.sdk.properties.SubmitButtonProps

Sets a HorizonalAlign value that indicates how the button is aligned within a cell.

setAllowDatabaseLogonPrompting(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to allow users to be prompted for database logon information.

setAllowDrillDown(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.

setAllowDrillDown(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to allow the user to drill down on the report.

setAllowParameterPrompting(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to allow the user to be prompted for parameter values.

setAllowSorting(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets a value that indicates whether sorting on columns is enabled.

setAlternatingItemStyle(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the style properties for alternating items in the ItemsGrid component.

setAttachmentText(String) - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Sets the text to display for the Attachment label.

setAuthentication(AuthenticationProps) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets how the authentication input field is displayed in the Logon component.

setAutoHandleEvents(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets a value indicating whether the Path component assumes responsibility for handling its own events.

setAutoHandleEvents(boolean) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets a value indicating whether the Logon component assumes responsibility for handling its own events.

setAutoHandleEvents(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets a value that indicates whether the ItemsGrid component assumes responsibility for handling its own events.

setAutoHandleEvents(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets a value indicating whether the ChangePassword component assumes responsibility for handling its own events.

setAutoHandleEvents(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Enables or disables event auto handling.

setAutoHandleEvents(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Sets a value that indicates whether the component assumes responsibility for handling its own events.

setCannotScheduleText(String) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the text to display when one or more of the items in the EnterpriseItem or EnterpriseItems beans bound to the component (via the itemSource attribute) cannot be scheduled.

setCannotScheduleText(String) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setCcText(String) - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Sets the text to display for the Cc label.

setCellPadding(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the amount of space between the contents of a cell and the cell's border.

setCellSpacing(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the amount of space between cells.

setCharacterSeparated(CharacterSeparatedProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text labels to display beside the Delimiter and Separator text boxes.

setCharactersText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text label to display beside the Characters Per Inch text box.

setColumnIndex(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

setColumns(int) - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Sets the number of columns in the group selection formula text box.

setColumnsText(String) - Method in class com.businessobjects.jsf.sdk.properties.ExcelProps

Sets the text to display for the Columns label.

setConfirmText(String) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets the text to display for the new password confirmation label.

setCookieName(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the name of the cookie that is used to store session information in the browser.

setCopiesText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Sets the text label to display beside the Copies box.

setDatabaseLogonInfos(ConnectionInfos) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the information required to log on to the database.

setDatabaseNameText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

setDefaultDirectory(String) - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Sets the default directory location of the file destination.

setDefaultPort(int) - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Sets the default port number.

setDefaultRoot(int) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the default type of the root item, or top level item.

setDefaultRoot(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the default type of the root item, or top level item, as an integer representing the type.

setDelimiterText(String) - Method in class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps

Sets text to display for the delimiter label.

setDestinationText(String) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setDirectoryText(String) - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Sets the text to display for the Directory label.

setDisplayGroupTree(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the Group Tree on viewer start up.

setDisplayPage(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the report page.

setDisplayToolbar(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the toolbar.

setDisplayToolbarExportButton(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the export button on the toolbar.

setDisplayToolbarFindButton(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the Search button on the toolbar.

setDisplayToolbarFindPageButton(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the Go To Page button on the toolbar.

setDisplayToolbarLogo(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the Business Objects logo on the toolbar.

setDisplayToolbarPageNavigationButtons(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the page navigation buttons on the toolbar.

setDisplayToolbarPrintButton(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the print button on the toolbar.

setDisplayToolbarRefreshButton(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the Refresh button on the toolbar.

setDisplayToolbarToggleTreeButton(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the Group Tree toggle button on the toolbar.

setDisplayToolbarViewList(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display the view list on the toolbar.

setDisplayToolbarZoomList(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether to display a zoom factor drop down list on the toolbar.

setEmail(EmailProps) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setEmptyText(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the text to display when the items grid is empty.

setEmptyText(String) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Sets the text to display when the ItemSource connected to the schedule component is empty.

setEnableAutoLogon(boolean) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets a value indicating whether or not the Identity bean automatically logs in to BusinessObjects Enterprise.

setEnabled(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Sets a value that indicates whether the component is enabled.

setEnabled(boolean) - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Sets a value that indicates whether paging is enabled.

setEnableDefaultParent(int) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets the default parent item type used to query for BusinessObjects Enterprise objects.

setEnablePageToGrow(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets whether the viewer ignores the height and width values it is given and try to find the best fit for the report by taking up as much space as it needs to properly display the report.

setEndText(String) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the text label to display beside the Expiry box.

setExcel(ExcelProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the formatting properties of Microsoft Excel and Microsoft Excel (Data Only) files.

setField(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

Gets the field used for the column data.

setFields(String[]) - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Sets the list of fields(InfoObject property names) to query for.

setFile(FileProps) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setFileName(String) - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Sets the text to display for the file name label.

setFilterByOwner(boolean) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets a value indicating whether to query for BusinessObjects Enterprise objects owned by the user.

setFormatText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text label to display beside the Format box.

setFrequencyText(String) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the text label to display beside the Frequency box.

setFromText(String) - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Sets the text to display for the From label.

setFTP(FTPProps) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setGroup(FilterProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

Sets the group.

setGroupTreeWidth(int) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the width of the Group Tree.

setGroupTreeWidthUnit(CrHtmlUnitEnum) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Specifies the units to use for the width of the Group Tree.

setHeaderStyle(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the style properties of the heading section in the ItemsGrid component.

setHeaderText(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

Sets the header text that is used for the column's label.

setHeight(int) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the viewer height in pixels.

setHierarchy(int) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets the active hierarchy used when querying for items.

setHomeUrl(String) - Method in class com.businessobjects.jsf.sdk.properties.ImagesProps

Sets the URL of the image to display for the home or root item in the Path component.

setHorizontalAlign(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the horizontal alignment of the grid relative to its container.

setHostText(String) - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Sets the text to display for the ftp host label.

setHyperlink(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

Sets a value that indicates whether each item (row) in the column is clickable as a hyperlink.

setHyperlinkTarget(String) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the window or frame where hyperlinked documents are displayed.

setID(String) - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Sets the unique identifier for an instance of an ItemSource bean.

setID(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the unique identifier for an instance of an Identity bean.

setIdentity(IIdentity) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Binds an IIdentity object to the Logon component.

setIdentity(IIdentity) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets the Identity bean that is data bound to the ChangePassword component.

setIdentity(IIdentity) - Method in interface com.businessobjects.jsf.sdk.model.IItemSource

Sets the Identity bean to use with this ItemSource bean.

setImageUrl(String) - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Sets the URL of the image to be displayed when an alert occurs.

setImageURL(String) - Method in class com.businessobjects.jsf.sdk.properties.ButtonProps

Sets the URL of an image to be displayed and used as the button.

setInfoObject(IInfoObject) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

setInfoObject(IInfoObject) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Sets the InfoObject resulting from a CMS query, or an object directly set on the component.

setInstances(int) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets a selection that determines whether instances are returned in a query result.

setItemID(String) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Sets the InfoStore ID of the object to be retrieved.

setItemImageSize(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the size of an item's icon or thumbnail image.

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

Sets the source of the item bound to the component.

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIPath

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setItemSource(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

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

setItemStyle(String) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the style for the items in the grid.

setItemStyle(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the style properties of the items in the ItemsGrid component.

setItemTypes(String[]) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets an array of plugin types to query for.

setLabelAlignment(int) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets the alignment of the label.

setLabelAlignment(int) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets the horizontal alignment of all labels.

setLabelAlignment(int) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Sets the horizontal alignment of the label.

setLayoutText(String) - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Sets the text to display for the Layout label.

setLeft(int) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the left position of the viewer.

setLineText(String) - Method in class com.businessobjects.jsf.sdk.properties.PaginatedTextProps

Sets the text to display for the lines per page label.

setLocale(Locale) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Sets the component's locale.

setLocale(Locale) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the locale to use for the user.

setLoggedOffText(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the text to display when the user is logged off.

setLoggedOffText(String) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Sets the text to display when the user attempts to access the component while they are logged off.

setLogoffButton(SubmitButtonProps) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets the properties of the logoff button, including optional button properties.

setLogonButton(SubmitButtonProps) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets the properties of the logon button, including optional button properties.

setMessageText(String) - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Sets the text to display for the Message label.

setNeedToQueueModelEvents(boolean) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

For internal use only.

setNewPasswordText(String) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets the text to display for the new password label.

setNextPageButton(ButtonProps) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets an instance of the ButtonProps class which specifies the properties of the next page button in the ItemsGrid component.

setNextRangeButton(ButtonProps) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets an instance of the ButtonProps class which specifies the properties of the next page range button in the ItemsGrid component.

setNotReportText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

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

setNotReportText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

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

setNotReportText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

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

setNotReportText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

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

setNotReportText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

setOldPasswordText(String) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets the text to display for the old password label.

setOptionsText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text label to display beside the Options box.

setOrientationText(String) - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Sets the text to display for the Orientation label.

setPageButtons(PageNumberButtonProps) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets an instance of the PageNumberButtonProps class which specifies the properties of the page number buttons in the ItemsGrid component.

setPageLayout(PageLayoutProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.

setPageNumber(int) - Method in class com.businessobjects.jsf.sdk.properties.PagingAction

Sets the page number for the paging action.

setPagerStyle(PagerProps) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the style properties of the paging section of the ItemsGrid component.

setPageSize(int) - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Sets the number of items per page.

setPageSizeText(String) - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Sets the text to display for the Page Size label.

setPaginatedText(PaginatedTextProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text label to display beside the Paginated Text box.

setPaging(PagingProps) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets an instance of the PagingProps class that determines how to manage paging through items in an EnterpriseItems bean.

setParameterFields(Fields) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the parameter fields for the report.

setParametersText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Sets the text label to display beside the Parameters box.

setParentItemID(String) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets the identifier (ID or CUID) of the parent item used to query for objects.

setPassword(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the password to use when logging in.

setPassword(String) - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Sets the text to display for the password label.

setPasswordText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

setPasswordText(String) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets the text to display for the password input label.

setPortText(String) - Method in class com.businessobjects.jsf.sdk.properties.FTPProps

Sets the text to display for the ftp port label.

setPreviousPageButton(ButtonProps) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets an instance of the ButtonProps class which specifies the properties of the previous page button in the ItemsGrid component.

setPreviousRangeButton(ButtonProps) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets an instance of the ButtonProps class which specifies the properties of the previous page range button in the ItemsGrid component.

setPrinterText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Sets the text label to display beside the Default Printer and Custom Printer buttons.

setPrinterText(String) - Method in class com.businessobjects.jsf.sdk.properties.PageLayoutProps

Sets the text to display for the Printer label.

setPrintMode(CrPrintMode) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Note: The JSF report page viewer only supports PDF printing.

setPrintText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Sets the text label to display beside the main print component list.

setProductLocale(Locale) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the locale used to display all text and formatting generated by the viewer (such as the toolbar).

setQuery(String) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets a custom query that is used to obtain objects directly without using properties.

setRangeSize(int) - Method in class com.businessobjects.jsf.sdk.properties.PagingProps

Sets the number of pages per page range.

setRangeText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Sets the text label to display beside the Range box.

setRangeText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the text label to display beside the Range box.

setReadOnly(boolean) - Method in class com.businessobjects.jsf.sdk.properties.SystemProps

Sets a value that indicates whether the BusinessObjects Enterprise system input is readonly.

setRecord(FilterProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

Sets the record.

setRemoveButton(ButtonProps) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Sets the properties of the Remove button.

setRepeatDirection(int) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets whether the path is rendered horizontally or vertically.

setReportServerType(int) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItem

Sets the default server type that determines which server to use (Page Server or RAS) to obtain a ReportSource object.

setReportSource(IReportSource) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the report instance that the viewer will render in HTML.

setRootItemID(String) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the identifier (ID or CUID) of the root item, or top level item, in the path.

setRootItemID(String) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets the identifier (ID or CUID) of the root item, or top level item, that can be navigated to in the grid.

setRootText(String) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the text to display for the root item, or top level item, in the Path component.

setRowIndex(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsColumn

For internal use only.

setRows(int) - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Sets the number of rows in the group selection formula text box.

setScheduleOptionText(String) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the text label to display beside the Schedule Options box.

setSearchFields(String[]) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets a list of fields to search.

setSearchText(String) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets the search string used to query for objects.

setSelectedAuthentication(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the default authentication type to use when logging in.

setSelectedDestination(int) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

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

setSelectedFormat(int) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the default format type to be used in the list of formats.

setSelectedItemStyle(String) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the style for the selected item.

setSelectedPageLayout(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the default page layout type to be used in the Page Layout list.

setSelectedPrintFormat(int) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Sets the default print type to be used in the Format list.

setSelectedSchedule(int) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the default schedule type to include in the Schedule list.

setSeparatorStyle(String) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the style of the text used to separate items within the path.

setSeparatorText(String) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets the text used to separate items within the path.

setSeparatorText(String) - Method in class com.businessobjects.jsf.sdk.properties.CharacterSeparatedProps

Sets text to display for the separator label.

setServerNameText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

setShowAlertMessage(boolean) - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Sets a value that indicates whether to show the message on an alert image's tooltip.

setShowAlertTime(boolean) - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Sets a value that indicates whether to show the date and time an alert occurred.

setShowCharacters(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets a value indicating whether to display a scheduling option that sets the number of characters per inch in plain text or paginted text file formats.

setShowColumns(boolean) - Method in class com.businessobjects.jsf.sdk.properties.ExcelProps

Sets a value indicating whether to display columns.

setShowDayOfMonth(boolean) - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Sets whether to display the recurring day of month option.

setShowDayOfWeek(boolean) - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Sets whether to display the recurring day of week option.

setShowDrillUpLink(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets whether to display a link that allows the user to navigate up the hierarchy of items.

setShowEndTime(boolean) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets whether the End Time option should be displayed.

setShowGridLines(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets a selection that determines which grid lines are visible.

setShowHeader(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets a value that determines whether the header row is displayed in the ItemsGrid component.

setShowImages(ImagesProps) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets an instance of the ImagesProps class that determines how images are displayed in the Path component.

setShowImages(int) - Method in class com.businessobjects.jsf.sdk.components.UIItemsGrid

Sets how an item's image is displayed, if at all.

setShowLastDayOfMonth(boolean) - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Sets a value indicating whether to display the recurring last day of month option.

setShowLines(boolean) - Method in class com.businessobjects.jsf.sdk.properties.PaginatedTextProps

Sets a value indicating whether to display the number of lines per page.

setShowMonthlyInterval(boolean) - Method in class com.businessobjects.jsf.sdk.properties.MonthlyProps

Sets whether to display the monthly interval scheduling option.

setShowMonthlyOptions(MonthlyProps) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the monthly date options to display in the Schedule component.

setShowOptions(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets a value indicating whether to display the options for a particular format type.

setShowPageRange(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets a value indicating whether to display the page range.

setShowSelectedItem(boolean) - Method in class com.businessobjects.jsf.sdk.components.UIPath

Sets whether to show the selected item in the visual path.

setSortBy(SortProps) - Method in interface com.businessobjects.jsf.sdk.model.IEnterpriseItems

Sets an instance of the SortProps class that determines how to sort through items in an EnterpriseItems bean.

setSortDirection(int) - Method in class com.businessobjects.jsf.sdk.properties.SortProps

Sets the direction of the sort.

setSortField(String) - Method in class com.businessobjects.jsf.sdk.properties.SortProps

Sets the field (column) of the ItemsGrid component to sort by.

setStartText(String) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the text label to display beside the Start box.

setStyle(String) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets a value that specifies the style of the pager.

setStyleClass(String) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets the CSS style class to be applied when this element is rendered.

setStyleClass(String) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets the CSS style class to be applied when this element is rendered.

setStyleClass(String) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Sets the CSS style class to be applied when this element is rendered.

setStyleSheet(String) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the style sheet that is used to display the report content.

setSubjectText(String) - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Sets the text to display for the Subject label.

setSubmitButton(SubmitButtonProps) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Sets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

setSubmitButton(SubmitButtonProps) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Sets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

setSystem(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the name of the BusinessObjects Enterprise system to log on to.

setSystem(SystemProps) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets how to display the BusinessObjects Enterprise system input field in the Logon component.

setText(String) - Method in class com.businessobjects.jsf.sdk.properties.SystemProps

Sets the text to display for the BusinessObjects Enterprise system label.

setText(String) - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Sets the text to display for the group selection formula label.

setText(String) - Method in class com.businessobjects.jsf.sdk.properties.ButtonProps

Sets the text to be displayed on the button.

setText(String) - Method in class com.businessobjects.jsf.sdk.properties.AuthenticationProps

Sets the text to display for the authentication label.

setTitle(String) - Method in class com.businessobjects.jsf.sdk.components.UIBaseControl

Sets the title attribute for the component.

setTokenExpiry(int) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the number of minutes the Enterprise session token is valid before expiring.

setTop(int) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the top position of the viewer.

setToText(String) - Method in class com.businessobjects.jsf.sdk.properties.EmailProps

Sets the text to display for the To label.

setType(int) - Method in class com.businessobjects.jsf.sdk.properties.PageNumberButtonProps

Sets an instance of PageNumberButtonType, which specifies the page button type.

setType(int) - Method in class com.businessobjects.jsf.sdk.properties.ButtonProps

Sets an instance of ButtonType, which specifies the button type.

setUserName(String) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the name of the user to use when logging in.

setUserName(String) - Method in class com.businessobjects.jsf.sdk.properties.FileProps

Sets the text to display for the user name label.

setUserNameText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

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

setUserNameText(String) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Sets the text to display for the user name input label.

setValueText(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportParameters

Sets the text label to display beside the Value box.

setViewerName(String) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the name of the viewer.

setVisibility(int) - Method in class com.businessobjects.jsf.sdk.properties.PagerProps

Sets a value that specifies the visibility of the pager.

setVisible(boolean) - Method in class com.businessobjects.jsf.sdk.properties.SystemProps

Sets a value that indicates whether the BusinessObjects Enterprise system input is visible.

setVisible(boolean) - Method in class com.businessobjects.jsf.sdk.properties.SubmitButtonProps

Sets a value that indicates whether the button is visible.

setVisible(boolean) - Method in class com.businessobjects.jsf.sdk.properties.ImagesProps

Sets a value that indicates whether the image is visible.

setVisible(boolean) - Method in class com.businessobjects.jsf.sdk.properties.FilterProps

Sets a value indicating whether the group selection formula input is visible.

setVisible(boolean) - Method in class com.businessobjects.jsf.sdk.properties.AuthenticationProps

Sets a value that indicates whether the authentication label and drop-down list are visible.

setVisible(boolean) - Method in class com.businessobjects.jsf.sdk.properties.AlertProps

Sets a value that indicates whether to display alerts.

setVisibleAuthentications(String[]) - Method in interface com.businessobjects.jsf.sdk.model.IIdentity

Sets the list of visible authentication types in the drop-down list.

setVisibleDestinations(String) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

Sets the destinations that appear in the Destination list.

setVisibleFormats(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

Sets the list of visible formats to be displayed in the Format list.

setVisiblePrintFormats(String) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

Sets the list of visible print types that are to be displayed in the Print Types list.

setVisibleSchedules(String) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

Sets the list of schedule types to be included in the Schedule list.

setWidth(int) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the viewer width in pixels.

setZoomPercentage(int) - Method in class com.crystaldecisions.report.web.jsf.UIReportPageViewer

Sets the zoom factor used when displaying the report.

SortClickedEvent - class com.businessobjects.jsf.sdk.event.SortClickedEvent.

Occurs when the link in a column heading is clicked to trigger sorting.

SortClickedEvent(UIComponent, List) - Constructor for class com.businessobjects.jsf.sdk.event.SortClickedEvent

SortDirection - class com.businessobjects.jsf.sdk.properties.SortDirection.

Contains fields that specify whether to use an ascending or descending direction to sort a list of items.

SortDirection() - Constructor for class com.businessobjects.jsf.sdk.properties.SortDirection

SortProps - class com.businessobjects.jsf.sdk.properties.SortProps.

Contains properties that specify the field to sort items by and the direction in which to sort them.

SortProps() - Constructor for class com.businessobjects.jsf.sdk.properties.SortProps

SPECIFIC_EMAIL - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

SPECIFIC_FILE - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

SPECIFIC_FTP - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

SPECIFIC_INBOX - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

SpecificEmail - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

A set of email addresses specified by the user.

SpecificFile - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

A file location on a local machine specified by the user.

SpecificFtp - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

The name of an FTP server specified by the user.

SpecificInbox - Static variable in class com.businessobjects.jsf.sdk.properties.DestinationType

A set of BusinessObjects Enterprise inboxes specified by the user.

SUBMIT - Static variable in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

submit(IIdentity) - Method in class com.businessobjects.jsf.sdk.components.UILogon

Attempts to log the user on or off BusinessObjects Enterprise depending on the state of the component.

submit(IIdentity) - Method in class com.businessobjects.jsf.sdk.components.UIChangePassword

Applies the password changes for the user to the system.

submit(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

submit(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportPrint

For internal use only.

submit(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportFormat

For internal use only.

submit(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIReportFilters

For internal use only.

submit(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIDestination

For internal use only.

submit(IItemSource) - Method in class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Applies the changes to the schedule properties of the item source passed in.

SubmitButtonProps - class com.businessobjects.jsf.sdk.properties.SubmitButtonProps.

Contains optional properties for a button or a set of buttons in addition to the properties contained in the ButtonProps class.

SubmitButtonProps() - Constructor for class com.businessobjects.jsf.sdk.properties.SubmitButtonProps

SubmitButtonProps(String) - Constructor for class com.businessobjects.jsf.sdk.properties.SubmitButtonProps

SubmitClickedEvent - class com.businessobjects.jsf.sdk.event.SubmitClickedEvent.

Occurs when the component's submit button is clicked.

SubmitClickedEvent(UIComponent) - Constructor for class com.businessobjects.jsf.sdk.event.SubmitClickedEvent

SystemProps - class com.businessobjects.jsf.sdk.properties.SystemProps.

Contains properties for specifying system input information used when logging on to BusinessObjects Enterprise with the Logon component.

SystemProps() - Constructor for class com.businessobjects.jsf.sdk.properties.SystemProps

T

TAB_SEPARATED_TEXT - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

TAB_SEPARATED_VALUES - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

TabSeparatedText - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A format with tab separated text.

TabSeparatedValues - Static variable in class com.businessobjects.jsf.sdk.properties.ReportFormatType

A format with tab separated values.

Thumbnail - Static variable in class com.businessobjects.jsf.sdk.properties.Image

The thumbnail image is displayed.

toString(int) - Static method in class com.businessobjects.jsf.sdk.properties.HorizontalAlign

Returns the horizonal alignment as a String.

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UISchedule

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIReportPrint

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIReportParameters

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIReportFormat

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIReportFilters

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIPath

For internal use only.

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UILogon

For internal use only.

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIItemsGrid

For internal use only.

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIItemsColumn

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIDestination

TYPE - Static variable in class com.businessobjects.jsf.sdk.components.UIChangePassword

U

UIBaseControl - class com.businessobjects.jsf.sdk.components.UIBaseControl.

The base component from which all other BusinessObjects Enterprise JSF components inherit.

UIBaseControl() - Constructor for class com.businessobjects.jsf.sdk.components.UIBaseControl

UIBaseScheduleControl - class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl.

The base scheduling component from which all other BusinessObjects Enterprise JSF scheduling components inherit.

UIBaseScheduleControl() - Constructor for class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

UIChangePassword - class com.businessobjects.jsf.sdk.components.UIChangePassword.

Allows the user to change their BusinessObjects Enterprise logon password.

UIChangePassword() - Constructor for class com.businessobjects.jsf.sdk.components.UIChangePassword

UIDestination - class com.businessobjects.jsf.sdk.components.UIDestination.

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

UIDestination() - Constructor for class com.businessobjects.jsf.sdk.components.UIDestination

UIItemsColumn - class com.businessobjects.jsf.sdk.components.UIItemsColumn.

A column that appears in the ItemsGrid component.

UIItemsColumn() - Constructor for class com.businessobjects.jsf.sdk.components.UIItemsColumn

UIItemsGrid - class com.businessobjects.jsf.sdk.components.UIItemsGrid.

A data bound component that displays the items from an EnterpriseItem or EnterpriseItems bean in a table.

UIItemsGrid() - Constructor for class com.businessobjects.jsf.sdk.components.UIItemsGrid

UILogon - class com.businessobjects.jsf.sdk.components.UILogon.

Enables a user to log on to a BusinessObjects Enterprise session.

UILogon() - Constructor for class com.businessobjects.jsf.sdk.components.UILogon

UIPath - class com.businessobjects.jsf.sdk.components.UIPath.

Provides the user with a visual, "breadcrumb trail" representation of the path from a selected item, such as a report, to its root item.

UIPath() - Constructor for class com.businessobjects.jsf.sdk.components.UIPath

UIReportDatabaseLogon - class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon.

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

UIReportDatabaseLogon() - Constructor for class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

UIReportFilters - class com.businessobjects.jsf.sdk.components.UIReportFilters.

Enables a user to enter record and group selection formulas that retrieve and filter report records from the database when a scheduled report is run.

UIReportFilters() - Constructor for class com.businessobjects.jsf.sdk.components.UIReportFilters

UIReportFormat - class com.businessobjects.jsf.sdk.components.UIReportFormat.

Enables a user to select the file format of the report they wish to schedule.

UIReportFormat() - Constructor for class com.businessobjects.jsf.sdk.components.UIReportFormat

UIReportPageViewer - class com.crystaldecisions.report.web.jsf.UIReportPageViewer.

The JavaServer Faces version of the DHTML report page viewer.

UIReportPageViewer() - Constructor for class com.crystaldecisions.report.web.jsf.UIReportPageViewer

UIReportParameters - class com.businessobjects.jsf.sdk.components.UIReportParameters.

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

UIReportParameters() - Constructor for class com.businessobjects.jsf.sdk.components.UIReportParameters

UIReportPrint - class com.businessobjects.jsf.sdk.components.UIReportPrint.

Enables a user to specify the printer settings of a report to be scheduled.

UIReportPrint() - Constructor for class com.businessobjects.jsf.sdk.components.UIReportPrint

UISchedule - class com.businessobjects.jsf.sdk.components.UISchedule.

Enables a user to enter a scheduling plan.

UISchedule() - Constructor for class com.businessobjects.jsf.sdk.components.UISchedule

updateTime() - Method in class com.businessobjects.jsf.sdk.components.UISchedule

For internal use only.

USERNAME - Static variable in class com.businessobjects.jsf.sdk.components.UIReportDatabaseLogon

UserRootCategory - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

Use the user's root category as the parent item.

UserRootFolder - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultRootType

Deprecated. As of version 11.

UserRootFolder - Static variable in class com.businessobjects.jsf.sdk.properties.DefaultParentType

Use the user root folder as the parent item.

V

Vertical - Static variable in class com.businessobjects.jsf.sdk.properties.RepeatDirection

Set the repeat direction to Vertical.

Vertical - Static variable in class com.businessobjects.jsf.sdk.properties.GridLines

Use vertical grid lines.

W

Weekly - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

Schedule to run once every week.

WEEKLY - Static variable in class com.businessobjects.jsf.sdk.properties.ScheduleType

A B C D E F G H I J L M N O P Q R S T U V W