Package com.ebasetech.xi.api

Interface Summary
BaseForm BaseForm is an interface that represents any Ebase runnable entity that can have fields, tables and access to resources via a Business View.
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.
Component The Component interface represents a component deployed into a form.
Components The Components interface provides a means of switching between component contexts.
Controls The Controls interface acts as a parent object for all controls on all pages within a form.
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.
DynamicList The DynamicList interface represents a Dynamic List attached to a field.
EbaseSystem The EbaseSystem interface provides access to a number of system services.
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.
EventContext Provides context information about an Ebase event.
EventOwner The EventOwner is the base interface for all event owners.
Field The Field interface is the base interface for a form field or workflow process attribute.
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.
FormSession The FormSession interface represents a single browser window, usually a separate tab within the browser.
IntegrationResource The IntegrationResource interface represents an Integration Resource.
IntegrationService The IntegrationService interface represents an Integration Service.
LockManager The LockManager interface provides in memory locking services via its LockManager.lock(String, String) and LockManager.unlock(String, String) methods.
MessageContainer The MessageContainer represents any element (a Control or Page) that supports the addition of error and warning messages.
MqResource The MqResource interface represents a message to be read and/or written to an MQ Series message queue.
Page The Page interface represents a displayable page of a form.
Pages The Pages interface acts as a parent object for all pages within an interactive form.
PrintResource The PrintResource interface represents a Printing Resource.
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.
SecurityManager SecurityManager provides a centralized interface for all security related services.
SequenceManager The SequenceManager interface provides a single SequenceManager.sequence(String) method to provide the next number within a defined sequence.
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.
StaticList The StaticList interface represents a Static List attached to a field.
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.
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 $).
Table The Table interface represents a table defined in a form, integration service or workflow job.
TableColumn The TableColumn interface represents a table column form, integration service or workflow job.
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.
Tables The Tables interface acts as a parent object for all tables within a form, integration service or workflow process.
Text The Text interface represents a text that can be used anywhere in a form.
TransactionManager TransactionManager provides a centralized interface for all transaction related services.
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.
XmlResource The XmlResource interface represents an Xml Resource.
XmlResourceBase XmlResourceBase represents the base interface for all resources based around Xml documents.
 

Class Summary
PdfOptions This class supplies a number of options used to generate a PDF.
SnapshotQuery A Snapshot query is used to filter snapshots based on the filter information supplied.
UploadOptions The UploadOptions class supplies a number of options used when a file is uploaded from a browser to a server.