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

G

Gateway - Interface in com.ebasetech.xi.api

The Gateway interface represents Gateway Server functions.

GATEWAY_AUTHENTICATION - Static variable in interface com.ebasetech.xi.services.Authentication

GatewayAuthentication - Interface in com.ebasetech.xi.api

The GatewayAuthentication is used to authenticate a Gateway Server request and using the JWE (JSON Web Encrypted) token and decode it to a JWT (JSON Web Token).

GatewayRemoteServer - Interface in com.ebasetech.xi.api

GatewayRemoteServer contains configuration information regarding "Remote" servers that the Gateway can invoke forms

GatewayRestServices - Interface in com.ebasetech.xi.api

generateAESSecretKey(byte[]) - Method in interface com.ebasetech.xi.api.KeyManager

Returns AES Secret key from the specified byte array

generateAESSecretKey(String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns AES Secret key from the specified String

generateDirectJWE(String, SecretKey) - Method in interface com.ebasetech.xi.api.JWTBuilder

Generates Direct Encryption JSON Web Encryption (JWE) token to its compact format consisting of Base64URL-encoded parts delimited by period ('.') characters.

generateHash(String, int, String) - Static method in class com.ebasetech.xi.services.EncryptionServices

Hashes a string represented by message using the PBKDF2WithHmacSHA512 algorithm and a 512 bit key.

generateHMACSecretKey(String, String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns HMAC Secret Key based on the HMAC Algorithm

generateHMACSecretKey(String, byte[]) - Method in interface com.ebasetech.xi.api.KeyManager

Returns HMAC Secret Key based on the HMAC Algorithm

generateJWSToken() - Method in interface com.ebasetech.xi.api.JWTBuilder

Serializes the JSON Web Token (JWS) to its compact format consisting of Base64URL-encoded parts delimited by period ('.') characters.

generateJWTToken() - Method in interface com.ebasetech.xi.api.JWTBuilder

Serializes the JSON Web Token (JWT) to its compact format consisting of Base64URL-encoded parts delimited by period ('.') characters.

generatePdf() - Method in interface com.ebasetech.xi.api.WebForm

Generates a PDF for the current page and displays this to the user in a popup window.

generatePdf(PdfOptions) - Method in interface com.ebasetech.xi.api.WebForm

Generates a PDF from one or more pages, with options to display to the user and save the generated file.

generateSecretKeyBytes(int) - Method in interface com.ebasetech.xi.api.KeyManager

Returns random bytes of a specified length using java.security.SecureRandom

get(String, String) - Method in interface com.ebasetech.xi.api.GatewayRestServices

Performs a REST HTTP GET call and returns a RestResponse representing the response.

get(String, String, Map<String, Object>, Map<String, Object>) - Method in interface com.ebasetech.xi.api.GatewayRestServices

Performs a REST HTTP GET call supplying any request headers and/or parameters.

get(String, String, Map<String, Object>, Map<String, Object>, RestOptions) - Method in interface com.ebasetech.xi.api.GatewayRestServices

Performs a REST HTTP GET call supplying any request headers and/or parameters.

get(String) - Static method in class com.ebasetech.xi.services.RestServices

Performs a REST HTTP GET call and returns a RestResponse representing the response.

get(String, Map<String, Object>, Map<String, Object>) - Static method in class com.ebasetech.xi.services.RestServices

Performs a REST HTTP GET call supplying any request headers and/or parameters.

get(String, Map<String, Object>, Map<String, Object>, Authentication) - Static method in class com.ebasetech.xi.services.RestServices

Performs a REST HTTP GET call supplying any request headers and/or parameters.

get(String, Map<String, Object>, Map<String, Object>, Authentication, RestOptions) - Static method in class com.ebasetech.xi.services.RestServices

Performs a REST HTTP GET call supplying any request headers and/or parameters.

getAbortMessage() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the abort message after a failure has occurred.

getAbortPage() - Method in interface com.ebasetech.xi.api.WebForm

Returns the current page after a failure has occurred, or null if no failure has occurred or there is no current page.

getAbsoluteFilePath(String) - Static method in class com.ebasetech.xi.services.FileServices

Returns an absolute file path for the specified relative or absolute file path.

getAcceptedMimeTypes() - Method in class com.ebasetech.xi.api.UploadOptions

An array of accepted MIME types.

getAccessToken() - Method in interface com.ebasetech.xi.api.OAuthTokens

Returns the value of the access token

getActivePageNumberProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Text styling properties for active (clickable) page numbers in the navigation bar.

getActiveTextStyle() - Method in interface com.ebasetech.xi.api.controls.HyperlinkProperties

Hyperlink properties that apply to the active state.

getActivityId() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.SystemTaskEnactmentDescriptor

getActivityType() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns the activity type for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getActor() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getActorId() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Answer the actor currently assigned to the task enactment

getAddressConstituentParts(String) - Static method in class com.ebasetech.xi.services.PostcodeAnywhereServices

Returns an array of address details for an address id, as provided by method PostcodeAnywhereServices.getCandidateAddresses(String).

getAddRowButtonProperties() - Method in interface com.ebasetech.xi.api.controls.TableControlAddRowProperties

Styling properties for the add row button.

getAddRowCellClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the table row containing the add row button.

getAddRowCellProperties() - Method in interface com.ebasetech.xi.api.controls.TableControlAddRowProperties

Styling properties for the table cell containing the add row button.

getAddRowCellStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the table row containing the add row button.

getAddRowClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the add row button.

getAddRowStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the add row button.

getAddRowStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the add row button.

getADGroups(String) - Static method in class com.ebasetech.xi.services.LdapServices

Returns all Active Directory group names associated with a user including nested groups, using the Active Directory tokenGroups attribute to obtain this information.

getADGroups(String, String, boolean) - Static method in class com.ebasetech.xi.services.LdapServices

Returns all Active Directory group names associated with a user including nested groups, using the Active Directory tokenGroups attribute to obtain this information.

getADGroups(String) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns all Active Directory group names associated with a user including nested groups, using the Active Directory tokenGroups attribute to obtain this information.

getADGroups(String, String, boolean) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns all Active Directory group names associated with a user including nested groups, using the Active Directory tokenGroups attribute to obtain this information.

getAgreementPartyUInfo() - Method in interface com.ebasetech.xi.api.JWEHeader

Gets the agreement PartyUInfo (apu) parameter.

getAgreementPartyVInfo() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the agreement PartyVInfo (apv) parameter.

getAlgorithm() - Method in interface com.ebasetech.xi.api.JWSHeader

Returns algorithm (alg ) used to sign the JWS, null if not specified.

getAlignment() - Method in interface com.ebasetech.xi.api.controls.PageControl

Specifies the horizontal alignment for the entire page within the browser window.

getAll() - Method in interface com.ebasetech.xi.api.controls.Control

Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.

getAllControls() - Method in interface com.ebasetech.xi.api.Page

Returns an array of all controls on the page in display order.

getAllMargin() - Method in interface com.ebasetech.xi.api.controls.MarginStyleProperties

Single margin size value used for top, bottom, left and right margin.

getAllPadding() - Method in interface com.ebasetech.xi.api.controls.PaddingStyleProperties

Single padding size value used for top, bottom, left and right padding.

getAllPages() - Method in interface com.ebasetech.xi.api.WebForm

Returns an array of Page objects containing all pages within the form.

getAllState() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Default styling properties for menu items in all states - selected, unselected, hover.

getAllState() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Styling properties that apply to all states - selected, unselected, hover.

getAllState() - Method in interface com.ebasetech.xi.api.controls.TabControl

Default styling properties for the tab header.

getAllState() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Default styling properties for all tab headers.

getAlternativeText() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties

Returns the Text object for the image alternate text.

getApi() - Method in interface com.ebasetech.xi.api.Workflow

Returns a WorkflowManagment object representing the API for the workflow server.

getAriaLabelText() - Method in interface com.ebasetech.xi.api.controls.ButtonControlProperties

Returns the Text object for the aria label text.

getAriaLabelText() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the Text object for the aria label text.

getAriaLabelText() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl

Returns the Text object for the aria label text.

getAriaLabelText() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties

Returns the Text object for the aria label text.

getAriaLabelText() - Method in interface com.ebasetech.xi.api.controls.MenuItemControl

Returns the Text object for the aria label text.

getAscenderHeight() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the height of the ascender/descender.

getAssignmentMode() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

getAttribute(String) - Method in interface com.ebasetech.xi.api.WrappedHttpSession

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

getAudience() - Method in interface com.ebasetech.xi.api.JWT

getAuthTag() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the authentication tag (tag) parameter.

getBackgroundClass() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the list of CSS classes applied to the background of the drop out menu levels.

getBackgroundColor() - Method in interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

Background color.

getBackgroundImage() - Method in interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

URL of the background image.

getBackgroundImagePosition() - Method in interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

Background image position.

getBackgroundImageRepeat() - Method in interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

Background image repeat property.

getBackgroundStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the inline CSS style applied to the background of the drop out menu levels.

getBarcodeHeight() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the barcode height for the generated barcode.

getBarcodeWideFactor() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the factor by which wide bars are broader than narrow bars.

getBaselinePosition() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the position of the baseline on the barcode.

getBaseURL() - Method in interface com.ebasetech.xi.api.GatewayRemoteServer

Returns the base URI for a specified server.

getBody() - Method in interface com.ebasetech.xi.services.RestResponse

Returns the response body as a string representation following a RestServices call

getBootstrapAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalMenuControl

Returns the alignment when a form is running with the bootstrap framework configured.

getBootstrapContainerType() - Method in interface com.ebasetech.xi.api.controls.BootstrapContainerTypeProperties

Returns the bootstrap root container type which is applied to the root div on the page when a form is running with the bootstrap framework configured.

getBootstrapSize() - Method in interface com.ebasetech.xi.api.controls.BootstrapButtonStyle

The current bootstrap size

getBootstrapState() - Method in interface com.ebasetech.xi.api.controls.BootstrapButtonStyle

The current bootstrap state

getBootstrapStyle() - Method in interface com.ebasetech.xi.api.controls.BootstrapButtonStyle

The current bootstrap style

getBorderColor() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Border color applied to all borders.

getBorderRadius() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Border radius.

getBorderStyle() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Border style applied to all borders.

getBorderWidth() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Border width applied to all four borders.

getBottomBorderWidth() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Bottom border width, overriding property borderWidth.

getBottomMargin() - Method in interface com.ebasetech.xi.api.controls.MarginStyleProperties

Bottom margin size value.

getBottomPadding() - Method in interface com.ebasetech.xi.api.controls.PaddingStyleProperties

Bottom padding size value.

getButtonImageUrl() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the URL of the image to be displayed when the buttonDisplayAsImage is set to true.

getButtonProperties() - Method in interface com.ebasetech.xi.api.controls.ButtonColumnControl

Returns the ButtonColumnProperties object representing styling properties for the button on alternate rows.

getButtonText() - Method in interface com.ebasetech.xi.api.controls.ButtonControlProperties

Returns the Text object for the button text.

getButtonText() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the Text object for the button text.

getButtonWidth() - Method in interface com.ebasetech.xi.api.controls.ButtonColumnControl

Column width.

getCalendarProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Image properties for the calendar icon of date fields.

getCalendarProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Properties for the date calendar image.

getCaller() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the caller string given to the API method that ultimately causes this audit record to be created

getCallingFormName() - Method in interface com.ebasetech.xi.api.WebForm

Returns the name of the calling form or null if no calling form exists.

getCandidateActors(WorkflowManagement.InteractiveTaskEnactmentDescriptor, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a collection of the possible actor assignments to the identified task enactment

getCandidateActors(String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a collection of the possible actor assignments to the identified task enactment

getCandidateAddresses(String) - Static method in class com.ebasetech.xi.services.PostcodeAnywhereServices

Returns an array of list entries for postCode using the PostcodeAnywhere service provider.

getCanvasHeight() - Method in interface com.ebasetech.xi.api.controls.CanvasControl

Canvas height.

getCanvasWidth() - Method in interface com.ebasetech.xi.api.controls.CanvasControl

Canvas width.

getCellBorder() - Method in interface com.ebasetech.xi.api.controls.GridControl

Border properties for each cell.

getCellHAlign() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Horizontal alignment for each control within its containing table cell.

getCellHAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Horizontal alignment for each child control within its containing table cell.

getCellHAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Horizontal alignment for each child control within its containing table cell.

getCellPadding() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Padding properties for each table cell.

getCellPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Space between adjacent table cells.

getCellSpacing() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Space between adjacent table cells.

getCellVAlign() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Vertical alignment for each control within its containing table cell.

getCellVAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Vertical alignment for each child control within its containing table cell.

getCellVAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Vertical alignment for each child control within its containing table cell.

getChecksum() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the checksum mode

getChildControls() - Method in interface com.ebasetech.xi.api.controls.ContainerControl

Returns an array of controls that are immediate children of this control.

getClaim(String) - Method in interface com.ebasetech.xi.api.JWT

Returns a claim value for a given name

getClaimArray(String) - Method in interface com.ebasetech.xi.api.JWT

Returns a claim array value for a given name

getClaimNames() - Method in interface com.ebasetech.xi.api.JWT

getClient(String) - Method in class com.ebasetech.xi.services.MongoServices

Returns an instance of MongoClient representing a connection to the MongoDB database.

getCode() - Method in interface com.ebasetech.xi.services.RestResponse

Returns the HTTP response code following a RestServices call

getCollapseBreakPoint() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the breakpoint width e.g.

getCollapsedRowHeaderStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to column headers displayed in collapsed table rows; these are table rows displayed vertically when the device viewport is smaller than the breakpoint configured for the Collapse Breakpoint property.

getCollapsedRowStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to collapsed table rows; these are table rows displayed vertically when the device viewport is smaller than the breakpoint configured for the Collapse Breakpoint property.

getColor() - Method in interface com.ebasetech.xi.api.controls.HorizontalLineControl

The line color.

getColor() - Method in interface com.ebasetech.xi.api.controls.IndividualTabStateProperties

Background color.

getColumn(String) - Method in interface com.ebasetech.xi.api.Table

Returns the specified table column or null if the column does not exist.

getColumn(String) - Method in interface com.ebasetech.xi.api.WebFormTable

Returns the specified table column or null if the column does not exist.

getColumnCellClass() - Method in interface com.ebasetech.xi.api.controls.ColumnStyleProperties

Returns the list of CSS classes configured for each table cell.

getColumnCellStyle() - Method in interface com.ebasetech.xi.api.controls.ColumnStyleProperties

Returns the inline CSS style configured for each table cell.

getColumnControl() - Method in interface com.ebasetech.xi.api.WebFormTableColumn

Returns the first Table Column Control on the current page that displays this column.

getColumnControl(Page) - Method in interface com.ebasetech.xi.api.WebFormTableColumn

Returns the first Table Column Control on the specified page that displays this column.

getColumnDataClass() - Method in interface com.ebasetech.xi.api.controls.ColumnStyleProperties

Returns the list of CSS classes configured for the content of each table cell.

getColumnDataStyle() - Method in interface com.ebasetech.xi.api.controls.ColumnStyleProperties

Returns the inline CSS style configured for the content of each table cell.

getColumnHeaderProperties() - Method in interface com.ebasetech.xi.api.controls.ColumnStyleProperties

Column header properties.

getColumnHeaderStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for column header texts.

getColumnHeadingClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to column header texts.

getColumnHeadingStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to column header texts.

getColumns() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Number of columns in each row of the layout.

getColumns() - Method in interface com.ebasetech.xi.api.Table

Returns an array of all columns in the table.

getColumns() - Method in interface com.ebasetech.xi.api.WebFormTable

Returns an array of all table columns in the table.

getColumnValueOnRow(TableColumn, int) - Method in interface com.ebasetech.xi.api.Table

Returns an Object representing the value of the table cell at the specified column and row.

getColumnWidths() - Method in interface com.ebasetech.xi.api.controls.GridControl

A comma separated list of column width percentages in the form 20%,20%,40%,20%.

getCompletions() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns a list of the completion states configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getComponent(String) - Method in interface com.ebasetech.xi.api.Components

Returns the Component object for the deployed component with prefix componentPrefix.

getComponentPrefix() - Method in interface com.ebasetech.xi.api.WebFormEventContext

Returns the component prefix when the event currently being executed forms part of a deployed component i.e.

getComponents() - Method in interface com.ebasetech.xi.api.Component

Returns the Components object that gives access to all nested sub-components available to the component.

getCompressionAlgorithm() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the compression algorithm (zip) parameter.

getConnectionTimeout() - Method in class com.ebasetech.xi.api.RestOptions

getContainingListType() - Method in interface com.ebasetech.xi.api.controls.ListLayout

The containing list type, can be either "ordered" or "unordered".

getContainingListType() - Method in interface com.ebasetech.xi.api.controls.ListPanelControl

The containing list type, can be either "ordered" or "unordered".

getContentClass() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the list of CSS classes applied to the content area containing child controls.

getContentClass() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the list of CSS classes applied to the page content.

getContentHeight() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Height of the content area.

getContentHeight() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Height of the content area.

getContentPadding() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Content padding properties - the space between the content and its border.

getContentPadding() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Padding properties for the content area - the space between the content area and its border.

getContentPanel() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Styling properties applied to tab content panels.

getContentsBackgroundProperties() - Method in interface com.ebasetech.xi.api.controls.PageControl

Background properties for the page contents.

getContentsBorderProperties() - Method in interface com.ebasetech.xi.api.controls.PageControl

Border properties for the page contents.

getContentsHeight() - Method in interface com.ebasetech.xi.api.controls.PageControl

The height of the page contents area.

getContentsTextProperties() - Method in interface com.ebasetech.xi.api.controls.PageControl

The default text properties for the page.

getContentStyle() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the inline CSS style applied to the content area containing child controls.

getContentStyle() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the inline CSS style applied to the page content.

getContentText() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Content text properties.

getContentText() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Text properties for the content area.

getContentType() - Method in interface com.ebasetech.xi.api.JWSHeader

Returns the content type (cty), null if not specified.

getContingentEnactmentId() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getContingentNodeName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getControl(String) - Method in interface com.ebasetech.xi.api.Controls

Returns the Control with name controlName.

getControl() - Method in interface com.ebasetech.xi.api.WebFormTable

Returns the first Table Control or Repeater Control on the current page that displays this table.

getControl(Page) - Method in interface com.ebasetech.xi.api.WebFormTable

Returns the first Table Control or Repeater Control on the specified page that displays this table.

getControls() - Method in interface com.ebasetech.xi.api.Component

Returns the Controls object that gives access to all controls available to the component.

getControls() - Method in interface com.ebasetech.xi.api.WebForm

Returns the Controls object that gives access to all controls available to the form.

getControlsByModifier(String) - Method in interface com.ebasetech.xi.api.Page

Returns an array of controls that have the named modifier.

getCookieValue(String) - Method in interface com.ebasetech.xi.api.Client

Returns the value of the named cookie or null if the cookie does not exist.

getCreationDate() - Method in interface com.ebasetech.xi.api.Snapshot

Returns the date the snapshot is created.

getCreationDate() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getCreationDate() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Answer the time of creation of the task enactment

getCreationDate() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Answer the time of creation of the task enactment

getCredential(String) - Method in interface com.ebasetech.xi.api.SecurityManager

Returns the credential value for the user credential identified by credentialName, or null if the credential does not exist or no user is logged on.

getCredentials() - Method in interface com.ebasetech.xi.api.SecurityManager

Returns all of the User credentials that are established by the System Logon Service when the user logs on.

getCssClass() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the list of CSS classes configured for the control.

getCurrentPage() - Method in interface com.ebasetech.xi.api.WebForm

Returns a Page object representing the current page

getCurrentPageClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for inactive pages (i.e.

getCurrentPageStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for inactive pages (i.e.

getCurrentRow() - Method in interface com.ebasetech.xi.api.Table

Returns the row number for the table's current row.

getDatabase() - Method in interface com.ebasetech.xi.api.Services

Returns the database services containing methods associated with databases.

getDatabase() - Method in class com.ebasetech.xi.api.ServicesImpl

getDatabaseConnection(String) - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns a database connection.

getDatabaseConnection(String) - Method in class com.ebasetech.xi.services.DatabaseServices

Returns a database connection.

getDatabaseType(String) - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns a string describing the database type for the database connection.

getDatabaseType(String) - Method in class com.ebasetech.xi.services.DatabaseServices

Returns a string describing the database type for the database connection.

getDataMatrixShape() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the data matrix shape.

getDate() - Method in interface com.ebasetech.xi.api.Services

Returns the date services containing methods associated with dates.

getDate() - Method in class com.ebasetech.xi.api.ServicesImpl

getDefaultTransactionTimeout() - Method in interface com.ebasetech.xi.api.TransactionManager

Returns the configured default transaction timeout value in seconds.

getDeletableCellClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the Delete Column table cells.

getDeletableCellStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the the Delete Column table cells.

getDeletableDataClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the Delete Column checkboxes.

getDeletableDataStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the the Delete Column checkboxes.

getDeletableWidth() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the width of the delete column.

getDescription() - Method in interface com.ebasetech.xi.api.GatewayRemoteServer

Returns the description for a remote server.

getDescription() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns the description configured for the interactive task represented by this ExecutionDescriptor

getDescription() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

getDescription() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

The description of the process

getDescription() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.TaskEnactmentDescriptor

Answer a friendly description of the task for which the receiver describes an enactment

getDirectory() - Method in class com.ebasetech.xi.api.UploadOptions

The directory where uploaded files will be saved.

getDirectoryInternal() - Method in class com.ebasetech.xi.api.UploadOptions

getDisplayLength() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn

Returns the size of the input box used for the form field when it is editable.

getDisplayType() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn

Returns the field's display type.

getDisplayValue(boolean) - Method in interface com.ebasetech.xi.api.Field

Returns a String representing the displayable value of the form field, optionally formatted for the user's locale.

getDisplayValue() - Method in interface com.ebasetech.xi.api.Field

Returns a String representing the displayable value of the form field, with any default formatting applied.

getDisplayValue(String, boolean) - Method in interface com.ebasetech.xi.api.FieldList

Returns the display value from the list that corresponds to the return value represented by returnValue, optionally formatted for the user's locale.

getDisplayValues(boolean) - Method in interface com.ebasetech.xi.api.FieldList

Returns an array of display values for the list, optionally formatted for the user's locale.

getDocument(String) - Method in interface com.ebasetech.xi.api.XmlResourceBase

Returns Document object from the resource based on a given name

getDueDate() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getEditorBackground() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Background properties for editor table cells - used when displaying Field Controls.

getEditorBackground() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Background properties for Field Control editor table cells, overriding the corresponding background properties from the parent FieldLayout.

getEditorCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the <div> tag that wraps the editor.

getEditorCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the list of CSS classes configured for editor table cells when displaying a Field Control.

getEditorCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

CSS classes configured for editor table cells when displaying a Field Control, overriding the editor layout cell CSS classes from the parent FieldLayout.

getEditorCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the <div> tag that wraps the editor.

getEditorCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the inline CSS style to be applied to editor table cells when displaying a Field Control.

getEditorCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Inline CSS style configured for editor table cells when displaying a Field Control, overriding the editor layout cell inline CSS style from the parent FieldLayout.

getEditorClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the <input> tag when the control is not display only.

getEditorHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Horizontal alignment of editor table cells - this is used when displaying Field Controls.

getEditorHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Horizontal alignment of editor table cells when displaying Field Controls, overriding the corresponding horizontal alignment property from the parent FieldLayout.

getEditorInputBackgroundProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Background properties for the data content of each table cell.

getEditorInputBorderProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Border properties for the data content of each table cell.

getEditorInputProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Properties applied to the editor part of the field.

getEditorInputTextProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Text properties for the data content of each table cell.

getEditorPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Padding properties for editor table cells - used when displaying Field Controls.

getEditorPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Padding properties for editor table cells when displaying Field Controls, overriding the corresponding padding properties from the parent FieldLayout.

getEditorStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the <input> tag when the control is not display only.

getEditorVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Vertical alignment of editor table cells - this is used when displaying Field Controls.

getEditorVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Vertical alignment of editor table cells when displaying Field Controls, overriding the corresponding vertical alignment property from the parent FieldLayout.

getEditorWidth() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Width of editor table cells - this is used when displaying Field Controls.

getElementName() - Method in interface com.ebasetech.xi.api.Element

Returns the element name

getElementType() - Method in interface com.ebasetech.xi.api.Element

Returns the element type

getEncryption() - Method in interface com.ebasetech.xi.api.Services

Returns the encryption services containing methods associated with Ebase encryption.

getEncryption() - Method in class com.ebasetech.xi.api.ServicesImpl

getEncryptionMethod() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the encryption method

getEndpointPath() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns the name of the Enpoint path used to invoke the RESTful web service.

getErrorCorrectionLevel() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the error correction of the barcode

getErrorMessageStyle() - Method in interface com.ebasetech.xi.api.controls.MessageProperties

Returns the MessageStyleProperties object representing error message styling properties.

getErrorMsgClass() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.

getErrorMsgStyle() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.

getEscalatedEnactmentId() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getEscalatedTaskName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.EscalatorEnactmentDescriptor

getEventDescription() - Method in interface com.ebasetech.xi.api.EventContext

Returns a description of the event currently being executed.

getEventId() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.PauseEnactmentDescriptor

Answer the event id of the associated pause node

getExpiration() - Method in interface com.ebasetech.xi.api.JWT

getExpiryDate() - Method in interface com.ebasetech.xi.api.Snapshot

Returns the expiry date used to create the snapshot or null if the snapshot never expires.

getExtraLargeWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapWidthProperties

Gets the width for the large breakpoint.

getExtraSmallWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapWidthProperties

Gets the width for the extra-small breakpoint.

getFailedNodes(String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a list of FallibleEnactmentDescriptors, each of which describes a particular failed system task.

getFailureCause() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

getField() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the field displayed by this Field Control.

getField(String) - Method in interface com.ebasetech.xi.api.Fields

Returns the Field with name fieldName.

getFieldClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the <div> tag that wraps all parts of the field.

getFieldControl() - Method in interface com.ebasetech.xi.api.WebFormField

Returns the first Field Control on the current page that displays this field.

getFieldControl(Page) - Method in interface com.ebasetech.xi.api.WebFormField

Returns the first Field Control on the specified page that displays this field.

getFieldControl() - Method in interface com.ebasetech.xi.api.WebFormTableColumn

Returns the first Field Control on the current page that displays this column.

getFieldControl(Page) - Method in interface com.ebasetech.xi.api.WebFormTableColumn

Returns the first Table Column Control on the specified page that displays this column.

getFieldEditorClass() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Returns the list of CSS classes to be applied to the editor portion of each field.

getFieldInfoClass() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Returns the list of CSS classes to be applied to the info portion of each field.

getFieldLabelClass() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Returns the list of CSS classes to be applied to the label portion of each field.

getFields() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the Fields object that gives access to all fields available to the form.

getFields() - Method in interface com.ebasetech.xi.api.Component

Returns the Fields object that gives access to all fields available to the component.

getFields() - Method in interface com.ebasetech.xi.api.Snapshot

Returns a map of snapshot fields that contain key value pairs (additional information for a snapshot) or null if no additional information exists.

getFields() - Method in class com.ebasetech.xi.api.SnapshotQuery

Returns a list of snapshot fields used to filter a snapshot.

getFieldStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the <div> tag that wraps all parts of the field.

getFile() - Method in interface com.ebasetech.xi.api.controls.IncludeControl

The URL of the JSP/HTML file relative to the document root of the Ebase web application.

getFile() - Method in interface com.ebasetech.xi.api.Services

Returns the file services containing methods associated with system files.

getFile() - Method in class com.ebasetech.xi.api.ServicesImpl

getFilePath() - Method in class com.ebasetech.xi.api.PdfOptions

Returns the file path where the PDF will be saved.

getFileTypes() - Method in class com.ebasetech.xi.api.UploadOptions

An array of allowable case insensitive file types that can be uploaded.

getFilteredAuditRecords(String, String, String, Integer, String, String, String, Date, Date, int, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answer a list of Audit objects which meet the supplied filter criteria.

getFilteredJobs(String, String, String, String, Boolean, Date, Date, Date, Date, Map<String, String>, boolean, boolean, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answer a list of implementations of the JobDescriptor interface, each of which describes a current job in the system that meets the supplied filter criteria

getFilteredPendingEscalators(String, String, String, String, String, String, Date, Date, boolean, boolean, boolean, boolean, boolean, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answer a list of implementations of the EscalatorEnactmentDescriptors interface, each of which describes a current extant escalator in the system that meets the supplied filter criteria.

getFilteredTasks(String, String, String, String, String, String, boolean, boolean, String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Finds out the extant interactive node enactments which meet the supplied filter criteria.

getFilterExpression() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns an FPL conditional expression that limits which table rows are displayed or null if no expression is configured.

getFinish() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Styling properties for the finish button.

getFinishClass() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the list of CSS classes applied to the finish button.

getFinishImageUrl() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the URL of the image when property finishDisplayAsImage is true.

getFinishStyle() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the inline CSS style applied to the finish button.

getFirstDisplayRow() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the row number of the first displayable row - equivalent to scroll to top.

getFirstLevel() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

First level menu properties - containing properties for just the first level menu items.

getFirstPage() - Method in interface com.ebasetech.xi.api.WebForm

Returns the Page object configured as the form's first page.

getFontName() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the font name of the human readable part

getFontSize() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the font size of the human readable part

getFormHeaderProperties() - Method in interface com.ebasetech.xi.api.controls.PageControl

Form header properties.

getFormPanelWidth() - Method in interface com.ebasetech.xi.api.controls.PageControl

Form panel width.

getFormSession() - Method in interface com.ebasetech.xi.api.Client

Returns a FormSession object which represents a single browser window, usually a separate tab within the clilent browser.

getFormSessionAttribute(String) - Method in interface com.ebasetech.xi.api.FormSession

Returns the value of the form session attribute named by attributeName.

getFormSessionId() - Method in interface com.ebasetech.xi.api.FormSession

Returns the Ebase form session identifier.

getFourthLevel() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Fourth level menu properties - containing properties for just the fourth level menu items.

getFourthLevelBackgroundClass() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the list of CSS classes applied to the background of the fourth menu level.

getFourthLevelBackgroundStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the inline CSS style applied to the background of the fourth menu level.

getFourthLevelClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to fourth level non-leaf unselected menu items.

getFourthLevelHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level non-leaf unselected menu items when the mouse is hovered over the item.

getFourthLevelHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of fourth level non-leaf unselected menu items when the mouse is hovered over the item.

getFourthLevelLeafClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to fourth level leaf unselected menu items.

getFourthLevelLeafHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level leaf unselected menu items when the mouse is hovered over the item.

getFourthLevelLeafHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of fourth level leaf unselected menu items when the mouse is hovered over the item.

getFourthLevelLeafSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level leaf selected menu items.

getFourthLevelLeafSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level leaf selected menu items.

getFourthLevelLeafSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of fourth level leaf selected menu items.

getFourthLevelLeafSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of fourth level leaf selected menu items.

getFourthLevelLeafStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level leaf unselected menu items.

getFourthLevelLeafTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of fourth level leaf unselected menu items.

getFourthLevelLeafTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level leaf selected menu items.

getFourthLevelSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to fourth level non-leaf selected menu items.

getFourthLevelSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level non-leaf selected menu items.

getFourthLevelSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of fourth level non-leaf selected menu items.

getFourthLevelSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level non-leaf selected menu items.

getFourthLevelStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to fourth level non-leaf unselected menu items.

getFourthLevelTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of fourth level non-leaf unselected menu items.

getFourthLevelTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of fourth level non-leaf unselected menu items.

getFullWidthHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Horizontal alignment of table cells when displaying controls other than a Field Control.

getFullWidthHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Horizontal alignment of table cells when displaying controls other than a Field Control, overriding the corresponding horizontal alignment property from the parent FieldLayout.

getFullWidthPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Padding properties when displaying controls other than a Field Control.

getFullWidthPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Padding properties when displaying controls other than a Field Control, overriding the corresponding padding properties from the parent FieldLayout.

getFullWidthVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Vertical alignment of table cells when displaying controls other than a Field Control.

getFullWidthVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Vertical alignment of table cells when displaying controls other than a Field Control, overriding the corresponding vertical alignment property from the parent FieldLayout.

getGapAfterEditor() - Method in interface com.ebasetech.xi.api.controls.FieldControl

The gap after the field editor.

getGapAfterLabel() - Method in interface com.ebasetech.xi.api.controls.FieldControl

The gap after the field label.

getGapBeforeInfo() - Method in interface com.ebasetech.xi.api.controls.FieldControl

The gap before the field help.

getGapBetweenItems() - Method in interface com.ebasetech.xi.api.controls.HorizontalMenuControl

The separation between menu items in the top level menu.

getGatewayRedirectURL() - Method in interface com.ebasetech.xi.api.GatewayAuthentication

Returns the originating URL of the Gateway Portal from the request.

getGatewayRequestToken() - Method in interface com.ebasetech.xi.api.GatewayAuthentication

Returns the JWE (JSON Web Encrypted) token embedded in the request.

getGlobal() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Default styling properties for all navigation buttons within the panel.

getGlobalLevel() - Method in interface com.ebasetech.xi.api.controls.HorizontalMenuControl

Global menu properties - containing properties for the entire menu plus menu item properties that apply to both the top level and drop down levels.

getGlobalLevel() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Global menu properties - containing properties for the entire menu plus menu item properties that apply to both the top level and drop down levels.

getGridClass() - Method in interface com.ebasetech.xi.api.controls.GridControl

Returns the list of CSS classes applied to the table grid.

getGridStyle() - Method in interface com.ebasetech.xi.api.controls.GridControl

Returns the inline CSS style applied to the table grid.

getGroupHeaderText() - Method in interface com.ebasetech.xi.api.controls.GroupPanelControl

Returns the Text object for the header text.

getGroupInfoText() - Method in interface com.ebasetech.xi.api.controls.GroupPanelControl

Returns the Text object for the information text.

getGroupTrailerText() - Method in interface com.ebasetech.xi.api.controls.GroupPanelControl

Returns the Text object for the trailer text.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.AddRowButtonProperties

Text horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.CellStyleProperties

Horizontal alignment of table cell content.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Horizontal alignment for all child controls of the container as a whole e.g.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.ColumnLayoutCell

Horizontal alignment, overriding the layout cell horizontal alignment from the parent ColumnLayout.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.FormHeaderProperties

Horizontal alignment for the form header text.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.GroupAndPageTextProperties

Horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Horizontal alignment for all child content - all child controls are aligned as a single block.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayoutCell

Horizontal alignment, overriding the layout cell horizontal alignment from the parent HorizontalBoxLayout.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.InfoProperties

Horizontal alignment of the field help text when it is positioned underneath the field editor (see FieldControl.setHelpPos(int).

getHAlign() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Horizontal alignment of the content within each menu item.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.MessageStyleProperties

Horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.NavigationRowProperties

Horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.TabAllStateProperties

Horizontal alignment for the text within a tab header - this is only effective if a tab width has been specified.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.TableAddRowCellProperties

Horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.TableCellStyleProperties

Horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.TableColumnHeaderProperties

Text horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.TableControlTextProperties

Text horizontal alignment.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.TitleBarProperties

Horizontal alignment for the title bar - both the title text and any optional image are aligned together as a block.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Horizontal alignment for all child content - all child controls are aligned as a single block.

getHAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayoutCell

Horizontal alignment, overriding the layout cell horizontal alignment from the parent VerticalBoxLayout.

getHeader() - Method in interface com.ebasetech.xi.api.JWE

Returns the header for the JWS

getHeader() - Method in interface com.ebasetech.xi.api.JWS

Return the JWS header for the JWS

getHeader(String) - Method in interface com.ebasetech.xi.api.JWSHeader

Returns the header value for a given name

getHeaderClass() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the list of CSS classes applied to the header text.

getHeaderClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the table header text.

getHeaderProperties() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Header text properties.

getHeaders() - Method in interface com.ebasetech.xi.services.RestResponse

Returns the response headers as key-->value string pairs following a RestServices call The key-->value pairs are returned as a JavaScript object.

getHeaderStyle() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the inline CSS style applied to the header text.

getHeaderStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the table header text.

getHeaderStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the table header text.

getHeaderText() - Method in interface com.ebasetech.xi.api.controls.ButtonColumnControl

Returns the Text object for the column header text.

getHeaderText() - Method in interface com.ebasetech.xi.api.controls.ImageColumnControl

Returns the Text object for the column header text.

getHeight() - Method in interface com.ebasetech.xi.api.controls.BasicBlockControl

Panel height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.BootstrapColumnControl

Column height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.BootstrapRowControl

Row height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.GridCellControl

Grid cell height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.GridControl

Grid Control height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties

Window height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.SpacerControl

Spacer height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.TableSortProperties

Sort icon height.

getHeight() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Height of the Tab Set Control.

getHelpButImage() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the URL of the clickable image used to display the help text in a popup window.

getHelpCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the list of CSS classes configured for help table cells when displaying a Field Control.

getHelpCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

CSS classes configured for help table cells when displaying a Field Control, overriding the help layout cell CSS classes from the parent FieldLayout.

getHelpCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the inline CSS style to be applied to help table cells when displaying a Field Control.

getHelpCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Inline CSS style configured for help table cells when displaying a Field Control, overriding the help layout cell inline CSS style from the parent FieldLayout.

getHelpClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the help text.

getHelpPos() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the position of the help text.

getHelpStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the help text.

getHelpText() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn

Returns the help Text for the form field for the current language.

getHelpWindowProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the properties passed to the Javascript window.open() statement used to create the popup window, overriding any properties configured using FieldControl.getInfoProperties().

getHorizontalAlignment() - Method in interface com.ebasetech.xi.api.controls.BootstrapRowControl

How the row is horizontally aligning all immediate child columns

getHoverState() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Styling properties applied to menu items when the mouse is hovered over a tab.

getHoverState() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Styling properties applied to the menu item when the mouse is hovered over the menu item.

getHoverState() - Method in interface com.ebasetech.xi.api.controls.TabControl

Styling properties applied to the tab header when the mouse is hovered over a tab.

getHoverState() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Styling properties applied to tab headers when the mouse is hovered over a tab.

getHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to drop-down non-leaf unselected menu items when the mouse is hovered over the item.

getHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.HyperlinkProperties

Hyperlink properties that apply to the hover state.

getHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of drop-down non-leaf unselected menu items when the mouse is hovered over the item.

getHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the inline CSS style applied to tab headers when the mouse is hovered over a tab..

getHref() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl

The URL of the hyperlink when property useExternalUrl is true.

getHtmlText() - Method in interface com.ebasetech.xi.api.controls.HTMLControl

Returns the Text object for the text.

getHttpSession() - Method in interface com.ebasetech.xi.api.Client

Returns the HttpSession object representing the client browser session.

getHyperlinkProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Hyperlink properties that apply when the field value should be displayed as a hyperlink (property hyperlink is set to true).

getHyperlinkTarget() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties

Returns the target window id or frame id in which the hyperlink URL is displayed.

getHyperlinkURL() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties

Returns the hyperlink URL activated when the displayAsHyperlink property is set to true.

getIdentifier() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer a unique string handle for this descriptor

getIdentifier() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Answer a unique string handle for this descriptor

getIdentifier() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Answer a unique string handle for this descriptor

getIdToken() - Method in interface com.ebasetech.xi.api.OAuthTokens

Returns the value of the id token

getIEVersion() - Method in interface com.ebasetech.xi.api.Client

Returns the MS Internet Explorer version.

getImageAltText() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Returns the Text object for the menu item image alternate text.

getImageAltText() - Method in interface com.ebasetech.xi.api.controls.TabControl

Returns the Text object for the tab header image alternate text.

getImageAltText() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the Text object for the title bar image alternatetext.

getImageClass() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Returns the list of CSS classes applied to the menu item image.

getImageClass() - Method in interface com.ebasetech.xi.api.controls.TabControl

Returns the list of CSS classes applied to the tab header image.

getImageClass() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the list of CSS classes applied to the title bar image.

getImageHeight() - Method in interface com.ebasetech.xi.api.controls.ImageStyleProperties

Image height.

getImageMouseOverText() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Returns the Text object for the menu item image mouse over text.

getImageMouseOverText() - Method in interface com.ebasetech.xi.api.controls.TabControl

Returns the Text object for the tab header image mouse over text.

getImageMouseOverText() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the Text object for the title bar image mouse over text.

getImagePosition() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

The position of the optional image relative to the menu item text.

getImagePosition() - Method in interface com.ebasetech.xi.api.controls.TabControl

The position of the optional image relative to the tab header text.

getImagePosition() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

The position of the optional image relative to the text.

getImageProperties() - Method in interface com.ebasetech.xi.api.controls.ImageColumnControl

Image properties

getImageProperties() - Method in interface com.ebasetech.xi.api.controls.InfoProperties

Text properties for the help text.

getImageProperties() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Styling properties applied to optional menu item image.

getImageProperties() - Method in interface com.ebasetech.xi.api.controls.TabControl

Styling properties applied to optional tab header image.

getImageProperties() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Styling properties for the optional image in the title bar.

getImageResolution() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the image resolution (dots per inch)

getImageStyle() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Returns the inline CSS style applied to the menu item image.

getImageStyle() - Method in interface com.ebasetech.xi.api.controls.TabControl

Returns the inline CSS style applied to the tab header image.

getImageStyle() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the inline CSS style applied to the title bar image.

getImageUrl() - Method in interface com.ebasetech.xi.api.controls.EbaseButtonControlProperties

Returns the URL of the image when property displayAsImage is true.

getImageURL() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties

Returns the URL of the image to be displayed.

getImageURL() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Returns the URL of the optional image to be displayed on the menu item.

getImageURL() - Method in interface com.ebasetech.xi.api.controls.TabControl

Returns the URL of the optional image to be displayed on the tab header.

getImageURL() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the URL of the title bar image.

getImageWidth() - Method in interface com.ebasetech.xi.api.controls.ImageStyleProperties

Image width.

getInactiveNavigationClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for inactive (not clickable) scroll icons/texts in the navigation bar.

getInactiveNavigationStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for inactive (not clickable) scroll icons/texts in the navigation bar.

getInactivePageNumberProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Text styling properties for inactive (not clickable) page numbers in the navigation bar.

getInactiveScrollDownIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the inactive (not clickable) scroll down icon in the navigation bar.

getInactiveScrollToBottomIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the inactive (not clickable) scroll to bottom icon in the navigation bar.

getInactiveScrollToTopIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the inactive (not clickable) scroll to top icon in the navigation bar.

getInactiveScrollUpIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the inactive (not clickable) scroll up icon in the navigation bar.

getIndent() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuLevelProperties

The amount by which all menu items at this level are indented.

getInfoBackground() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Background properties for help table cells - used when displaying Field Controls.

getInfoBackground() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Background properties for Field Control help table cells, overriding the corresponding background properties from the parent FieldLayout.

getInfoClass() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the list of CSS classes applied to the information text.

getInfoClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the table information text.

getInfoHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Horizontal alignment of help table cells - this is used when displaying Field Controls.

getInfoHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Horizontal alignment of help table cells when displaying Field Controls, overriding the corresponding horizontal alignment property from the parent FieldLayout.

getInfoMessageStyle() - Method in interface com.ebasetech.xi.api.controls.MessageProperties

Returns the MessageStyleProperties object representing info message styling properties.

getInfoMsgClass() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.

getInfoMsgStyle() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.

getInfoPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Padding properties for help table cells - used when displaying Field Controls.

getInfoPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Padding properties for help table cells when displaying Field Controls, overriding the corresponding padding properties from the parent FieldLayout.

getInfoPrefixClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for the navigation bar prefix text.

getInfoPrefixStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for the navigation bar prefix text.

getInfoProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Text properties for the label text.

getInfoProperties() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Information text properties.

getInformationStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the table information text.

getInfoStyle() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the inline CSS style applied to the information text.

getInfoStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the table information text.

getInfoVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Vertical alignment of help table cells - this is used when displaying Field Controls.

getInfoVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Vertical alignment of help table cells when displaying Field Controls, overriding the corresponding vertical alignment property from the parent FieldLayout.

getInfoWidth() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Width of help table cells - this is used when displaying Field Controls.

getInParameters() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns a map of the input parameters and their values configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getInterCharGap() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the width between encoded characters.

getIssuedAt() - Method in interface com.ebasetech.xi.api.JWT

getIssuer() - Method in interface com.ebasetech.xi.api.JWT

getItemBorder() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Border properties for each menu item.

getItemClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to drop-down non-leaf unselected menu items.

getItemName() - Method in interface com.ebasetech.xi.api.controls.MenuItemControl

The name that uniquely identifies each menu item within a menu.

getItemName() - Method in interface com.ebasetech.xi.api.controls.TabControl

The name that uniquely identifies each tab item within a tab set.

getItemPadding() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Padding properties for each menu item.

getItems() - Method in interface com.ebasetech.xi.api.FieldList

Returns an iterator that can be used to traverse all list items

getItemStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to drop-down non-leaf unselected menu items.

getItemWidth() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

The width of all menu items.

getIV() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the initialization vector (iv) parameter.

getIvImageURL() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the URL of the image to be displayed when Javascript is disabled and immediate validation is simulated using an image to be clicked by the user (displayIvAsImage is set to true).

getJobDescriptor() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Answer the job descriptor for this task

getJobs(String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answer the list of all currently executing Jobs, each described by a JobDescriptor.

getJobSequence() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the sequence number of the job associated with an audir record

getJobSequence() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer the sequence number of the job for the associated enactment

getJobsForOwner(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answer a list of implementations of the JobDescriptor interface, each of which describes a current job in the system that's owned by the named owner

getJSPBottom() - Method in interface com.ebasetech.xi.api.controls.PageControl

The URL of the bottom JSP relative to the document root of the Ebase web application.

getJSPLeft() - Method in interface com.ebasetech.xi.api.controls.PageControl

The URL of the left JSP relative to the document root of the Ebase web application.

getJSPLeftWidth() - Method in interface com.ebasetech.xi.api.controls.PageControl

Left JSP width.

getJSPRight() - Method in interface com.ebasetech.xi.api.controls.PageControl

The URL of the right JSP relative to the document root of the Ebase web application.

getJSPRightWidth() - Method in interface com.ebasetech.xi.api.controls.PageControl

Right JSP width.

getJSPTop() - Method in interface com.ebasetech.xi.api.controls.PageControl

The URL of the top JSP relative to the document root of the Ebase web application.

getJWKURL() - Method in interface com.ebasetech.xi.api.JWSHeader

Returns the JSON Web Key (JWK) URL

getJwtBuilder() - Method in interface com.ebasetech.xi.api.JWTManager

Returns a JWT builder to build a JWT (JSON Web Token)

getJWTId() - Method in interface com.ebasetech.xi.api.JWT

getJWToken() - Method in interface com.ebasetech.xi.api.OAuthTokens

Returns the parsed JWT from the ID user token.

getKeyFromKeystore(String, String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns Key from the system key store for a given alias name and password.

getKId() - Method in interface com.ebasetech.xi.api.JWSHeader

Returns the kid (kid), null if not specified.

getLabelBackground() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Background properties for label table cells - used when displaying Field Controls.

getLabelBackground() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Background properties for Field Control label table cells, overriding the corresponding background properties from the parent FieldLayout.

getLabelCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the list of CSS classes configured for label table cells when displaying a Field Control, or applied to the table cells containing other control types.

getLabelCellClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

List of CSS classes configured for label table cells when displaying a Field Control or applied to the table cells containing other control types, overriding the corresponding label layout cell CSS classes from the parent FieldLayout.

getLabelCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the inline CSS style to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types.

getLabelCellStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Inline CSS style configured for label table cells when displaying a Field Control or applied to the table cells containing other control types, overriding the label layout cell inline CSS style from the parent FieldLayout.

getLabelClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the <div> tag that wraps the label text.

getLabelElementClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the <label> tag that contains the label text.

getLabelElementStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the <label> tag that contains the label text.

getLabelExtraLargeWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Gets the label width string for extra small viewport sizes (portrait phones).

getLabelExtraSmallWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Gets the label width string for extra small viewport sizes (portrait phones).

getLabelHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Horizontal alignment of label table cells - this is used when displaying Field Controls.

getLabelHAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Horizontal alignment of label table cells when displaying Field Controls, overriding the corresponding horizontal alignment property from the parent FieldLayout.

getLabelLargeWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Gets the label width string for extra large viewport sizes (large desktops).

getLabelMediumWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Gets the label width string for medium viewport sizes (tablets).

getLabelPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Padding properties for label table cells - used when displaying Field Controls.

getLabelPadding() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Padding properties for label table cells when displaying Field Controls, overriding the corresponding padding properties from the parent FieldLayout.

getLabelProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Text properties for the label text.

getLabelSmallWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Gets the label width string for small viewport sizes (landscape phones).

getLabelStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the <div> tag that wraps the label text.

getLabelText() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn

Returns the label Text for the form field for the current language.

getLabelText() - Method in interface com.ebasetech.xi.api.WebFormTableColumn

Returns the column header Text for the column for the current language.

getLabelVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Vertical alignment of label table cells - this is used when displaying Field Controls.

getLabelVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayoutCell

Vertical alignment of label table cells when displaying Field Controls, overriding the corresponding vertical alignment property from the parent FieldLayout.

getLabelWidth() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Width of label table cells - this is used when displaying Field Controls.

getLanguage() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the language code for the user session.

getLargeWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapWidthProperties

Gets the width for the large breakpoint.

getLayout() - Method in interface com.ebasetech.xi.api.controls.LayoutControl

Returns the Layout object configured for the container control or null if no layout is configured.

getLayoutCell() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Returns the list of CSS classes applied to each table cell within the layout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.ColumnLayoutCell

Layout cell CSS classes, overriding the layout cell CSS classes from the parent ColumnLayout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Returns the list of CSS classes configured for each cell of the HTML table used to provide the layout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayoutCell

Layout cell CSS classes, overriding the layout cell CSS classes from the parent HorizontalBoxLayout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.ListLayout

Returns the list of CSS classes configured for the containing ordered or unordered list tag of the layout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.ListLayoutCell

Layout cell CSS classes, overriding the layout cell CSS classes from the parent VerticalBoxLayout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Returns the list of CSS classes configured for each cell of the HTML table used to provide the layout.

getLayoutClass() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayoutCell

Layout cell CSS classes, overriding the layout cell CSS classes from the parent VerticalBoxLayout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Returns the inline CSS style applied to each table cell within the layout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.ColumnLayoutCell

Layout cell inline CSS style, overriding the layout cell CSS style from the parent ColumnLayout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Returns the inline CSS style configured for each cell of the HTML table used to provide the layout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayoutCell

Layout cell inline CSS style, overriding the layout cell CSS style from the parent HorizontalBoxLayout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.ListLayout

Returns the inline CSS style configured for the containing ordered or unordered list tag of the layout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.ListLayoutCell

Layout cell inline CSS style, overriding the layout cell CSS style from the parent VerticalBoxLayout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Returns the inline CSS style configured for each cell of the HTML table used to provide the layout.

getLayoutStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayoutCell

Layout cell inline CSS style, overriding the layout cell CSS style from the parent VerticalBoxLayout.

getLayoutType() - Method in interface com.ebasetech.xi.api.controls.LayoutControl

Returns a String representing the layout type for the container.

getLdap() - Method in interface com.ebasetech.xi.api.Services

Returns the LDAP services containing methods that provide authentication and search methods against an LDAP Registry.

getLdap() - Method in class com.ebasetech.xi.api.ServicesImpl

getLdapContext() - Static method in class com.ebasetech.xi.services.LdapServices

Returns an javax.naming.directory.InitialDirContext object that can be used for Ldap queries.

getLdapContext(Map) - Static method in class com.ebasetech.xi.services.LdapServices

Returns an javax.naming.directory.InitialDirContext object using the supplied properties.

getLdapContext() - Static method in class com.ebasetech.xi.services.LdapServices2

Returns an javax.naming.directory.InitialDirContext object that can be used for Ldap queries.

getLdapContext(Map) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns an javax.naming.directory.InitialDirContext object using the supplied properties.

getLeafClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to drop-down leaf unselected menu items.

getLeafHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to drop-down leaf unselected menu items when the mouse is hovered over the item.

getLeafHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of drop-down leaf unselected menu items when the mouse is hovered over the item.

getLeafSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to drop-down leaf selected menu items.

getLeafSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to drop-down leaf selected menu items.

getLeafSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of drop-down leaf selected menu items.

getLeafSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of drop-down leaf selected menu items.

getLeafStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to drop-down leaf unselected menu items.

getLeafTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of drop-down leaf unselected menu items.

getLeafTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of drop-down leaf unselected menu items.

getLeftBorderWidth() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Left border width, overriding property borderWidth.

getLeftHoverTabImage() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

URL of the image used for the top left corner of all tab headers when the mouse is hovered over a tab.

getLeftMargin() - Method in interface com.ebasetech.xi.api.controls.MarginStyleProperties

Left margin size value.

getLeftPadding() - Method in interface com.ebasetech.xi.api.controls.PaddingStyleProperties

Left padding size value.

getLeftPosition() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties

The x position of the window's top-left corner.

getLeftSelectedTabImage() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

URL of the image used for the top left corner of all tab headers when selected.

getLeftTabImage() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

URL of the image used for the top left corner of all tab headers when not selected.

getLevel() - Method in interface com.ebasetech.xi.api.workflow.Audit

Ge the level of this record

getLevelBackground() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuLevelProperties

Background properties for the menu level.

getLevelPadding() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuLevelProperties

Padding properties for the menu level.

getLiClass() - Method in interface com.ebasetech.xi.api.controls.ListLayout

Returns the list of CSS classes configured for the containing ordered or unordered list tag of the layout.

getLineHeight() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

Line height.

getLinkedTextStyle() - Method in interface com.ebasetech.xi.api.controls.HyperlinkProperties

Hyperlink properties that apply to the linked state.

getList() - Method in interface com.ebasetech.xi.api.controls.ListControl

Returns the list associated with this control or null if no list exists.

getList() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn

Returns the list associated with the form field or null if no list exists.

getListStyleImage() - Method in interface com.ebasetech.xi.api.controls.ListLayout

URL of the list item marker image.

getListStyleImage() - Method in interface com.ebasetech.xi.api.controls.ListPanelControl

URL of the list item marker image.

getListStylePosition() - Method in interface com.ebasetech.xi.api.controls.ListLayout

The list style position.

getListStylePosition() - Method in interface com.ebasetech.xi.api.controls.ListPanelControl

The list style position.

getListStyleType() - Method in interface com.ebasetech.xi.api.controls.ListLayout

The list style type.

getListStyleType() - Method in interface com.ebasetech.xi.api.controls.ListPanelControl

The list style type.

getListValue() - Method in interface com.ebasetech.xi.api.ListItemIterator

Returns the value of the current list item.

getLiStyle() - Method in interface com.ebasetech.xi.api.controls.ListLayout

Returns the inline CSS style configured for the containing ordered or unordered list tag of the layout.

getLocalUrlBase() - Static method in class com.ebasetech.xi.services.RestServices

Returns a base URL to invoke a RESTful service on this server using localhost i.e.

getLockManager() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the lock manager object that supports locking/unlocking of in memory objects

getLogged() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the epoch that relates to the receiver's creation time

getMaxCols() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the maximum number of columns of the barcode

getMaxDisplayLength() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn

Returns the maximum number of characters that can be entered by the user for the form field.

getMaxFileSize() - Method in class com.ebasetech.xi.api.UploadOptions

The maximum size of file that can be uploaded.

getMaxFileSizeInternal() - Method in class com.ebasetech.xi.api.UploadOptions

getMaxNumberOfResultPages() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the maximum number of page numbers included in the navigation bar when property includePageNumbers is true.

getMaxRows() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the maximum number of rows of the barcode

getMediumWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapWidthProperties

Gets the width for the medium breakpoint.

getMessage() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the text for the barcode.

getMessage() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the message in the audit record

getMessagePosition() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the position of the message text of the barcode.

getMethod() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns the HTTP Method e.g POST, GET etc..

getMinCols() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the minimum number of columns of the barcode

getMinRows() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the minimum number of rows of the barcode

getModificationDate() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Answer the time of most recent modification of the task enactment

getModificationDate() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Answer the time of most recent modification of the task enactment

getModuleWidth() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the width for the generated barcode.

getMongoDB() - Method in class com.ebasetech.xi.services.DatabaseServices

getMouseOverText() - Method in interface com.ebasetech.xi.api.controls.ButtonControlProperties

Returns the Text object for the mouse over text.

getMouseOverText() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties

Returns the Text object for the mouse over text.

getName() - Method in interface com.ebasetech.xi.api.controls.MenuControl

The item name that uniquely identifies the shared menu and allows other Menu Controls to share the same menu state.

getName() - Method in interface com.ebasetech.xi.api.controls.MenuItemControl

getNavigationAlignBottom() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the alignment of the navigation bar relative to the table when the bar is displayed below the table.

getNavigationAlignTop() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the alignment of the navigation bar relative to the table when the bar is displayed above the table.

getNavigationBarClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for the <div> tag containing the entire navigation bar.

getNavigationBarStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for the <div> tag containing the entire navigation bar.

getNavigationClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for active (clickable) scroll icons/texts in the navigation bar.

getNavigationDisplay() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the position of the navigation bar.

getNavigationStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for active (clickable) scroll icons/texts in the navigation bar.

getNavigationStyleProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Navigation bar styling properties

getNext() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Styling properties for the next page button.

getNextClass() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the list of CSS classes applied to the next page button.

getNextImageUrl() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the URL of the image when property nextDisplayAsImage is true.

getNextPage() - Method in interface com.ebasetech.xi.api.Page

Returns the Page object for the next page or null if no next page exists.

getNextPage() - Method in interface com.ebasetech.xi.api.WebForm

Returns a Page object representing the next page or null if no next page is configured.

getNextSiblingControl() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the control that appears after this control within the same parent, or null if no such control exists.

getNextStyle() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the inline CSS style applied to the next page button.

getNodeEnactmentSequence() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the sequence number of the node enactment associated with an audir record

getNodeEnactmentSequence() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer the sequence number of the associated enactment

getNodeName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer the textual name of the task object of which that the associated enactment is

getNormalState() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Styling properties applied to unselected menu items.

getNotBefore() - Method in interface com.ebasetech.xi.api.JWT

getNumberOfLevels() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

The number of menu levels that will expand vertically.

getNumVisibleRows() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the number of rows in a scroll set i.e.

getOauth() - Method in interface com.ebasetech.xi.api.ServicesSecurity

Returns the OAuth object required for OAth authentication.

getOAuthId() - Method in interface com.ebasetech.xi.api.OAuthTokens

getOpener() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

resource who opened this job

getOrientation() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns image orientation on the page.

getOutParameters() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns a list of the output parameters configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getOwner() - Method in interface com.ebasetech.xi.api.EventContext

Returns the object that owns the event currently being executed.

getOwner() - Method in interface com.ebasetech.xi.api.WebFormEventContext

Returns the object that owns the event currently being executed.

getOwner() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Resource who is currently responsible for this job

getPage() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the Page where this control is located.

getPage(String) - Method in interface com.ebasetech.xi.api.Pages

Returns the Page with name pageName.

getPageContentsGap() - Method in interface com.ebasetech.xi.api.controls.FormHeaderProperties

The gap between any form header text and the rest of the page contents.

getPageControl() - Method in interface com.ebasetech.xi.api.Page

Returns the Page Control that acts as the root control for all controls on the page.

getPageNavigationInactiveProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Text styling properties for inactive (not clickable) icons/texts in the navigation bar.

getPageNavigationProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Text styling properties for active (clickable) icons/texts in the navigation bar.

getPageNumbersClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for active (clickable) page numbers in the navigation bar.

getPageNumbersStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for active (clickable) page numbers in the navigation bar.

getPages() - Method in interface com.ebasetech.xi.api.Component

Returns the Pages object that gives access to all pages available to the component.

getPages() - Method in class com.ebasetech.xi.api.PdfOptions

Returns the pages to be printed.

getPages() - Method in interface com.ebasetech.xi.api.WebForm

Returns the Pages object that gives access to all pages available to the form.

getPanelClass() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the list of CSS classes applied to the tab content panels.

getPanelClass() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the list of CSS classes applied to the content area.

getPanelColor() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

The background color for the content area.

getPanelCornerType() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

The style of corner applied to the bottom left and bottom right corners.

getPanelStyle() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the inline CSS style applied to the tab content panels.

getPanelStyle() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the inline CSS style applied to the content area.

getParentControl() - Method in interface com.ebasetech.xi.api.controls.Control

Returns this control's parent control or null if no such parent exists.

getParentJobSequence() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

If this is a sub process, this answers the sequence number of the parent process

getParentPath(String) - Static method in class com.ebasetech.xi.services.FileServices

Returns the path name of this file's parent directory or null if no parent exists.

getParentProcessName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

If this is a sub process, this answers the name of the parent process

getParentProcessVersion() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

If this is a sub process, this answers the version of the parent process

getPathParameter(String) - Method in interface com.ebasetech.xi.api.RESTfulService

Returns a path parameter based on the configured endpoint path parameter.

getPathParameters() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns all of the HTTP path parameters configured on the endpoint path as a JavaScript object Further documentation.

getPattern() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the pattern to be applied over the human readable message

getPatternTextClass() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the list of CSS classes applied to the value pattern.

getPatternTextClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to any value pattern text in the column header.

getPatternTextStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the value pattern.

getPatternTextStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to any value pattern text in the column header.

getPayload() - Method in interface com.ebasetech.xi.api.JWE

getPayload() - Method in interface com.ebasetech.xi.api.JWS

Return payload as a string.

getPBES2Count() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the PBES2 count (p2c) parameter.

getPBES2Salt() - Method in interface com.ebasetech.xi.api.JWEHeader

Returns the PBES2 salt (p2s) parameter.

getPdfBorder() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the inline CSS style applied to any configured PDF borders when a page is included in a PDF.

getPdfFooterMarginTextClass() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the list of CSS classes applied to the PDF footer text when a page is included in a PDF.

getPdfFooterMarginTextStyle() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the inline CSS style applied to the PDF footer text when a page is included in a PDF.

getPdfFooterText() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the Text object for the PDF footer text when a page is included in a PDF.

getPdfHeaderMarginTextClass() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the list of CSS classes applied to the PDF header text when a page is included in a PDF.

getPdfHeaderMarginTextStyle() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the inline CSS style applied to the PDF header text when a page is included in a PDF.

getPdfHeaderText() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the Text object for the PDF header text when a page is included in a PDF.

getPdfMargin() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the inline CSS style applied to any configured PDF margins when a page is included in a PDF.

getPdfOrientation() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the PDF orientation, portrait or landscape, when a page is included in a PDF.

getPdfPageSize() - Method in interface com.ebasetech.xi.api.controls.PageControl

Returns the PDF page size when a page is included in a PDF.

getPDFPageStyleProperties() - Method in interface com.ebasetech.xi.api.controls.PageControl

Styling properties that apply only when the page is printed to a PDF.

getPendingEscalators(String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a list of EscalatorEnactmentDescriptors that list each of the escalators that are currently pending for later firing within the system

getPlaceHolderText() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the Text object for the place holder text.

getPlainJWT() - Method in interface com.ebasetech.xi.api.JWE

Returns the Payload of the JWE as a JWT Object

getPooledActorIds() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Retrieve the pooled actors for the task enactment, or null if no pooled actors exist

getPopupBackgroundProperties() - Method in interface com.ebasetech.xi.api.controls.InfoProperties

Background properties for the popup help text window.

getPopupHelpStyle() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Returns the inline CSS style applied to the popup help window.

getPopupPaddingProperties() - Method in interface com.ebasetech.xi.api.controls.InfoProperties

Padding properties for the help text.

getPopupTextProperties() - Method in interface com.ebasetech.xi.api.controls.InfoProperties

Image properties for the clickable help image.

getPopupWindowName() - Method in class com.ebasetech.xi.api.PdfOptions

Returns the popup window name.

getPopupWindowProperties() - Method in interface com.ebasetech.xi.api.controls.InfoProperties

Properties for the popup help text window.

getPostcodeAnywhere() - Method in interface com.ebasetech.xi.api.Services

Returns the postcode anywhere services containing methods to access the PostcodeAnywhere service.

getPostcodeAnywhere() - Method in class com.ebasetech.xi.api.ServicesImpl

getPreferences() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the system preferences object.

getPrefix() - Method in interface com.ebasetech.xi.api.Component

Returns the component prefix.

getPresentationTemplateName() - Method in interface com.ebasetech.xi.api.WebForm

Returns the name of the presentation template currently used or null if no presentation template is configured.

getPresentationTemplatePath() - Method in interface com.ebasetech.xi.api.WebForm

Returns the path of the presentation template currently used or null if no presentation template is configured.

getPrevClass() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the list of CSS classes applied to the previous page button.

getPrevImageUrl() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the URL of the image when property prevDisplayAsImage is true.

getPrevious() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Styling properties for the previous page button.

getPreviousPage() - Method in interface com.ebasetech.xi.api.Page

Returns the Page object for the previous page displayed to the user.

getPreviousPage() - Method in interface com.ebasetech.xi.api.WebForm

Returns a Page object representing the previous page displayed or null if there is no previous page.

getPreviousSiblingControl() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the control that appears before this control within the same parent, or null if no such control exists.

getPrevStyle() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the inline CSS style applied to the previous page button.

getPriority() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor

Answer the priority of the associated task object

getProcessAttributeValue(WorkflowManagement.JobDescriptor, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Gets the value for the named process attribute in the context of the defined job

getProcessAttributeValue(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Gets the value for the named process attribute.

getProcessAttributeValues(String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a map of process attribute names agains their current runtime values.

getProcessDescription(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers the description of the named process.

getProcesses(String, Boolean, String, String, Boolean, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answer the list of all latest process versions matching the supplied filter criteria each described by a ProcessDescriptor.

getProcessInParameters(String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Returns a list of input parameter names for the given process.

getProcessName() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the name of the process associated with an audir record

getProcessName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer the name of the process that defines the associated enactment's job

getProcessName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Answer the name of the process of which this job is an enactment

getProcessVersion() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the version of the process associated with an audir record

getProcessVersion() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer the version of the process that defines the associated enactment's job

getProcessVersion() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Answer the version number of the process of which this is an enactment

getPublicKeyFromKeystore(String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns a PublicKey from the system key store for a given alias name.

getPublicKeyFromRemoteCerts(String, String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns a PublicKey from a published published X509 base64 encoded certificates using the specified URL, identified by a keyId

getPublicKeyFromTrustore(String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns a PublicKey from the system trust store for a given alias name.

getPublicKeyFromTrustore(String, String) - Method in interface com.ebasetech.xi.api.KeyManager

Returns Key from the system key store for a given alias name and password.

getPushNotification() - Method in interface com.ebasetech.xi.api.Services

getPushNotification() - Method in class com.ebasetech.xi.api.ServicesImpl

getQuietZone() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the width of the quiet zone left and right of the barcode in mm (gap either side of the barcode)

getQuietZoneVertical() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the vertical quiet zone (gap above and below the barcode)

getReason() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer the reason given to the API method that ultimately causes this audit record to be created

getRefreshToken() - Method in interface com.ebasetech.xi.api.OAuthTokens

Returns the value of the refresh token

getRemoteServers() - Method in interface com.ebasetech.xi.api.Gateway

Returns a list of remote servers configurations available for the Gateway Server to call using the method callForm(String, String) The GatewayRemoteServer contains the configuration information regarding the remote server that the Gateway Server can call

getRequest() - Method in interface com.ebasetech.xi.api.Client

Returns the HttpServletRequest object for the user request.

getRequestBody() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns the request body.

getRequestContentType() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns the HTTP request content type Further documentation.

getRequestHeader(String) - Method in interface com.ebasetech.xi.api.RESTfulService

Returns a request header by a specific name.

getRequestHeaders() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns all of the HTTP request headers as a JavaScript object Further documentation.

getRequestParameter(String) - Method in interface com.ebasetech.xi.api.RESTfulService

Returns a parameter by a specific name.

getRequestParameters() - Method in interface com.ebasetech.xi.api.RESTfulService

Returns all of the HTTP parameters as a JavaScript object Further documentation.

getRequiredText() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the required message Text displayed when the field is missing.

getResource(String) - Method in interface com.ebasetech.xi.api.Resources

Returns the Resource with name resourceName.

getResources() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the Resources object that gives access to all resources available to the form.

getResources() - Method in interface com.ebasetech.xi.api.Component

Returns the Resources object that gives access to all resources available to the component.

getResponse() - Method in interface com.ebasetech.xi.api.Client

Returns the HttpServletResponse object used to send a response to the user.

getResponseCharset() - Method in class com.ebasetech.xi.api.RestOptions

getRest() - Method in interface com.ebasetech.xi.api.Gateway

Returns the REST services that supports REST based operations to the Gateway Server.

getRest() - Method in interface com.ebasetech.xi.api.RESTfulWebService

Returns the RESTful functions available to the RESTful Web Service

getRest() - Method in interface com.ebasetech.xi.api.Services

Returns the REST services that supports REST based operations.

getRest() - Method in class com.ebasetech.xi.api.ServicesImpl

getRestore() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Styling properties for the restore button.

getRestoreClass() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the list of CSS classes applied to the restore button.

getRestoreImageUrl() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the URL of the image when property restoreDisplayAsImage is true.

getRestoreStyle() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the inline CSS style applied to the restore button.

getReturnUrl() - Method in interface com.ebasetech.xi.api.WebForm

Returns a Url for use with the callUrl() method.

getReturnValue(String) - Method in interface com.ebasetech.xi.api.FieldList

Returns the return value from the list that corresponds to the display value represented by displayValue.

getRightBorderWidth() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Right border width, overriding property borderWidth.

getRightHoverTabImage() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

URL of the image used for the top right corner of all tab headers when the mouse is hovered over a tab.

getRightMargin() - Method in interface com.ebasetech.xi.api.controls.MarginStyleProperties

Right margin size value.

getRightPadding() - Method in interface com.ebasetech.xi.api.controls.PaddingStyleProperties

Right padding size value.

getRightSelectedTabImage() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

URL of the image used for the top right corner of all tab headers when selected.

getRightTabImage() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

URL of the image used for the top right corner of all tab headers when not selected.

getRoles() - Method in interface com.ebasetech.xi.api.SecurityManager

Returns an array of role names for the logged on user

getRowClass() - Method in interface com.ebasetech.xi.api.controls.BootstrapFieldLayout

Returns the list of CSS classes to be applied to each row of the layout.

getRowCount() - Method in interface com.ebasetech.xi.api.Table

Returns the number of rows in the table.

getRowInformationClass() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the list of CSS classes configured for the row information text in the navigation bar.

getRowInformationProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Navigation bar row information text properties Further documentation.

getRowInformationStyle() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the inline CSS style configured for the row information text in the navigation bar.

getRowPrefixProperties() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Navigation bar prefix text properties.

getRows() - Method in interface com.ebasetech.xi.api.Table

Returns a row iterator object that can be used to traverse all table rows

getRowType() - Method in interface com.ebasetech.xi.api.controls.BootstrapRowControl

The type of row being represented see #setRowType(String)

getSave() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Styling properties for the save button.

getSaveClass() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the list of CSS classes applied to the save button.

getSaveImageUrl() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the URL of the image when property saveDisplayAsImage is true.

getSaveStyle() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Returns the inline CSS style applied to the save button.

getScheduler() - Method in interface com.ebasetech.xi.api.Services

Returns the scheduler services containing methods that enable Scheduled Tasks to be started from a form, workflow job or Integration Service.

getScheduler() - Method in class com.ebasetech.xi.api.ServicesImpl

getScriptText() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.DecisionEnactmentDescriptor

Answer the script of the associated decision node

getScriptText() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.PauseEnactmentDescriptor

Answer the script of the associated pause node

getScrollDownIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the active (clickable) scroll down icon in the navigation bar.

getScrollLeftIcon() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the URL of the horizontal scroll left icon.

getScrollRightIcon() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the URL of the horizontal scroll right icon.

getScrollToBottomIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the active (clickable) scroll to bottom icon in the navigation bar.

getScrollToTopIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the active (clickable) scroll to top icon in the navigation bar.

getScrollUpIcon() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

URL of the active (clickable) scroll up icon in the navigation bar.

getSearchCreatedDateFrom() - Method in class com.ebasetech.xi.api.SnapshotQuery

Returns query from creation date.

getSearchCreatedDateTo() - Method in class com.ebasetech.xi.api.SnapshotQuery

Returns query to creation date

getSearchExpiryDateFrom() - Method in class com.ebasetech.xi.api.SnapshotQuery

Returns query from expiry date.

getSearchExpiryDateTo() - Method in class com.ebasetech.xi.api.SnapshotQuery

Returns query to expiry date.

getSecondLevel() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Second level menu properties - containing properties for just the second level menu items.

getSecondLevelBackgroundClass() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the list of CSS classes applied to the background of the second menu level.

getSecondLevelBackgroundStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the inline CSS style applied to the background of the second menu level.

getSecondLevelClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to second level non-leaf unselected menu items.

getSecondLevelHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level non-leaf unselected menu items when the mouse is hovered over the item.

getSecondLevelHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of second level non-leaf unselected menu items when the mouse is hovered over the item.

getSecondLevelLeafClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to second level leaf unselected menu items.

getSecondLevelLeafHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level leaf unselected menu items when the mouse is hovered over the item.

getSecondLevelLeafHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of second level leaf unselected menu items when the mouse is hovered over the item.

getSecondLevelLeafSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level leaf selected menu items.

getSecondLevelLeafSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level leaf selected menu items.

getSecondLevelLeafSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of second level leaf selected menu items.

getSecondLevelLeafSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of second level leaf selected menu items.

getSecondLevelLeafStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level leaf unselected menu items.

getSecondLevelLeafTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of second level leaf unselected menu items.

getSecondLevelLeafTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level leaf selected menu items.

getSecondLevelSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to second level non-leaf selected menu items.

getSecondLevelSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level non-leaf selected menu items.

getSecondLevelSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of second level non-leaf selected menu items.

getSecondLevelSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of second level non-leaf selected menu items.

getSecondLevelStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to second level non-leaf unselected menu items.

getSecondLevelTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of second level non-leaf unselected menu items.

getSecondLevelTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of second level non-leaf unselected menu items.

getSecurity() - Method in interface com.ebasetech.xi.api.Services

Returns the services security containing any security implementations required by Services.

getSecurity() - Method in class com.ebasetech.xi.api.ServicesImpl

getSecurityManager() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the security manager object that provides access to all security functions: logon(), logoff(), hasRole() etc.

getSelectableCellClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the Select Column table cells.

getSelectableCellStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the Select Column table cells.

getSelectableDataClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the Select Column checkboxes.

getSelectableDataStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the Select Column checkboxes.

getSelectableWidth() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the width of the select column.

getSelected() - Method in interface com.ebasetech.xi.api.controls.MenuControl

The item name of the currently selected menu item or null if no menu item is selected.

getSelected() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The item name of the currently selected tab or null if no tab is selected.

getSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to drop-down non-leaf selected menu items.

getSelectedState() - Method in interface com.ebasetech.xi.api.controls.MenuLevelProperties

Styling properties applied to selected menu items.

getSelectedState() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Styling properties applied to the menu item when it is selected.

getSelectedState() - Method in interface com.ebasetech.xi.api.controls.TabControl

Styling properties applied to the tab header when selected.

getSelectedState() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Styling properties applied to tab headers when a tab is selected.

getSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to drop-down non-leaf selected menu items.

getSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of drop-down non-leaf selected menu items.

getSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of drop-down non-leaf selected menu items.

getSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the inline CSS style applied to both a tab header and its content panel when a tab has been selected.

getSeparator() - Static method in class com.ebasetech.xi.services.FileServices

Returns the system dependent file separator character.

getSequence() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor

Answer the sequence number of the job

getSequenceManager() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the sequence manager object that provides a new sequence number for a defined sequence.

getServerName() - Method in interface com.ebasetech.xi.api.GatewayRemoteServer

Returns the server name.

getServletContext() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the servlet context which can be used to get/set global attributes.

getSharedObject(String) - Static method in class com.ebasetech.xi.services.ObjectServices

getShortBarHeight() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the height of a short bar.

getSignature() - Method in interface com.ebasetech.xi.api.JWS

Return the signature for the JWS or JWT

getSize() - Method in interface com.ebasetech.xi.api.ListItemIterator

Returns the number of items in the list.

getSize() - Method in interface com.ebasetech.xi.api.TableRowIterator

Returns the size i.e.

getSmallWidth() - Method in interface com.ebasetech.xi.api.controls.BootstrapWidthProperties

Gets the width for the small breakpoint.

getSnapshotId() - Method in interface com.ebasetech.xi.api.Snapshot

Returns the snapshot id which is a unique identifier generated automatically and cannot be changed.

getSnapshotId() - Method in class com.ebasetech.xi.api.SnapshotQuery

Returns the snapshot id.

getSnapshotManager() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns snapshot manager that allows the user to take a snapshot of the form state data.

getSnapshots(SnapshotQuery) - Method in interface com.ebasetech.xi.api.SnapshotManager

Returns an array of candidate snapshots that match the search criteria specified in query.

getSocketTimeout() - Method in class com.ebasetech.xi.api.RestOptions

getSortAscendingIcon() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the URL of the column header icon used to sort the table in ascending order.

getSortColumns() - Method in interface com.ebasetech.xi.api.Table

Returns an Array of all the columns that are currently sorted.

getSortDescendingIcon() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the URL of the column header icon used to sort the table in descending order.

getSortDirections() - Method in interface com.ebasetech.xi.api.Table

Returns an Array of all the directions that are currently sorted.

getSource() - Method in interface com.ebasetech.xi.api.workflow.Audit

Answer a test string describing the source of the audit record

getSpaceBetweenTabs() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The space between adjacent tab headers.

getSpacerSize() - Method in interface com.ebasetech.xi.api.controls.FlowLayout

Horizontal spacing between adjacent controls.

getSpacerSize() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Horizontal spacing between adjacent controls.

getSpacerSize() - Method in interface com.ebasetech.xi.api.controls.NavigationBarStyleProperties

Returns the space between page numbers and scrolling icons/texts in the navigation bar.

getSpacerSize() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Vertical spacing between adjacent controls.

getStartupParameters() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns a map of the startup parameters and their values configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getState() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answer the state of the associated enactment

getStringValue() - Method in interface com.ebasetech.xi.api.Field

Returns a String value for the field that can be used to pass the value when calling another form, an Integration Service or opening a workflow job (see examples below).

getStripeCalendarProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Image properties for the calendar icon of date fields - applied to alternate (striped) rows.

getStripeColor() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns stripe color applied as a background color to alternate table rows.

getStripedButtonProperties() - Method in interface com.ebasetech.xi.api.controls.ButtonColumnControl

Returns the ButtonColumnProperties object representing styling properties for the button on alternate rows.

getStripedImageProperties() - Method in interface com.ebasetech.xi.api.controls.ImageColumnControl

Image properties applied to alternate (striped) rows.

getStripeEditorInputBackgroundProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Background properties for the data content of each table cell - applied to alternate (striped) rows.

getStripeEditorInputBorderProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Border properties for the data content of each table cell - applied to alternate (striped) rows.

getStripeEditorInputTextProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Text properties for the data content of each table cell - applied to alternate (striped) rows.

getStripeProperties() - Method in interface com.ebasetech.xi.api.controls.ColumnStyleProperties

Cell text, background, border and padding properties applied to alternate (striped) rows.

getStyle() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the inline CSS style configured for the control.

getSubject() - Method in interface com.ebasetech.xi.api.JWT

getSubJobProcessName() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answers the process name of a sub-job spawned as a result of executing this node

getSubJobProcessVersion() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answers the process version of a sub-job spawned as a result of executing this node

getSubJobSequence() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor

Answers the job sequence number of a sub-job spawned as a result of executing this node

getSubLevel() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Drop out level menu properties - containing properties for just the drop out level menu items.

getSubMenu() - Method in interface com.ebasetech.xi.api.controls.HorizontalMenuControl

Drop down menu properties - containing properties for just the drop down levels.

getSubMenuHAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuLevelProperties

Horizontal alignment of the menu level within each menu level container.

getSystemName() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the system name as configured in the Ufs.fileDirectoryName parameter of UFSSetup.properties.

getSystemVariable(String) - Method in interface com.ebasetech.xi.api.SystemVariables

Returns the SystemVariable with name variableName.

getTabAllColor() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The default background color applied to both tab header and its content panel.

getTabBorderColor() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The border color applied to both the tabs and the content panel.

getTabColor() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The background color applied to the tab header when the tab is not selected.

getTabCornerType() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The style of corner applied to the top left and top right corners of all tab headers.

getTabHeaderClass() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the list of CSS classes applied to all tab headers.

getTabHeaderStyle() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the inline CSS style applied to all tab headers.

getTabHoverColor() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The background color applied to a tab header when the mouse is hovered over a tab.

getTable() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the Table displayed by this control.

getTable() - Method in interface com.ebasetech.xi.api.TableColumn

Returns the Table of which this column forms a part.

getTable(String) - Method in interface com.ebasetech.xi.api.Tables

Returns the Table with name tableName.

getTableCellStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for table column cells.

getTableClass() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Returns the list of CSS classes configured for the HTML table used to provide the layout.

getTableClass() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the list of CSS classes configured for the HTML table used to provide the layout.

getTableClass() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Returns the list of CSS classes configured for the HTML table used to provide the layout.

getTableClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the outer table of the Table Control.

getTableClass() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Returns the list of CSS classes configured for the HTML table used to provide the layout.

getTableColumn() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Returns the table column displayed by this Table Column Control.

getTableDeleteStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the delete column.

getTableGridClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the inner table containing column headers and table row data.

getTableGridStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the inner table containing column headers and table row data.

getTableHeaderText() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the Text object for the table header text.

getTableInfoText() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the Text object for the table information text.

getTablePageScrollClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the horizontal scroll icons.

getTablePageScrollStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the the horizontal scroll icons.

getTableRowCellClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the table cells used to present table row data.

getTableRowCellStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the table cells used to present table row data.

getTableRowDataClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to table row data.

getTableRowDataStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to table row data.

getTableRowStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Background and border styling properties applied to table row data.

getTables() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the Tables object that gives access to all tables available to the form.

getTables() - Method in interface com.ebasetech.xi.api.Component

Returns the Tables object that gives access to all tables available to the component.

getTableSelectStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the select column.

getTableSortClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the column header sort icons.

getTableSortProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Column sort icon properties.

getTableSortStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the the column header sort icons.

getTableStyle() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Returns the inline CSS style configured for the HTML table used to provide the layout.

getTableStyle() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Returns the inline CSS style configured for the HTML table used to provide the layout.

getTableStyle() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Returns the inline CSS style configured for the HTML table used to provide the layout.

getTableStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the outer table of the Table Control.

getTableStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Returns the inline CSS style configured for the HTML table used to provide the layout.

getTableStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the entire table.

getTableTrailerText() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the Text object for the table trailer text.

getTabSelectedColor() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The background color applied to both tab header and its content panel when a tab is selected.

getTabWidth() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

The width of individual tab headers.

getTarget() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl

The target window id when the link is configured as external.

getTaskEnactmentDescriptor() - Method in class com.ebasetech.xi.api.workflow.ExecutionDescriptor

Returns the unique task descriptor id for the task

getTasks(WorkflowManagement.JobDescriptor, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Finds out the extant interactive task enactments for a given job.

getTasks(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Finds out the extant interactive task enactments for a given job using a stringified descriptor.

getTasksForActor(String, boolean, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist.

getTasksForActor(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist.

getTasksForRole(String, boolean, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement

Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist.

getTemplate() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the message template with the fields for the EAN message

getTemplate() - Method in interface com.ebasetech.xi.api.controls.CustomLayout

getText() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl

Returns the Text object for the hyperlink text.

getText() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Returns the Text object for the menu item text.

getText() - Method in interface com.ebasetech.xi.api.controls.TabControl

Returns the Text object for the tab header text.

getText() - Method in interface com.ebasetech.xi.api.controls.TextControl

Returns the Text object for the text.

getText() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the Text object for the title bar text.

getText(String) - Method in interface com.ebasetech.xi.api.SystemTexts

Returns the system text Text.

getText() - Method in interface com.ebasetech.xi.api.Text

Returns the text.

getText(String) - Method in interface com.ebasetech.xi.api.Texts

Returns the Text with id textId.

getTextBold() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

Text bold setting.

getTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of drop-down non-leaf unselected menu items.

getTextClass() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the list of CSS classes applied to the title bar text.

getTextColor() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

Text color.

getTextDecoration() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

Text decoration property (shown as Lines in the designer).

getTextFont() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

List of text fonts.

getTextImageGap() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

The gap between the menu item text and any configured image.

getTextImageGap() - Method in interface com.ebasetech.xi.api.controls.TabControl

The gap between the tab header text and any configured image.

getTextImageGap() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

The gap between the title text and any optional image.

getTextItalic() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

Text italic setting.

getTexts() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the Texts object that gives access to all texts available to the form.

getTexts() - Method in interface com.ebasetech.xi.api.Component

Returns the Texts object that gives access to all texts available to the component.

getTexts() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the system texts object which provides access to all system texts.

getTextSize() - Method in interface com.ebasetech.xi.api.controls.TextStyleProperties

Text size.

getTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of drop-down non-leaf unselected menu items.

getTextStyle() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the inline CSS style applied to the title bar text.

getThirdLevel() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Third level menu properties - containing properties for just the third level menu items.

getThirdLevelBackgroundClass() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the list of CSS classes applied to the background of the third menu level.

getThirdLevelBackgroundStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the inline CSS style applied to the background of the third menu level.

getThirdLevelClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to third level non-leaf unselected menu items.

getThirdLevelHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level non-leaf unselected menu items when the mouse is hovered over the item.

getThirdLevelHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of third level non-leaf unselected menu items when the mouse is hovered over the item.

getThirdLevelLeafClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to third level leaf unselected menu items.

getThirdLevelLeafHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level leaf unselected menu items when the mouse is hovered over the item.

getThirdLevelLeafHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of third level leaf unselected menu items when the mouse is hovered over the item.

getThirdLevelLeafSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level leaf selected menu items.

getThirdLevelLeafSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level leaf selected menu items.

getThirdLevelLeafSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of third level leaf selected menu items.

getThirdLevelLeafSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of third level leaf selected menu items.

getThirdLevelLeafStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level leaf unselected menu items.

getThirdLevelLeafTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of third level leaf unselected menu items.

getThirdLevelLeafTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level leaf selected menu items.

getThirdLevelSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to third level non-leaf selected menu items.

getThirdLevelSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level non-leaf selected menu items.

getThirdLevelSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of third level non-leaf selected menu items.

getThirdLevelSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level non-leaf selected menu items.

getThirdLevelStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to third level non-leaf unselected menu items.

getThirdLevelTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of third level non-leaf unselected menu items.

getThirdLevelTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of third level non-leaf unselected menu items.

getTimezone() - Method in interface com.ebasetech.xi.api.BaseForm

Returns the time zone used for the form.

getTitle() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl

Returns the Text object for the mouse over text.

getTitlebarClass() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the list of CSS classes applied to the entire title bar.

getTitlebarColor() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

The background color for the title bar.

getTitlebarCornerType() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

The style of corner applied to the top left and top right corners.

getTitleBarStyle() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Styling properties for the title bar.

getTitlebarStyle() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the inline CSS style applied to the entire title bar.

getTitlePanelBorderColor() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Returns the color applied to the border surrounding the control, including the corners.

getTokenExpiry() - Method in interface com.ebasetech.xi.api.OAuthTokens

Returns the token expiry

getTokens(String) - Method in interface com.ebasetech.xi.api.OAuth

Returns an OAuthTokens object containing the access token and the refresh token required with OAuth authentication.

getTokenType() - Method in interface com.ebasetech.xi.api.OAuthTokens

Returns the value the token type e.g Bearer

getTopBorderWidth() - Method in interface com.ebasetech.xi.api.controls.BorderStyleProperties

Top border width, overriding property borderWidth.

getTopLevel() - Method in interface com.ebasetech.xi.api.controls.HorizontalMenuControl

Top level menu properties - containing properties for just the top level menu items.

getTopLevelBackgroundClass() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the list of CSS classes applied to the background of the first menu level.

getTopLevelBackgroundStyle() - Method in interface com.ebasetech.xi.api.controls.VerticalMenuControl

Returns the inline CSS style applied to the background of the first menu level.

getTopLevelClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to top level non-leaf unselected menu items.

getTopLevelHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to top level non-leaf unselected menu items when the mouse is hovered over the item.

getTopLevelHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of top level non-leaf unselected menu items when the mouse is hovered over the item.

getTopLevelLeafClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to top level leaf unselected menu items.

getTopLevelLeafHoverStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to top level leaf unselected menu items when the mouse is hovered over the item.

getTopLevelLeafHoverTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of top level leaf unselected menu items when the mouse is hovered over the item.

getTopLevelLeafSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to top level leaf selected menu items.

getTopLevelLeafSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to top level leaf selected menu items.

getTopLevelLeafSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of top level leaf selected menu items.

getTopLevelLeafSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of top level leaf selected menu items.

getTopLevelLeafStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to top level leaf unselected menu items.

getTopLevelLeafTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of top level leaf unselected menu items.

getTopLevelLeafTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of top level leaf unselected menu items.

getTopLevelSelectedClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to top level non-leaf selected menu items.

getTopLevelSelectedStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to top level non-leaf selected menu items.

getTopLevelSelectedTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of top level non-leaf selected menu items.

getTopLevelSelectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of top level non-leaf selected menu items.

getTopLevelStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to top level non-leaf unselected menu items.

getTopLevelTextClass() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the list of CSS classes applied to the texts of top level non-leaf unselected menu items.

getTopLevelTextStyle() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Returns the inline CSS style applied to the texts of top level non-leaf unselected menu items.

getTopMargin() - Method in interface com.ebasetech.xi.api.controls.MarginStyleProperties

Top margin size value.

getTopPadding() - Method in interface com.ebasetech.xi.api.controls.PaddingStyleProperties

Top padding size value.

getTopPosition() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties

The y position of the window's top-left corner.

getTrackheight() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the height of the track

getTrailerClass() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the list of CSS classes applied to the trailer text.

getTrailerClass() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the list of CSS classes applied to the table trailer text.

getTrailerProperties() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Trailer text properties.

getTrailerStyle() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Returns the inline CSS style applied to the trailer text.

getTrailerStyle() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the inline CSS style applied to the table trailer text.

getTrailerStyleProperties() - Method in interface com.ebasetech.xi.api.controls.TableControl

Styling properties for the table trailer text.

getTransactionManager() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the transaction manager object that supports commit and rollback

getType() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the barcode type for the generated barcode.

getType() - Method in interface com.ebasetech.xi.api.Field

Returns the form field type.

getType() - Method in interface com.ebasetech.xi.api.SystemVariable

Returns the type for the system variable (see method SystemVariable.getValue() for a list of types).

getType() - Method in interface com.ebasetech.xi.services.Authentication

Returns the Authentication type ID

getUnselectedState() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl

Styling properties applied to the menu item when it is unselected.

getUnselectedState() - Method in interface com.ebasetech.xi.api.controls.TabControl

Styling properties applied to the tab header when not selected.

getUnselectedState() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Styling properties applied to tab headers when a tab is not selected.

getUnselectedTextStyle() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Returns the inline CSS style applied to unselected tab headers.

getUnsortedIcon() - Method in interface com.ebasetech.xi.api.controls.TableControl

Returns the URL of the column header icon displayed when the table is not currently sorted by this column.

getUserAgent() - Method in interface com.ebasetech.xi.api.Client

Returns the user-agent request header.

getUserAttribute(String, String) - Static method in class com.ebasetech.xi.services.LdapServices

Returns a single attribute associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttribute(String, String, String, String, boolean) - Static method in class com.ebasetech.xi.services.LdapServices

Returns a single attribute associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttribute(String, String) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns a single attribute associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttribute(String, String, String, String, boolean) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns a single attribute associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttributes(String) - Static method in class com.ebasetech.xi.services.LdapServices

Returns all attributes associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttributes(String, String, String, boolean) - Static method in class com.ebasetech.xi.services.LdapServices

Returns all attributes associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttributes(String) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns all attributes associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserAttributes(String, String, String, boolean) - Static method in class com.ebasetech.xi.services.LdapServices2

Returns all attributes associated with a user from the Ldap Registry identified by properties in the XIldap.properties file file.

getUserDataApplicationPath() - Static method in class com.ebasetech.xi.services.FileServices

Returns the file path for this application within the user data file system.

getUserName() - Method in interface com.ebasetech.xi.api.SecurityManager

Returns the user name when a user is logged on or null when no user is logged on.

getValidationText() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties

Returns the HTML5 validation message Text.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.CellStyleProperties

Vertical alignment of table cell content.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.ColumnLayout

Vertical alignment for all child controls of the container as a whole e.g.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.ColumnLayoutCell

Vertical alignment, overriding the layout cell vertical alignment from the parent ColumnLayout.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Vertical alignment for the entire field including all its parts.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.FieldLayout

Vertical alignment for all child content - all child controls are aligned as a single block.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.GridCellControl

Vertical alignment for all child content - all child controls are aligned as a single block.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayout

Vertical alignment for all child content - all child controls are aligned as a single block.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.HorizontalBoxLayoutCell

Vertical alignment, overriding the layout cell vertical alignment from the parent HorizontalBoxLayout.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.TableCellStyleProperties

Vertical alignment.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayout

Vertical alignment for all child content - all child controls are aligned as a single block.

getVAlign() - Method in interface com.ebasetech.xi.api.controls.VerticalBoxLayoutCell

Vertical alignment, overriding the layout cell vertical alignment from the parent VerticalBoxLayout.

getValue() - Method in interface com.ebasetech.xi.api.Field

Returns an Object representing the value of the form field.

getValue() - Method in interface com.ebasetech.xi.api.SystemVariable

Returns an Object representing the value of the system variable.

getValuePatternProperties() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl

Value pattern properties.

getValuePatternProperties() - Method in interface com.ebasetech.xi.api.controls.FieldControl

Text properties for the value pattern text text.

getValuePatternProperties() - Method in interface com.ebasetech.xi.api.controls.TableColumnHeaderProperties

Styling properties for the value pattern text.

getVariables() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the system variables object which provides access to all system variables.

getVelocity() - Method in interface com.ebasetech.xi.api.Services

Returns the Velocity services containing methods to invoke a Velocity template.

getVelocity() - Method in class com.ebasetech.xi.api.ServicesImpl

getVerticalAlignment() - Method in interface com.ebasetech.xi.api.controls.BootstrapColumnControl

How the column is vertically itself in its owning row

getVerticalAlignment() - Method in interface com.ebasetech.xi.api.controls.BootstrapRowControl

How the row is vertically aligning all immediate child columns

getVerticalAlignment() - Method in interface com.ebasetech.xi.api.controls.FlowLayout

Vertical alignment for all child content.

getVisibleRow() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl

Returns the row number of the first row currently visible to the user i.e.

getVisitedTextStyle() - Method in interface com.ebasetech.xi.api.controls.HyperlinkProperties

Hyperlink properties that apply to the visited state.

getWarningMessageStyle() - Method in interface com.ebasetech.xi.api.controls.MessageProperties

Returns the MessageStyleProperties object representing warning message styling properties.

getWarningMsgClass() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.

getWarningMsgStyle() - Method in interface com.ebasetech.xi.api.controls.Control

Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.

getWebAppRootFilePath() - Static method in class com.ebasetech.xi.services.FileServices

Returns the file path for the root directory served by Http requests for the web application.

getWebappUrlBase() - Method in interface com.ebasetech.xi.api.Client

Returns a base URL to access the root of the current web application i.e.

getWebServiceOperationName() - Method in interface com.ebasetech.xi.api.IntegrationService

Returns the name of the web service operation used to invoke the integration service.

getWidth() - Method in interface com.ebasetech.xi.api.controls.AddRowButtonProperties

Width of the add row button.

getWidth() - Method in interface com.ebasetech.xi.api.controls.BasicBlockControl

Panel width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.CellStyleProperties

Width of the table column.

getWidth() - Method in interface com.ebasetech.xi.api.controls.GridControl

Grid Control width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.GroupAndPagePanelProperties

Control width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.HorizontalLineControl

Line width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties

Window width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.MenuControl

Menu width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.PageControl

Page width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel

Width of the Pave Navigation Panel.

getWidth() - Method in interface com.ebasetech.xi.api.controls.RepeatingStyleProperties

Returns the width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.SpacerControl

Spacer width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.TableControl

Table width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.TableSortProperties

Sort icon width.

getWidth() - Method in interface com.ebasetech.xi.api.controls.TabSetControl

Width of the Tab Set Control.

getWidth() - Method in interface com.ebasetech.xi.api.controls.TitlePanelControl

Titled Panel Control width.

getWidthToHeightRatio() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl

Returns the ratio of the barcode width to the height.

getWorkflow() - Method in interface com.ebasetech.xi.api.EbaseSystem

Returns the workflow object, this provides access to all workflow functionality.

getWorkingDay(Date, int) - Static method in class com.ebasetech.xi.services.DateServices

Returns the working day n days in the future from an origin date, and using the organisational calendar to determine non-working days.

getX509CertSHA256Thumbprint() - Method in interface com.ebasetech.xi.api.JWSHeader

Gets the X.509 certificate SHA-256 thumbprint (x5t#S256) parameter.

getX509CertURL() - Method in interface com.ebasetech.xi.api.JWSHeader

Gets the X.509 certificate URL

gotoForm(String, String, Map<String, Object>) - Method in interface com.ebasetech.xi.api.Gateway

Transfers control to the form with the specified name from the Gateway Server to a specified remote server configured on the Server Admin Application.

gotoForm(String, String) - Method in interface com.ebasetech.xi.api.Gateway

Calls the form with the specified name and displays any resulting HTML page to the user.

gotoForm(String, Map<String, Object>) - Method in interface com.ebasetech.xi.api.WebForm

Transfers control to the form with the specified name, terminates execution of the current form and commits the current transaction.

gotoForm(String) - Method in interface com.ebasetech.xi.api.WebForm

Transfers control to the form with the specified name, terminates execution of the current form and commits the current transaction.

gotoPage(Page) - Method in interface com.ebasetech.xi.api.WebForm

Goes immediately to the specified page and terminates the event currently being executed; no statements past this method call will be executed.

gotoUrl(String, Map<String, Object>) - Method in interface com.ebasetech.xi.api.WebForm

Displays the specified URL in the user's browser, terminates execution of the current form and commits the current transaction.

gotoUrl(String, Map<String, Object>, String) - Method in interface com.ebasetech.xi.api.WebForm

Displays the specified URL in the user's browser, terminates execution of the current form and commits the current transaction.

GridCellControl - Interface in com.ebasetech.xi.api.controls

A Grid Cell Control represents a single cell within a Grid Control.

GridControl - Interface in com.ebasetech.xi.api.controls

Grid Control.

GroupAndPagePanelProperties - Interface in com.ebasetech.xi.api.controls

GroupAndPageTextProperties - Interface in com.ebasetech.xi.api.controls

GroupPanelControl - Interface in com.ebasetech.xi.api.controls

A Group Panel Control is a titled box container with three texts: header text, information text and trailer text.

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