Uses of Package
com.ebasetech.xi.api

  • Classes in com.ebasetech.xi.api used by com.ebasetech.xi.api
    Class Description
    BaseForm
    BaseForm is an interface that represents any Ebase runnable entity that can have fields, tables and access to resources via a Business View.
    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.
    Element
    Element is the base interface for all elements of a form.
    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.
    GatewayRemoteServer
    GatewayRemoteServer contains configuration information regarding "Remote" servers that the Gateway can invoke forms
    GatewayRestServices  
    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.
    ListItemIterator
    The ListIterator interface provides the ability to iterate through a list's values.
    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.
    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.
    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.
    PdfOptions
    This class supplies a number of options used to generate a PDF.
    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  
    RestOptions
    This class supplies options used to invoke Rest Web Services.
    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.
    Services  
    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.
    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 $).
    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.
    Texts
    The Texts interface acts as a parent object for all texts that can be accessed from a form.
    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.
    WebFormEventOwner
    The WebFormEventOwner interface represents an event owner for all interactive form events.
    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
    WebFormTableColumn
    The WebFormTableColumn represents a table column in an interactive web form.
    Workflow
    The Workflow interface provides workflow related services to an interactive form, integration service or another workflow job.
    WrappedHttpSession  
    XmlResource
    The XmlResource interface represents an Xml Resource.
    XmlResourceBase
    XmlResourceBase represents the base interface for all resources based around Xml documents.
  • Classes in com.ebasetech.xi.api used by com.ebasetech.xi.api.controls
    Class Description
    CustomList
    The CustomList interface represents a programmatic list that can be attached to a field.
    Element
    Element is the base interface for all elements of a form.
    EventOwner
    The EventOwner is the base interface for all event owners.
    FieldList
    FieldList is the base interface for all field list types: CustomList, StaticList, DynamicList.
    FileItemIterator  
    MessageContainer
    The MessageContainer represents any element (a Control or Page) that supports the addition of error and warning messages.
    Page
    The Page interface represents a displayable page of a form.
    Table
    The Table interface represents a table defined in a form, integration service or workflow job.
    Text
    The Text interface represents a text that can be used anywhere in a 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.
    WebFormTableColumn
    The WebFormTableColumn represents a table column in an interactive web form.
  • Classes in com.ebasetech.xi.api used by com.ebasetech.xi.services
    Class Description
    Field
    The Field interface is the base interface for a form field or workflow process attribute.
    RestOptions
    This class supplies options used to invoke Rest Web Services.