This document lists the Java API changes made in this release. The comparison is performed between the current version and 5.7.1[v1034].
Returns a new object to be used to paginate over the result of this request.
XPathFilter.validateForTableNode(SchemaNode)
Checks if a predicate expression is valid according to the schema of the table.
com.onwbp.adaptation.RequestPagination
Performs paged navigation upon a request.
com.onwbp.adaptation.RequestPagination.Page
Represents a page over a request.
com.orchestranetworks.dataservices.rest.RESTEncodingHelper
Provides a helper for REST encoding.
Requests the interaction to be accepted and returns whether the operation has succeeded or not.
SessionInteraction.getSpecification()
Returns the specification of the interaction given by the associated definition.
Requests the interaction to be rejected and returns whether the operation has succeeded.
com.orchestranetworks.interactions.SessionInteraction.DecisionResult
Contains the report of a decision request (accept or reject).
com.orchestranetworks.interactions.SessionInteraction.Specification
Gives information about the specification of the interaction.
ModuleRegistration.handleServiceRegistration(ModuleServiceRegistrationContext)
This method can be overridden, in order to register new user services in EBX®.
com.orchestranetworks.module.ModuleServiceRegistrationContext
Context for registering the new module user services and the user service extensions in EBX®.
SchemaExtensionsContext.registerUserService(UserServiceDeclaration)
Registers a new user service for the current data model in EBX®.
SchemaExtensionsContext.registerUserServiceExtension(UserServiceExtensionDeclaration)
Register a new user service extension for the current data model in EBX®.
SchemaExtensionsContext.setServicePermissionRuleOnNode(Path, ServiceKey, ServicePermissionRule)
Declares that the display and execution of the specified service is conditioned by the specified rule, when invoked on the element referred by the specified path.
Declares that the display and execution of the specified service is conditioned by the specified rule, for all elements matching the rule's type of EntitySelection under the specified data model element.
public static final com.orchestranetworks.schema.SchemaTypeName OSD_COLOR
Built-in EBX® data type osd:color.
public static final com.orchestranetworks.schema.SchemaTypeName OSD_DATASET_NAME
Built-in EBX® data type osd:datasetName.
public static final com.orchestranetworks.schema.SchemaTypeName OSD_DATASPACE_KEY
Built-in EBX® data type osd:dataspaceKey.
com.orchestranetworks.schema.dynamic.BeanDefinition
This interface is used to define the schema associated with a non-persistent bean object (as opposed to a record or a dataset).
com.orchestranetworks.schema.dynamic.BeanDefinitionException
This runtime exception is thrown by some methods related to the dynamic beans schema definition.
com.orchestranetworks.schema.dynamic.BeanElement
This interface allows setting properties of a data model element.
com.orchestranetworks.schema.dynamic.BeanFacet
This interface allows setting properties of a bean facet.
com.orchestranetworks.schema.dynamic.BeanFacetDatasetSet
This interface allows setting the properties of a dataset constraint facet.
com.orchestranetworks.schema.dynamic.BeanFacetDataspaceSet
This interface allows setting the properties of a dataspace constraint facet.
com.orchestranetworks.schema.dynamic.BeanFacetTableRef
This interface allows setting the properties of a foreign key facet.
SchemaNodeDefaultView.getWidgetFactory()
Returns the custom widget factory defined in the data model using the property osd:defaultView/widget osd:class="com.foo.MyWidgetFactory" under the element xs:annotation/xs:appinfo.
com.orchestranetworks.schema.types.dataset.DatasetSet
Declarative definition of a set of dataspaces thanks to a list of include and exclude subsets.
com.orchestranetworks.schema.types.dataset.DatasetSet.DatasetChildrenPolicy
Inclusion policies for the children of a current dataset in a current subset.
com.orchestranetworks.schema.types.dataset.DatasetSetFilter
This interface defines a filter to accept or reject datasets in the context of a field of type {SchemaTypeName#OSD_DATASET_NAME}.
com.orchestranetworks.schema.types.dataset.DatasetSetFilterContext
Provides methods for filtering datasets in the context of a dataset selector.
com.orchestranetworks.schema.types.dataset.DatasetSetFilterSetupContext
Provides methods for setting up a dataset filter in the context of its data model.
com.orchestranetworks.schema.types.dataspace.DataspaceSet
Declarative definition of a set of dataspaces thanks to a list of include and exclude subsets.
com.orchestranetworks.schema.types.dataspace.DataspaceSet.DataspaceChildrenPolicy
Inclusion policies for the children of a current dataspace in a current subset.
com.orchestranetworks.schema.types.dataspace.DataspaceSet.DataspaceType
Defines all the types that a dataspace can be.
com.orchestranetworks.schema.types.dataspace.DataspaceSetFilter
This interface defines a filter to accept or reject dataspaces in the context of a field of type {SchemaTypeName#OSD_DATASPACE_KEY}.
com.orchestranetworks.schema.types.dataspace.DataspaceSetFilterContext
Provides methods for filtering a dataspace in the context of a dataspace selector.
com.orchestranetworks.schema.types.dataspace.DataspaceSetFilterSetupContext
Provides methods for setting up a dataspace filter in the context of its data model.
com.orchestranetworks.schema.types.file.UploadedFile
This class represents an uploaded file.
Returns true if priority 'error' is enabled.
ServiceContext.getCurrentRequestOnHierarchyLeaves()
Returns the request over the records of the current hierarchy leaves.
Session.isInWorkflowInteraction(boolean)
Returns true when the current session is in the context of a workflow interaction.
SessionPermissions.getNodeAccessPermissionForForm(SchemaNode, Adaptation)
Returns the current user's access rights on the specified node when displayed in a form.
ValidationReport.countItemsOfSeverity(Severity)
Returns the number of validation items of the severity specified.
ValidationReport.getTooManyMessagesItems()
Returns the validation items that contain the information about the constraints that have reached the validation message threshold.
ValidationReport.hasConstraintsWithTooManyMessages()
Returns true if the threshold specified in the EBX® main configuration file has been reached on items of the severity error by at least one constraint.
Returns true if this report has validation items.
ValueContextForUpdate.setPrivilegeForNode(Path)
Disables all permission checks for the specified node during the current operation.
ReplicationUnit.getRefreshPolicy()
Returns the RefreshPolicy of this replication unit.
ReplicationUnit.getReplicaTable(SchemaNode)
Returns the replica of the specified table node.
ReplicationUnit.getReplicaTables()
Returns the table replicas defined by this replication unit.
ReplicationUnit.getReplicationUnitKey()
Returns the key of this replication unit.
ReplicationUnit.getReplicationUnitsForTable(SchemaNode, Repository)
Returns all the replication units involving the specified table in the context of a repository.
com.orchestranetworks.service.extensions.RefreshPolicy
Represents the refresh policy of a ReplicationUnit.
com.orchestranetworks.service.extensions.Replica
Represents a replica in a replication unit.
com.orchestranetworks.service.extensions.ReplicaForList
Represents a replica of an aggregated list in a replica table.
com.orchestranetworks.service.extensions.ReplicaTable
Represents a replica table in a replication unit.
JavaScriptCatalog.ebx_form_getNodeMessage(String)
Returns the list of messages currently displayed for the specified form node.
JavaScriptCatalog.ebx_form_isNodeDefined(String)
Returns true if the node is defined in the form, false otherwise.
JavaScriptCatalog.ebx_form_setNodeMessage(String, JavaScriptCatalog.EBX_ValidationMessage)
Displays a list of messages on a node.
UIComponentWriter.newExpandCollapseBlock()
Returns a new expand/collapse block specification which, by default, would be rendered collapsed with an empty label.
UIComponentWriter.startExpandCollapseBlock(UIExpandCollapseBlock)
Starts an expand/collapse block from the given specification.
UIResourceLocator.getURLForResource(SchemaNode, Object)
Returns the URL of the web resource specified by the value of a resource type node.
UIResponseContext.getPrefixedPath(Path)
Gets the prefixed path.
com.orchestranetworks.ui.JavaScriptCatalog.EBX_ValidationMessage
A JavaScript object that holds a list of messages with different severities.
public static final com.orchestranetworks.ui.UIButtonIcon REVERT
@since 5.8.0
public static final com.orchestranetworks.ui.UIButtonIcon STAR_EMPTY
@since 5.8.0
public static final com.orchestranetworks.ui.UIButtonIcon STAR_FULL
@since 5.8.0
Changes the tab title.
UIFormContext.getCurrentRecordNode()
Returns the persisted record node being edited.
UIFormContext.getPreviousTabSelected(String)
Returns the tab id selected prior to submit in the associated {UIFormPaneWithTabs tabbed pane}.
Returns the id of the group, null if not set.
Sets an id for the group.
UIFormGroup.setLabel(UIFormLabelSpec)
Sets the label of the form group.
UIFormPaneWithTabs.addHomeTab(UIFormPane)
Adds a home pane to the layout.
UIFormPaneWithTabs.addTab(String, UIFormPane)
Adds a new tab to the layout.
Get the id of the tabbed pane set with the method {#setId(String)}.
UIFormPaneWithTabs.getPreviousTabSelected(UIFormContext)
Returns the tab id selected prior to the submit.
UIFormPaneWithTabs.getSelectedTabId()
Returns the tab id specified with the method {#selectTab(String)}.
UIFormPaneWithTabs.selectTab(String)
Specifies the id of the tab to select when the page is displayed.
UIFormWriter.addFormGroup(UIFormGroup)
Adds a group which represents the given path children.
UIFormWriter.addFormRowOrGroup(Path)
Adds rows to the form to represent the given path.
UIFormWriter.getDisplayMode(Path)
Returns the display mode used in the model driven form.
UIFormWriter.getPrefixedPath(Path)
Gets the prefixed path for the specified path, taking into account the potential current ObjectKey.
UIFormWriter.newCustomWidget(Path, UIWidgetFactory)
Returns a new instance of a widget which will be created by the given factory.
com.orchestranetworks.ui.form.UIExpandCollapseBlock
In the context of a form, specifies an expand/collapse block specification.
com.orchestranetworks.ui.form.UIFormNode
In the context of a form, specifies a record node in a row.
com.orchestranetworks.ui.form.UIFormNode.DisplayMode
Represents the display policy of a node.
com.orchestranetworks.ui.form.UIFormPaneFromPathList
This pane provides a table with a list of simple fields/complex groups.
public static final java.lang.String ROOT_ID
HTML id used by the system to build the root tabbed pane.
UITextBox.getBackgroundColor()
Returns the previously set background color.
UITextBox.setBackgroundColor(String)
Set the background color of the component input.
com.orchestranetworks.ui.form.widget.UICustomWidget
Base class for custom widgets.
com.orchestranetworks.ui.form.widget.UIListCustomWidget
Base class for custom widgets handling whole list elements.
com.orchestranetworks.ui.form.widget.UISimpleCustomWidget
Base class for custom widgets handling non-list elements.
com.orchestranetworks.ui.form.widget.UIWidgetFactory
This interface defines a factory to create a custom widget.
com.orchestranetworks.ui.form.widget.UIWidgetFileUpload
Widget for an upload file field.
com.orchestranetworks.ui.form.widget.UIWidgetFileUploadFactory
Widget factory for an upload file field.
com.orchestranetworks.ui.form.widget.WidgetDisplayContext
Context of a custom widget, containing values and information about the context in which the widget is called.
com.orchestranetworks.ui.form.widget.WidgetFactoryContext
Context provided by the user interface to create a new instance of a custom widget.
com.orchestranetworks.ui.form.widget.WidgetFactorySetupContext
Provides methods for setting up a widget factory in the context of its data model.
com.orchestranetworks.ui.form.widget.WidgetListValidationContext
Encapsulates an HTTP request so that a custom widget can provide the user input validation context for list custom widget.
com.orchestranetworks.ui.form.widget.WidgetValidationContext
Encapsulates an HTTP request so that a custom widget can provide the user input validation context.
com.orchestranetworks.ui.form.widget.WidgetWriter
This interface offers methods that can be used to create a standard EBX® widget.
com.orchestranetworks.ui.form.widget.WidgetWriterForList
This interface offers methods that can be used to create a standard EBX® list widget.
HierarchyEntitySelection.getSelectedHierarchyNodes()
Returns a new iterator on the selected hierarchy nodes if any, an empty iterator otherwise.
com.orchestranetworks.ui.selection.AssociationEntitySelection
Provides information on the current selection, in the context of an association.
com.orchestranetworks.ui.selection.AssociationRecordEntitySelection
Provides information on the currently selected associated record.
com.orchestranetworks.ui.selection.AssociationTableEntitySelection
Provides information on the association context of the current selection.
com.orchestranetworks.ui.selection.DatasetEntitySelection
Provides information on the currently selected dataset.
com.orchestranetworks.ui.selection.DataspaceEntitySelection
Provides information on the currently selected dataspace.
com.orchestranetworks.ui.selection.EntitySelection
Provides information on the current selection.
com.orchestranetworks.ui.selection.HierarchyNodeEntitySelection
Provides information on the currently selected hierarchy node.
com.orchestranetworks.ui.selection.RecordEntitySelection
Provides information on the currently selected record.
com.orchestranetworks.ui.selection.TableEntitySelection
Provides information on the currently selected table.
com.orchestranetworks.ui.selection.TableViewEntitySelection
Provides information on the currently selected table and on the current record selection if any.
ToolbarLocation.isAvailableForCustomToolbar()
@since 5.8.0
public static final com.orchestranetworks.ui.toolbar.ToolbarLocation DATASET_NODE
Toolbar displayed next to a dataset node.
public static final com.orchestranetworks.ui.toolbar.ToolbarLocation DATASET_VIEW_NAVIGATION_PANE
Toolbar displayed on top of a dataset navigation pane.
public static final com.orchestranetworks.ui.toolbar.ToolbarLocation DATASET_VIEW_TOP
Toolbar displayed on top of a dataset form view.
public static final com.orchestranetworks.ui.toolbar.ToolbarLocation DATASPACE_VIEW_WORKSPACE
Toolbar displayed on top of a dataspace view.
public static final com.orchestranetworks.ui.toolbar.ToolbarLocation HIERARCHICAL_VIEW_NODE
Toolbar displayed next to a node in a hierarchical view.
com.orchestranetworks.userservice.ObjectKey
Identifies an object from a given context.
com.orchestranetworks.userservice.UserService
Main interface to be implemented for a user service.
com.orchestranetworks.userservice.UserServiceAjaxContext
This interface provides information and utility methods useful when processing an Ajax request.
com.orchestranetworks.userservice.UserServiceAjaxRequest
Interface that an Ajax request callback must implement.
com.orchestranetworks.userservice.UserServiceAjaxResponse
This interface provides methods to generate a response when processing an Ajax request.
com.orchestranetworks.userservice.UserServiceDisplayConfigurator
This interface provides methods to set up a user service display.
com.orchestranetworks.userservice.UserServiceEvent
Interface that an event callback must implement.
com.orchestranetworks.userservice.UserServiceEventContext
This interface provides information and utility methods useful when processing an event.
com.orchestranetworks.userservice.UserServiceEventOutcome
An object returned by an event callback should implement this interface.
com.orchestranetworks.userservice.UserServiceException
This runtime exception is thrown by some methods related to user services.
com.orchestranetworks.userservice.UserServiceGetContext
This interface provides information and utility methods useful when processing a GET request.
com.orchestranetworks.userservice.UserServiceGetRequest
Interface that a GET request callback must implement.
com.orchestranetworks.userservice.UserServiceGetResponse
This interface provides methods to generate a response when processing an GET request.
com.orchestranetworks.userservice.UserServiceInvocationContext
This interface defines methods to get contextual information about the user service being invoked.
com.orchestranetworks.userservice.UserServiceNext
This class provides static methods to create standard outcome values specifying what to do next.
com.orchestranetworks.userservice.UserServiceObjectContext
This interface provides methods to access objects registered for the user service.
com.orchestranetworks.userservice.UserServiceObjectContextBuilder
This interface provides methods to register or remove objects managed by the user service.
com.orchestranetworks.userservice.UserServiceObjectContextForInputValidation
This interface provides methods to access or update objects registered for the user service.
com.orchestranetworks.userservice.UserServicePane
Interface that a user service pane must implement.
com.orchestranetworks.userservice.UserServicePaneContext
This interface provides information and utility methods useful when defining a user service pane.
com.orchestranetworks.userservice.UserServicePaneWriter
This interface provides useful methods for rendering a user service pane.
com.orchestranetworks.userservice.UserServiceProcessEventOutcomeContext
This interface provides information and utility methods useful when processing an event outcome.
com.orchestranetworks.userservice.UserServiceRawPane
This interface allows to define a user service raw pane.
com.orchestranetworks.userservice.UserServiceRawPaneContext
This interface provides information and utility methods useful when defining a user service raw pane.
com.orchestranetworks.userservice.UserServiceRawPaneWriter
This interface provides useful methods for rendering a user service pane.
com.orchestranetworks.userservice.UserServiceRequest
Defines an interface to provide information about a request for a user service.
com.orchestranetworks.userservice.UserServiceResourceLocator
This interface defines methods to build URLs that are useful for a user service.
com.orchestranetworks.userservice.UserServiceRootTabbedPane
This layout divides the workspace into a set of {UserServiceTab tabs}.
com.orchestranetworks.userservice.UserServiceSetupDisplayContext
This interface provides information and utility methods useful when setting up a user service display.
com.orchestranetworks.userservice.UserServiceSetupObjectContext
This interface provides information and utility methods useful when defining objects managed by the user service.
com.orchestranetworks.userservice.UserServiceTab
A tab in a tabbed pane.
com.orchestranetworks.userservice.UserServiceTabbedPane
This layout divides the pane into a set of {UserServiceTab tabs}.
com.orchestranetworks.userservice.UserServiceTransaction
This interface offers the possibility to mix in a single transaction and in any specified order: Record creations, Record or dataset updates, Custom procedure executions.
com.orchestranetworks.userservice.UserServiceTransactionManager
This class provides methods to execute transactions from a user service.
com.orchestranetworks.userservice.UserServiceValidateContext
This interface provides information and utility methods useful when performing custom validation.
com.orchestranetworks.userservice.UserServiceWriter
This interface provides methods for rendering a user service content.
com.orchestranetworks.userservice.declaration.ActionDisplaySpec
Defines whether and how an action must be displayed in a toolbar or a menu.
com.orchestranetworks.userservice.declaration.ActivationContext
Allows to define the activation scope and the activation rules of a user service, namely where and when this service is available and can be executed.
com.orchestranetworks.userservice.declaration.ActivationContextOnAssociation
Provides a context to define the activation scope and permission rules for a user service being declared on an association level.
com.orchestranetworks.userservice.declaration.ActivationContextOnAssociationRecord
Provides a context to define the activation scope and permission rules for a user service being declared on an associated record level.
com.orchestranetworks.userservice.declaration.ActivationContextOnDataset
Provides a context to define the activation scope and permission rules for a user service being declared on a dataset level.
com.orchestranetworks.userservice.declaration.ActivationContextOnDataspace
Provides a context to define the activation scope and permission rules for a user service being declared on a dataspace level.
com.orchestranetworks.userservice.declaration.ActivationContextOnHierarchy
Provides a context to define the activation scope and permission rules for a user service being declared on a hierarchy level.
com.orchestranetworks.userservice.declaration.ActivationContextOnHierarchyNode
Provides a context to define the activation scope and permission rules for a user service being declared on a hierarchy node level.
com.orchestranetworks.userservice.declaration.ActivationContextOnRecord
Provides a context to define the activation scope and permission rules for a user service being declared on a record level.
com.orchestranetworks.userservice.declaration.ActivationContextOnTableView
Provides a context to define the activation scope and permission rules for a user service being declared on a record level.
com.orchestranetworks.userservice.declaration.ActivationContextWithDatasetSet
Provides common methods for activation contexts related to datasets.
com.orchestranetworks.userservice.declaration.ActivationContextWithSchemaNodeSet
Provides common methods for activation contexts based on a set of schema nodes.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration
This interface allows to declare a user service.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnAssociation
Declares a user service that works at an association element level.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnAssociationRecord
Declares a user service that works on a single associated record.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnDataset
Declares a user service that works at the global dataset level.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnDataspace
Declares a user service that works at the global dataspace level.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnHierarchy
Declares a user service that works at the hierarchy level.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnHierarchyNode
Declares a user service that works on a single hierarchy node.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnRecord
Declares a user service that works on a single record.
com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnTableView
Declares a user service that works at the table level, tabular view level and/or record selection level.
com.orchestranetworks.userservice.declaration.UserServiceDeclarationException
This runtime exception is thrown during a user service declaration, if it is inconsistent.
com.orchestranetworks.userservice.declaration.UserServiceExtensionDeclaration
Allows to extend an existing user service.
com.orchestranetworks.userservice.declaration.UserServicePropertiesDefinitionContext
Provides a context to define the common properties of a user service.
com.orchestranetworks.userservice.declaration.WebComponentDeclarationContext
Provides a context to explicitly declare the HTTP parameters of a user service and to make this service available in the user interfaces used to to define a perspective action or a workflow user task.
com.orchestranetworks.userservice.declaration.WebComponentParameter
Specifies a parameter that can be used in the HTTP invocation of a Web component.
com.orchestranetworks.userservice.permission.ServiceActivationRuleForDataset
com.orchestranetworks.userservice.permission.ServiceActivationRuleForDatasetContext
Provides the context in which a service restriction rule is being evaluated.
com.orchestranetworks.userservice.permission.ServiceActivationRuleForDataspace
This interface can be implemented to specify whether a user service is disabled for a given dataspace.
com.orchestranetworks.userservice.permission.ServiceActivationRuleForDataspaceContext
Provides the context in which a service restriction rule is being evaluated.
com.orchestranetworks.userservice.permission.ServicePermissionRule
This interface can be implemented to specify the conditions under which a user service can be displayed and executed.
com.orchestranetworks.userservice.permission.ServicePermissionRuleContext
Provides the context in which a service permission rule is being evaluated.
com.orchestranetworks.userservice.permission.UserServicePermission
Defines the permission for whether or not a user can display or execute a user service.
ProcessInstanceHistory.getTerminationType()
Returns the termination type of the workflow.
Returns true if the rejection is enabled for the work item (the activation of the rejection is specified in the user task definition).
Returns the persistent identifier of a work item in the EBX® repository.
Parses the specified string, so as to return a work item key.
WorkflowEngine.allocateWorkItemToMyself(WorkItemKey)
Allocates a work item to the current user.
WorkflowEngine.createOrOpenInteraction(WorkItemKey)
Creates or opens the interaction associated with the specified work item.
WorkflowEngine.getInteractionSpecification(WorkItemKey)
Returns the specification of a session interaction.
WorkflowEngine.getProcessInstanceComments(ProcessInstanceKey)
Returns the comments of the specified workflow.
com.orchestranetworks.workflow.ProcessInstanceComment
Represents a comment of a workflow.
com.orchestranetworks.workflow.ProcessInstanceHistory.TerminationType
@since 5.8.0
com.orchestranetworks.ui.UIBeanEditor
Abstract class for customizing UI beans on master data.
com.orchestranetworks.ui.UIContext
Common abstract class for {UIBeanEditor} contexts.
com.orchestranetworks.ui.UIRequestContext
Encapsulates an HTTP request so that a bean editor can provide the user input validation context.
com.orchestranetworks.ui.UIResponseContext
Encapsulates an HTTP response in order for a bean editor to generate its part of the DHTML page, including the building of standard EBX® components.
HierarchyEntitySelection.getHierarchyNode()
Returns the selected hierarchy node.
HierarchyEntitySelection.getHierarchyNodeSelection()
Returns the selected hierarchy nodes when in a hierarchy node selection context.
HierarchyEntitySelection.getHierarchyTargetTable()
Returns the hierarchy target table.
ToolbarLocation.isUserServiceTop()
public static final com.orchestranetworks.ui.toolbar.ToolbarLocation USER_SERVICE_TOP
Toolbar displayed on top of a user service.