All Classes

Class Description
AddRowButtonProperties  
AriaControlProperties  
AriaHTMLElementIDProperties  
ArticleControl
Article Control
AsideControl
Aside Control
Audit
Interface defining the contents of an audit record, as returned by the WorkflowManager
Authentication
An Authentication object represents the parameters for an authentication request.
BackgroundStyleProperties
The BackgroundStyleProperties interface represents common background styling properties.
BarcodeControl
Barcode Control
BaseForm
BaseForm is an interface that represents any Ebase runnable entity that can have fields, tables and access to resources via a Business View.
BaseTableControl
Interface BaseTableControl contains properties and methods that apply to both a Table Control and a Repeater Control.
BasicBlockControl  
BootstrapButtonStyle  
BootstrapColumnControl
Bootstrap Column Control
BootstrapContainerControl
Bootstrap Container Control
BootstrapContainerTypeProperties  
BootstrapFieldLayout  
BootstrapRowControl
Bootstrap Row Control
BootstrapWidthProperties
The BootstrapWidthProperties interface represents the different widths used within the bootstrap framework.
BorderStyleProperties
The BorderStyleProperties interface represents common border styling properties.
ButtonColumnControl  
ButtonColumnProperties
The ButtonColumnProperties interface represents styling properties for button columns.
ButtonControl
Button Control
ButtonControlProperties  
CanvasControl
A Canvas Control represents an HTML <canvas> tag.
CellStyleProperties
Table Cell properties.
Client
The Client interface provides information and methods pertaining to the client browser, including access to the request and response objects, methods to create and read cookies, and information on the capabilities of the client browser.
ColumnLayout
A Column Layout displays child controls in a grid formation where each child control is placed in the next available table cell e.g.
ColumnLayoutCell
The ColumnLayoutCell interface provides the ability to override properties from the parent control's ColumnLayout;
ColumnStyleProperties
Table Column styling properties.
Component
The Component interface represents a component deployed into a form.
Components
The Components interface provides a means of switching between component contexts.
ContainerControl
The ContainerControl interface is implemented by all controls that can act as a container i.e.
Control
The Control interface provides the base class for all controls, with common methods and properties shared by all controls.
ControlConstants  
Controls
The Controls interface acts as a parent object for all controls on all pages within a form.
CustomLayout
TODO doc
CustomList
The CustomList interface represents a programmatic list that can be attached to a field.
CustomResource
The CustomResource interface represents a Custom Resource.
DatabaseResource
The DatabaseResource interface represents a Database Resource which provides the ability to execute SQL statements.
DatabaseServices  
DateServices
Date Services
DynamicList
The DynamicList interface represents a Dynamic List attached to a field.
DynamicMenuItemControl
A Dynamic Menu Item Control represents a location in a menu where any number of menu items are to be inserted at runtime.
EbaseButtonControlProperties
The EbaseButtonControlProperties interface represents common properties for all Ebase navigation buttons.
EbaseSystem
The EbaseSystem interface provides access to a number of system services.
EditorInputProperties
Editor Input Properties
Element
Element is the base interface for all elements of a form.
EmailResource
The EmailResource interface represents a single email message to be sent using one of the sendmail() methods.
EncryptionServices
Encryption and decryption services
EventContext
Provides context information about an Ebase event.
EventOwner
The EventOwner is the base interface for all event owners.
ExecutionDescriptor
This interface represents the activity configured for a workflow interactive task.
Field
The Field interface is the base interface for a form field or workflow process attribute.
FieldColumnControl
Field Column Control
FieldControl
Field Control
FieldControlProperties
Field Control Properties.
FieldHyperlinkProperties
Field Hyperlink Properties.
FieldLayout
The Field Grid Layout provides specific functionality to display Field Controls in a grid structure where the label, editor and help portions of each Field Control are displayed in three separate table columns and are therefore vertically aligned.
FieldLayoutCell
The FieldLayoutCell interface provides the ability to override properties from the parent control's FieldLayout;
FieldList
FieldList is the base interface for all field list types: CustomList, StaticList, DynamicList.
Fields
The Fields interface acts as a parent object for all fields or process attributes within a form, an integration service or a workflow process.
FileItem
FileItem represents an uploaded File using the FileUploadControl.
FileItemIterator  
FileServices
File services File path parameters can be either absolute or relative.
FileUploadControl
The FileUploadControl control provides functionality to select local files and upload them.
FileUploadTextControl
File Upload Text Control displays the selected file(s) for the associated file upload control.
FinishButtonControl
Finish Button Control is one of the supplied Ebase page navigation buttons.
FlowLayout
A Flow Layout is similar to having no layout in that child controls are written horizontally across the page and will flow onto a new line when there is insufficient remaining width.
FooterControl
Footer Control
FormHeaderProperties
Properties for the optional form header text.
FormSession
The FormSession interface represents a single browser window, usually a separate tab within the browser.
Gateway
The Gateway interface represents Gateway Server functions.
GatewayAuthentication
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
GatewayRemoteServer contains configuration information regarding "Remote" servers that the Gateway can invoke forms
GatewayRestServices  
GridCellControl
A Grid Cell Control represents a single cell within a Grid Control.
GridControl
Grid Control.
GroupAndPagePanelProperties  
GroupAndPageTextProperties  
GroupPanelControl
A Group Panel Control is a titled box container with three texts: header text, information text and trailer text.
HeaderControl
Header Control A container that wraps content in a header tag.
HeadingControl
Heading Control
HorizontalBoxLayout
The HorizontalBoxLayout interface represents a layout where child controls are laid out horizontally.
HorizontalBoxLayoutCell
The HorizontalBoxLayoutCell interface provides the ability to override properties from the parent control's HorizontalBoxLayout;
HorizontalLineControl
A Horizontal Line Control represents a horizontal line.
HorizontalMenuControl
A Horizontal Menu Control represents a menu where the top level is shown horizontally and is always visible.
HTMLControl
An HTML Control can be used to hold any amount of HTML or XHTML content which will be inserted into the output page without amendment; any content that is valid within the BODY section of an HTML page can be inserted.
HtmlElementProperties
The HtmlElementProperties lets the developer change the behaviour of the control at runtime by adding and removing HTMLElement properties to change the interaction of browsers rich text client applications.
HttpAuthentication
HttpAuthentication is a convenience class to create HTTP Authentication objects.
HyperlinkControl
A Hyperlink Control represents a text displayed as a hyperlink.
HyperlinkProperties
Hyperlink Properties.
HyperlinkStateProperties
Hyperlink Properties.
ImageColumnControl
Image Column Control.
ImageControl
Image Control.
ImageControlProperties
Image Control properties.
ImageStyleProperties
The ImageStyleProperties interface represents common image styling properties.
IncludeControl
An Include Control represents an external JSP or HTML file that is to be inserted into the generated page output at the location represented by the control.
IndividualTabStateProperties
The IndividualTabStateProperties interface represents Tab Control styling properties for a specific tab state.
InfoPopupProperties
The InfoPopupProperties interface represents the properties passed to the Javascript window.open() statement used to create the popup window for field help texts.
InfoProperties
The InfoProperties interface represents properties that apply to field help texts.
InitiateUploadControl
Initiate Upload Control uploads the file(s) selected by the associated file upload control when clicked.
IntegrationResource
The IntegrationResource interface represents an Integration Resource.
IntegrationService
The IntegrationService interface represents an Integration Service.
JWE
JWE represents a parsed JWE (JSON Web Encryption) Object.
JWEHeader
JSON Web Encryption (JWE) header.
JWS
JWS represents a parsed JWS (JSON Web Signature) Object.
JWSHeader  
JWT
JWT represents a parsed JWT (JSON Web Token) Object.
JWTBuilder
JWTBuilder provides an interface to generate a JWT (JSON Web Token).
JWTManager  
KeyManager
KeyManager is used for accessing system PublicKey's or generating a HMAC Key.
Layout
The Layout interface provides the base class for all layouts.
LayoutCell
The LayoutCell interface provides the base class for all layout cells.
LayoutControl
The LayoutControl interface is implemented by all controls that can act as a container i.e.
LdapServices
LdapServices provides static methods that provide authentication and search methods against an Ldap Registry.
LdapServices2
LdapServices provides static methods that provide authentication and search methods against an Ldap Registry.
ListControl
List Control
ListHyperlinkControl
A List Hyperlink Control displays a hyperlink using the text from the list configured in its parent Repeating List Control.
ListItemControl
List Item Control
ListItemIterator
The ListIterator interface provides the ability to iterate through a list's values.
ListLayout  
ListLayoutCell  
ListPanelControl
List Panel Control
ListTextControl
A List Text Control displays a text from the list configured in its parent Repeating List Control.
LockManager
The LockManager interface provides in memory locking services via its LockManager.lock(String, String) and LockManager.unlock(String, String) methods.
MainControl
Main Control
MarginStyleProperties
Margin represents space outside an element's border, and is displayed with the background color of it's parent element.
MenuControl
MenuControl is the base interface for both horizontal and vertical menu controls.
MenuItemControl
MenuItemControl acts as the base interface for both static and dynamic menu items
MenuLevelProperties
The MenuLevelProperties interface represents styling properties applied to all menu items at a specific level of a menu.
MenuStateProperties
The MenuStateProperties interface represents menu item styling properties for a specific menu item state.
MessageContainer
The MessageContainer represents any element (a Control or Page) that supports the addition of error and warning messages.
MessageControl
A Message Control represents a location on a page where error and warning messages are displayed.
MessageProperties
The MessageProperties interface represents styling properties of error and warning messages.
MessageStyleProperties
The MessageProperties interface represents styling properties of error and warning messages.
MongoServices  
MqResource
The MqResource interface represents a message to be read and/or written to an MQ Series message queue.
NavControl
Nav Control
NavigationBarStyleProperties  
NavigationRowProperties  
NextPageButtonControl
Next Page Button Control is one of the supplied Ebase page navigation buttons.
OAuth
Interface OAuth represents the implementation required for OAuth 2.0 authentication.
OAuthTokens
Interface OAuthTokens contains the access token and the refresh token required for OAuth authentication.
ObjectServices  
PaddingStyleProperties
Padding represents the space between an HTML element's content and its border.
Page
The Page interface represents a displayable page of a form.
PageBreakControl
A Page Break control represents a page break and is applicable only when a page is included in a PDF.
PageControl
Page Control is a special control that must exist as the root control of each page.
PageNavigationButtonStyle
The PageNavigationButtonStyle interface represents styling properties for page navigation buttons.
PageNavigationPanel
A Page Navigation Control represents a panel containing up to five buttons.
PagePanelControl
A Page Panel Control is a specialised titled box container with three texts: header text, information text and trailer text.
Pages
The Pages interface acts as a parent object for all pages within an interactive form.
PanelControl
Panel Control
PdfOptions
This class supplies a number of options used to generate a PDF.
PDFPageStyleProperties
The PDFPageStyleProperties interface represents styling properties applied to a page when it is included in a PDF.
PostcodeAnywhereServices
PostcodeAnywhereServices provides static methods to access the PostcodeAnywhere service.
PrevPageButtonControl
Previous Page Button Control is one of the supplied Ebase page navigation buttons.
PrintResource
The PrintResource interface represents a Printing Resource.
PushNotification  
RepeatingStyleProperties
The RepeatingStyleProperties represents styling properties shared by both a Repeater Control and a Repeater Row Control.
RepeatingTableControl
A Repeater Control provides a flexible way of displaying data from a table.
RepeatingTableListControl  
RepeatingTableListRowControl  
RepeatingTableRowControl
A Repeater Row Control represents a single table row within a Repeater Control.
Resource
The Resource interface is the base interface for all external resources.
Resources
The Resources interface acts as a parent object for all resources within the Business View associated with a form, integration service or workflow process.
RESTfulService  
RESTfulWebService
The RESTfulWebService interface represents an RESTful Web Service.
RestOptions
This class supplies options used to invoke Rest Web Services.
RestoreButtonControl
A Restore Button Control represents the restore button for the Save/Restore Feature.
RestResource  
RestResponse
RestResponse contains the following response information following a RestServices call: HTTP Code - HTTP Response code return from the RestServices call Response Headers - All the HTTP response headers as key-->value String pairs Body - A String representation of the response body Contains the following methods: RestResponse.getCode() RestResponse.getHeaders() RestResponse.getBody() RestResponse.isSuccess() RestServices
RestServices
RestServices provides static methods that provide methods to access REST services.
SaveButtonControl
A Save Button Control represents the save button for the Save/Restore Feature.
SchedulerServices
SchedulerServices provides static methods that enable Scheduled Tasks to be started from a form, workflow job or Integration Service.
SectionControl
Section Control A container that wraps content in a section tag.
SecurityManager
SecurityManager provides a centralized interface for all security related services.
SelectStatementCallback
Callback interface used with DatabaseServices.executeSQLStatement
SequenceManager
The SequenceManager interface provides a single SequenceManager.sequence(String) method to provide the next number within a defined sequence.
Services  
ServicesImpl  
ServicesSecurity
Interface ServicesSecurity represents any security required by any service within services package.
Snapshot
Interface Snapshot represents a snapshot that contains all of the form and user state when created.
SnapshotManager
Interface SnapshotManager contains a number of methods to allow applications to create and restore snapshots.
SnapshotQuery
A Snapshot query is used to filter snapshots based on the filter information supplied.
SpacerControl
A Spacer Control control represents either or both a horizontal space and/or a vertical space.
StaticList
The StaticList interface represents a Static List attached to a field.
StaticMenuItemControl
A Static Menu Item Control represents a static menu item in either a Vertical Menu or a Horizontal Menu.
StoredProcedureResource
The StoredProcedureResource interface provides the ability to call a database stored procedure.
SystemPreferences
The SystemPreferences interface provides access to some of the system preferences configured via Tools > System Preferences.
SystemTexts
The SystemTexts interface acts as a parent object for all system texts.
SystemVariable
The SystemVariable interface represents a single system variable.
SystemVariables
The SystemVariables interface acts as a parent object for all system variables, LDAP variables and environment variables (in fact, all variable names that begin with a $).
TabAllStateProperties
The TabAllStateProperties interface represents styling properties applied to all tab states in a TabSetControl.
TabControl
A Tab Control represents a single tab within a Tab Set Control.
Table
The Table interface represents a table defined in a form, integration service or workflow job.
TableAddRowCellProperties  
TableCellStyleProperties  
TableColumn
The TableColumn interface represents a table column form, integration service or workflow job.
TableColumnHeaderProperties  
TableColumnValuePatternProperties  
TableControl
Table Control - represents a displayed table.
TableControlAddRowProperties  
TableControlStyleProperties  
TableControlTextProperties  
TablePageControl
A Table Page Control represents a horizontal page of table data and can only be added as a child of a Table Control.
TableRowIterator
The TableRowIterator interface represents a collection of table rows, and provides methods for iterating through the table rows either forwards or backwards, to address the underlying columns and their values.
TableRowStyleProperties  
Tables
The Tables interface acts as a parent object for all tables within a form, integration service or workflow process.
TableSortProperties  
TabSetContentPanelProperties
The TabSetContentPanelProperties interface represents styling properties applied to the content panels of tabs within a Tab Set Control.
TabSetControl
A Tab Set Control is a container containing a number of individual tabs.
Text
The Text interface represents a text that can be used anywhere in a form.
TextControl
A Text Control represents a text.
Texts
The Texts interface acts as a parent object for all texts that can be accessed from a form.
TextStyleProperties
The TextStyleProperties interface represents common text styling properties.
TitleBarProperties
The TitleBarProperties interface represents styling properties applied to the title bar of a TitlePanelControl.
TitlePanelControl
A Titled Panel Control is a container control with a title bar and border, where the title bar can contain a text and/or an image.
TransactionManager
TransactionManager provides a centralized interface for all transaction related services.
UploadOptions
The UploadOptions class supplies a number of options used when a file is uploaded from a browser to a server.
VelocityServices
VelocityServices provides static methods to invoke a Velocity template.
VerticalBoxLayout
The VerticalBoxLayout interface represents a layout where child controls are laid out vertically.
VerticalBoxLayoutCell
The VerticalBoxLayoutCell interface provides the ability to override properties from the parent control's VerticalBoxLayout;
VerticalMenuControl
A Vertical Menu Control represents a menu where the top level is shown vertically; subsequent levels can also be shown vertically with the menu expanding to accommodate them, or they can be shown as dynamic drop out menus in the same way as for a Horizontal Menu Control.
VerticalMenuLevelProperties
The VerticalMenuLevelProperties interface represents styling properties applied to all menu items at a specific level of a vertical menu.
WebForm
The WebForm interface represents an interactive web form, which is a form being executed by an online user.
WebFormEventContext
The WebFormEventContext interface provides context information about an Ebase event executed by an interactive form.
WebFormEventOwner
The WebFormEventOwner interface represents an event owner for all interactive form events.
WebFormField
The WebFormField interface represents a form field in an interactive web form.
WebFormFieldOrColumn
The WebFormFieldOrColumn interface represents behaviour shared by both a web form field and a web table column including: list behaviour get/set methods for displayable texts access to display length properties
WebFormTable
The WebFormTable represents a table in an interactive web form.
WebFormTableColumn
The WebFormTableColumn represents a table column in an interactive web form.
WebServiceResource
The WebServiceResource interface represents an Web Service Resource.
Workflow
The Workflow interface provides workflow related services to an interactive form, integration service or another workflow job.
WorkflowJob
The WorkflowJob interface represents a running workflow job.
WorkflowManagement
This interface describes the facilities available to external applications using the Workflow Management System.
WorkflowManagement.DecisionEnactmentDescriptor
An extension that incorporates the notion of a script
WorkflowManagement.EscalatorEnactmentDescriptor
An extension that describes the enactment of an escalator
WorkflowManagement.FallibleEnactmentDescriptor
This descriptor is used to represent descriptions of those enactments that implement the Fallible interface and therefore capable of failing at enactment time.
WorkflowManagement.InteractiveTaskEnactmentDescriptor
Implementations of this interface provide the detailed information needed by the tasklist application.
WorkflowManagement.JobDescriptor
Implementations of this interface provide information about a Job in the system
WorkflowManagement.PauseEnactmentDescriptor
An extension that incorporates the notion of a script and an event id
WorkflowManagement.SystemTaskEnactmentDescriptor
A descriptor used purely for System tasks
WorkflowManagement.TaskEnactmentDescriptor
An extension that incorporates the notion of an associated task
WrappedHttpSession  
XmlResource
The XmlResource interface represents an Xml Resource.
XmlResourceBase
XmlResourceBase represents the base interface for all resources based around Xml documents.