Index
All Classes|All Packages
C
- call() - Method in interface com.ebasetech.xi.api.RestResource
-
Calls the default endpoint specified on the REST Web Services Resource.
- call() - Method in interface com.ebasetech.xi.api.WebServiceResource
-
Calls the default adapter specified on the Web Service Resource.
- call() - Method in interface com.ebasetech.xi.api.XmlResourceBase
-
Calls the default adapter specified on the XML or Integration Resource.
- call(String) - Method in interface com.ebasetech.xi.api.RestResource
-
Calls the endpoint specified by
endpointName
on the REST Web Services Resource - call(String) - Method in interface com.ebasetech.xi.api.WebServiceResource
-
Calls the adapter specified by
adapterName
on the Web Service Resource. - call(String) - Method in interface com.ebasetech.xi.api.XmlResourceBase
-
Calls the adapter specified by
adapterName
on the XML or Integration Resource. - call(Map) - Method in interface com.ebasetech.xi.services.SelectStatementCallback
-
This method is called with each database row returned by DatabaseServices.executeSQLStatement.
- callForm(String) - Method in interface com.ebasetech.xi.api.WebForm
-
Calls the form with the specified name and displays any resulting HTML page to the user.
- callForm(String, Map<String, Object>) - Method in interface com.ebasetech.xi.api.WebForm
-
Calls the form with the specified name and displays any resulting HTML page to the user.
- callUrl(String, Map<String, Object>) - Method in interface com.ebasetech.xi.api.WebForm
-
Calls the specified URL and displays any resulting HTML page to the user.
- callUrl(String, Map<String, Object>, String) - Method in interface com.ebasetech.xi.api.WebForm
-
Calls the specified URL and displays any resulting HTML page to the user.
- cancel(WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Moves the identified task to the cancelled state.
- cancel(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Moves the identified task to the cancelled state.
- cancelJob(WorkflowManagement.JobDescriptor, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Cancels a currently executing job
- cancelJob(String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Cancels a currently executing job
- CanvasControl - Interface in com.ebasetech.xi.api.controls
-
A Canvas Control represents an HTML <canvas> tag.
- CellStyleProperties - Interface in com.ebasetech.xi.api.controls
-
Table Cell properties.
- checkCredentialValue(String, String) - Method in interface com.ebasetech.xi.api.SecurityManager
-
Returns
true
if the user credential identified bycredentialName
exists with the valuecredentialValue
, otherwise returnsfalse
. - clear() - Method in interface com.ebasetech.xi.api.CustomList
-
Removes all existing entries from the custom list.
- clearFocus() - Method in interface com.ebasetech.xi.api.Page
-
Removes any focus set on the page for individual controls using method
Control.requestFocus()
. - Client - Interface in com.ebasetech.xi.api
-
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. - CODABAR - Static variable in interface com.ebasetech.xi.api.controls.BarcodeControl
-
A constant to represent a Codabar barcode for use with setType() method.
- CODE128 - Static variable in interface com.ebasetech.xi.api.controls.BarcodeControl
-
A constant to represent a Code 128 barcode for use with setType() method.
- CODE39 - Static variable in interface com.ebasetech.xi.api.controls.BarcodeControl
-
A constant to represent a Code 39 barcode for use with setType() method.
- ColumnLayout - Interface in com.ebasetech.xi.api.controls
-
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 - Interface in com.ebasetech.xi.api.controls
-
The
ColumnLayoutCell
interface provides the ability to override properties from the parent control'sColumnLayout
; - ColumnStyleProperties - Interface in com.ebasetech.xi.api.controls
-
Table Column styling properties.
- com.ebasetech.xi.api - package com.ebasetech.xi.api
- com.ebasetech.xi.api.connectors - package com.ebasetech.xi.api.connectors
- com.ebasetech.xi.api.controls - package com.ebasetech.xi.api.controls
- com.ebasetech.xi.api.workflow - package com.ebasetech.xi.api.workflow
- com.ebasetech.xi.services - package com.ebasetech.xi.services
- com.ebasetech.xi.services.auth - package com.ebasetech.xi.services.auth
- COMMAND_CALL - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_DELETE - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_EXEC - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_FETCH - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_INSERT - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_PRINT - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_READ - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_UPDATE - Static variable in interface com.ebasetech.xi.api.CustomResource
- COMMAND_WRITE - Static variable in interface com.ebasetech.xi.api.CustomResource
- commitAndRestartTransaction() - Method in interface com.ebasetech.xi.api.TransactionManager
-
Commits the current transaction and starts a new transaction.
- complete(WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Notifies a Job that one of its constituent enactments has been completed with the given completion state.
- complete(WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, Map, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Notifies a Job that one of its constituent enactments has been completed with the given completion state.
- complete(String, String, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Notifies a Job that one of its constituent enactments has been completed with the given completion state.
- complete(String, String, Map, String, String) - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement
-
Notifies a Job that one of its constituent enactments has been completed with the given completion state.
- completeTask() - Method in interface com.ebasetech.xi.api.Workflow
-
This is equivalent to calling
completeTask(null, null)
. - completeTask(String, String) - Method in interface com.ebasetech.xi.api.Workflow
-
Signals completion of the current workflowed form and updates the workflow system with any workflow out parameters for the form.
- Component - Interface in com.ebasetech.xi.api
-
The
Component
interface represents a component deployed into a form. - Components - Interface in com.ebasetech.xi.api
-
The
Components
interface provides a means of switching between component contexts. - ContainerControl - Interface in com.ebasetech.xi.api.controls
-
The
ContainerControl
interface is implemented by all controls that can act as a container i.e. - contentType(String) - Method in interface com.ebasetech.xi.api.JWTBuilder
-
Set the content type header to the JWT Header.
- Control - Interface in com.ebasetech.xi.api.controls
-
The
Control
interface provides the base class for all controls, with common methods and properties shared by all controls. - ControlConstants - Interface in com.ebasetech.xi.api.controls
- Controls - Interface in com.ebasetech.xi.api
-
The
Controls
interface acts as a parent object for all controls on all pages within a form. - copyFile(String, String) - Static method in class com.ebasetech.xi.services.FileServices
-
Copies the contents of the file represented by fromPath to toPath.
- copyTable(Table, boolean) - Method in interface com.ebasetech.xi.api.Table
-
Optionally removes all existing rows and then copies rows from the table specified by
fromTable
. - createAuthorisationError(String, int) - Method in interface com.ebasetech.xi.services.Errors
-
Creates a
HttpAuthorisationError
supplying an error message and the response code. - createBasicAuthentication(String, String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns a BasicAuthentication object that stores the username and password required for HTTP Basic Authenication
- createCookie(String, String, int) - Method in interface com.ebasetech.xi.api.Client
-
Creates a
javax.servlet.http.Cookie
but does NOT add the cookie to the response object. - createCustomList() - Method in interface com.ebasetech.xi.api.controls.ListControl
-
Creates and returns an empty list and associates the list with this repeating list control.
- createCustomList() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn
-
Creates and returns an empty list and associates the list with the form field.
- createCustomList(String[]) - Method in interface com.ebasetech.xi.api.controls.ListControl
-
Creates a list for this control and adds the passed entries.
- createCustomList(String[]) - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn
-
Creates a list for the field and adds the passed entries.
- createDigestAuthentication(String, String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns a DigestAuthentication object that stores the username and password required for HTTP Digest Authenication
- createGatewayAuthentication(String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns new GatewayAuthentication object that stores the name of the configured Gateway Server on the server.
- createNewDirectory(String) - Static method in class com.ebasetech.xi.services.FileServices
-
Creates a new directory with this path name including any necessary but nonexistent parent directories.
- createNewFile(String) - Static method in class com.ebasetech.xi.services.FileServices
-
Creates a new file with this path name so long as a file or directory doesn't already exist with the same name.
- createNotFoundError(String, int) - Method in interface com.ebasetech.xi.services.Errors
-
Creates a
HttpNotFoundError
supplying an error message and the response code. - createNTLMAuthentication(String, String, String, String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns a NTLMAuthentication object that stores the username, password, workstation and domain required for HTTP NTLM Authenication
- createOAuthAuthentication(String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns an OAuthAuthentication object that stores the name of the configured OAuth configuration on the server
- createOAuthAuthentication(String, String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns an OAuthAuthentication object that stores the name of the configured OAuth configuration on the server.
- createOAuthAuthentication(String, String, String, String) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns an OAuthAuthentication object that stores the name of the configured OAuth configuration on the server.
- createOAuthAuthentication(String, String, String, String, Map<String, Object>) - Static method in class com.ebasetech.xi.services.HttpAuthentication
-
Returns an OAuthAuthentication object that stores the name of the configured OAuth configuration on the server.
- createRequestError(String, int) - Method in interface com.ebasetech.xi.services.Errors
-
Creates a
HttpRequestError
supplying an error message and the response code. - createRESTDataConnector(String) - Method in interface com.ebasetech.xi.api.connectors.DataConnectors
-
Creates a RESTful Data Connector constructed with a base URI that provides the following functionality: Direct communication with a REST service without having to call
RestServices
API helper functions. Customisable headers are sent with all REST calls. Authentication can be sent with all REST calls. Error handling for typical HTTP error codes. Response handling for Data Connector REST calls. - createServerError(String, int) - Method in interface com.ebasetech.xi.services.Errors
-
Creates a
HttpServerError
supplying an error message and the response code. - createSnapshot(Map<String, String>, Date) - Method in interface com.ebasetech.xi.api.SnapshotManager
-
Creates a snapshot for the application currently being executed.
- createUnknownError(String, int) - Method in interface com.ebasetech.xi.services.Errors
-
Creates a
HttpUnknownError
supplying an error message and the response code. - createUri(String) - Method in interface com.ebasetech.xi.api.connectors.RESTDataConnector
-
Returns a URI to the specified endpoint in the API.
- CustomLayout - Interface in com.ebasetech.xi.api.controls
-
TODO doc
- CustomList - Interface in com.ebasetech.xi.api
-
The
CustomList
interface represents a programmatic list that can be attached to a field. - CustomResource - Interface in com.ebasetech.xi.api
-
The
CustomResource
interface represents a Custom Resource.
All Classes|All Packages