Cloud Software Group, Inc. EBX®
TIBCO EBX® Documentation
Navigation mode Release Notes

# 6.2 Java API changes

- This document lists the Java API changes made in this release. The comparison is performed between the current version and 5.9

## Added elements

### com.onwbp.adaptation

- Class AbstractPrefilteredAdaptationFilter

  Defines a base class for implementing a PrefilteredAdaptationFilter.

- Method Adaptation.createQuery(String)

  Creates a query over this dataset from the specified SQL string.

- Method Adaptation.createQueryBuilder()

  Returns a query builder initialized with this dataset for unqualified tables.

- Method Adaptation.getLabel(Session)

  Returns the label of the dataset or record corresponding to the specified locale.

- Method Adaptation.getLabelOrName(Session)

  Returns the label of the dataset or record corresponding to the specified locale.

- Method Adaptation.getLastTransactionId()

  Returns the identifier of the last transaction in which this dataset or record has been modified.

- Method AdaptationHome.getValidationReport(Severity)

  Returns the validation report for this dataspace according to the specified properties.

- Method AdaptationHome.getValidationReport(ValidationSpec)

  Returns the validation report for this dataspace according to the specified properties.

- Method AdaptationHome.isUsedByValidation()

  Checks whether the current instance of AdaptationHome is a dedicated validation dataspace.

- Method AdaptationTable.getLastModificationDate()

  Retrieves the date of the most recent modification operation performed on the table.

- Class IncompatibleChangeError

  Unchecked exception thrown when the repository or the underlying data model has changed and this change implies that the current operation cannot be completed successfully.

- Interface PrefilteredAdaptationFilter

  Defines an AdaptationFilter that can be optimized using a prefilter predicate.

- Method Request.checkForbiddenNodes()

  When the execution would fail and throw a QueryPermissionException, this method returns the forbidden fields and the dataset in which these are forbidden.

- Method Request.isSortedByRelevancy()

  Returns whether the results of this request should be sorted by relevancy.

- Method Request.sortByRelevancy()

  Specifies that the results of this request will be sorted according to their relevancy regarding the search criterion (most relevant first).

- Method RequestSortCriteria.isSortOnLabel()

- Method RequestSortCriteria.isSortedByRelevancy()

- Class UnavailableRepositoryException

  Checked exception thrown when the repository is not available.

- Method XPathExpressionHelper.createAdaptationFilterForXPath(String,SchemaNode,java.util.Locale)

  Creates a new filter, given a table and an XPath expression.

### com.onwbp.adaptation.validation

- Interface DataspaceValidationReport

  Defines the validation report of a dataspace.

### com.onwbp.base.schema.validation

- Enum ValidationPolicyForTableViewEnum

  Defines the different validation policy to use when displaying records in the table view.

### com.onwbp.base.schema.view

- Interface SchemaDefaultTableView

  This interface represents the default view properties of a table defined in the data model.

### com.onwbp.base.text

- Method UserMessageRef.equals(Object)

- Method UserMessageRef.hashCode()

### com.orchestranetworks.dataservices.rest

- Constant CategoryVersion.DATA_BO_COMPACT_V1

  Data-compact business object category version 1.

- Constant CategoryVersion.DATA_BO_V1

  Data Business Object category version 1.

- Constant CategoryVersion.DATA_COMPACT_V1

  Data-compact category version 1.

- Constant CategoryVersion.FORM_DATA_COMPACT_V1

  form-Data category version 1.

- Constant CategoryVersion.FORM_DATA_V1

  form-Data category version 1.

- Method CategoryVersion.getCategoryUriBuilder(CategoryVersion)

- Constant Constants.Auth.KEY_ACCESS_TOKEN

- Constant Constants.Auth.KEY_LOGIN

- Constant Constants.Auth.KEY_PASSWORD

- Constant Constants.Auth.KEY_PASSWORD_NEW

- Constant Constants.Auth.KEY_SPECIFIC

- Constant Constants.Auth.KEY_TOKEN_TYPE

- Interface Constants.Constraint

  Constraint keys and values.

- Constant Constants.Data.CATEGORY_BUSINESS_OBJECT

- Constant Constants.Data.CATEGORY_BUSINESS_OBJECT_COMPACT

- Constant Constants.Data.CATEGORY_COMPACT

- Constant Constants.Data.KEY_ACTIVATED

- Constant Constants.Data.KEY_BUSINESS_OBJECT_DETAILS

- Constant Constants.Data.KEY_CHILDREN_DETAILS

- Constant Constants.Data.KEY_DATA_MODEL

- Constant Constants.Data.KEY_DESCRIPTION

- Constant Constants.Data.KEY_DOCUMENTATION

- Constant Constants.Data.KEY_HAS_CHILDREN

- Constant Constants.Data.KEY_INFORMATION

- Constant Constants.Data.KEY_IS_SELECT_ALLOWED

- Constant Constants.Data.KEY_KEY

- Constant Constants.Data.KEY_LOCALE

- Constant Constants.Data.KEY_MODULE

- Constant Constants.Data.KEY_OPEN_API_DETAILS

- Constant Constants.Data.KEY_OWNER

- Constant Constants.Data.KEY_PARENT

- Constant Constants.Data.KEY_PATH_IN_MODULE

- Constant Constants.Data.KEY_PUBLICATION

- Constant Constants.Data.KEY_SORT_BY_RELEVANCY

- Constant Constants.Data.KEY_TECHNICALS_CREATION_TIME

- Constant Constants.Data.KEY_TECHNICALS_CREATOR

- Constant Constants.Data.KEY_TECHNICALS_UPDATER

- Constant Constants.Data.KEY_TECHNICALS_UPDATE_TIME

- Constant Constants.Data.KEY_TECHNICALS_UUID

- Constant Constants.Data.KEY_VERSION_NAME

- Constant Constants.Data.PARAM_CHECK_NOT_CHANGED_SINCE_LAST_UPDATE_TIME

- Constant Constants.Data.PARAM_EBX_CHANNEL

- Constant Constants.Data.PARAM_EBX_INDENT

- Constant Constants.Data.PARAM_INCLUDE_METADATA

- Constant Constants.Data.PARAM_INCLUDE_OPEN_API_DETAILS

- Constant Constants.Data.PARAM_SORT_BY_RELEVANCY

- Constant Constants.Data.PARAM_SORT_PRIORITY

- Constant Constants.Data.URL_ACTION_CHILDREN

- Constant Constants.Data.URL_ACTION_COUNT

- Constant Constants.Data.URL_ACTION_INFORMATION

- Constant Constants.Data.URL_ACTION_MASS

- Constant Constants.Data.URL_ACTION_PREPARE_FOR_CREATION

- Constant Constants.Data.URL_ACTION_PREPARE_FOR_DUPLICATION

- Constant Constants.Data.URL_ACTION_PUBLISHED_VIEWS

- Constant Constants.Data.URL_ACTION_SELECT

- Constant Constants.Data.VALUE_EBX_CHANNEL_DATA_SERVICES

- Constant Constants.Data.VALUE_EBX_CHANNEL_UI

- Constant Constants.Data.VALUE_FILTER_SELECT_ALL

  Selects all the entities for update or delete.

- Constant Constants.Data.VALUE_INCLUDE_METADATA_ALL

- Constant Constants.Data.VALUE_SORT_PRIORITY_FROM_VIEW

- Interface Constants.Dataspace

  Dataspace keys and parameters.

- Interface Constants.DeleteReport

  Deletes report keys.

- Constant Constants.Error.KEY_ERRORS_BLOCKS_COMMIT

- Constant Constants.Error.KEY_ERRORS_LEVEL

- Interface Constants.FormData

  Form-data keys and parameters.

- Interface Constants.Health

  Specifies the health keys.

- Constant Constants.History.KEY_HISTORY_CHILDREN_DETAILS

- Constant Constants.History.PARAM_INCLUDE_MERGE_INFO

- Constant Constants.Meta.KEY_ASSOCIATION

- Constant Constants.Meta.KEY_ASSOCIATION_DATASET

- Constant Constants.Meta.KEY_ASSOCIATION_DATASPACE

- Constant Constants.Meta.KEY_ASSOCIATION_DETAILS

- Constant Constants.Meta.KEY_ASSOCIATION_FIELD_TO_SOURCE

- Constant Constants.Meta.KEY_ASSOCIATION_FIELD_TO_TARGET

- Constant Constants.Meta.KEY_ASSOCIATION_FILTER

- Constant Constants.Meta.KEY_ASSOCIATION_LINK_TABLE_PATH

- Constant Constants.Meta.KEY_ASSOCIATION_TABLE_PATH

- Constant Constants.Meta.KEY_ASSOCIATION_TYPE

- Constant Constants.Meta.KEY_ASSOCIATION_XPATH_LINK_PREDICATE

- Constant Constants.Meta.KEY_AUTO_INCREMENT

- Constant Constants.Meta.KEY_BUSINESS_OBJECT_RELATION

- Constant Constants.Meta.KEY_CHECK_NULL_INPUT

- Constant Constants.Meta.KEY_CONSTRAINTS

- Constant Constants.Meta.KEY_ENUMERATION_DEPENDENCIES

- Constant Constants.Meta.KEY_ENUMERATION_DEP_DATASET

- Constant Constants.Meta.KEY_ENUMERATION_DEP_DATASPACE

- Constant Constants.Meta.KEY_ENUMERATION_DEP_DETAILS

- Constant Constants.Meta.KEY_ENUMERATION_DEP_LOCAL_MODIFY

- Constant Constants.Meta.KEY_ENUMERATION_DEP_TARGET_PATH

- Constant Constants.Meta.KEY_HIDDEN_FILTER_POLICY

- Constant Constants.Meta.KEY_LINKED_FIELD

- Constant Constants.Meta.KEY_LINKED_FIELD_DETAILS

- Constant Constants.Meta.KEY_LINKED_FIELD_PATH

- Constant Constants.Meta.KEY_LINKED_FIELD_RELATIONSHIP_FIELD

- Constant Constants.Meta.KEY_LINKED_FIELD_TABLE_PATH

- Constant Constants.Meta.KEY_READ_ONLY

- Constant Constants.Meta.PARAM_INCLUDE_METAMODEL

- Constant Constants.Meta.VALUE_ASSOCIATION_TYPE_LINK_TABLE

- Constant Constants.Meta.VALUE_ASSOCIATION_TYPE_TABLE_REF_INVERSE

- Constant Constants.Meta.VALUE_ASSOCIATION_TYPE_XPATH_LINK

- Constant Constants.Pagination.KEY_CURSOR

  Pagination cursor position.

- Constant Constants.Pagination.KEY_MAX

  Maximum page cursor position.

- Constant Constants.Pagination.PARAM_FIRST_ELEMENT_INDEX

- Constant Constants.Pagination.PARAM_PAGE_SIZE_DATASPACE_SELECTION_MAX_VALUE

- Constant Constants.Pagination.VALUE_PAGE_ACTION_DEFAULT

- Constant Constants.Pagination.VALUE_PAGE_SIZE_DEFAULT

- Constant Constants.Selector.PARAM_PAGE_SIZE

- Interface Constants.ValidationReport

  Validation report keys.

### com.orchestranetworks.instance

- Constant HomeKey.KEY_PATTERN_COMPILED

  The compiled representation of a dataspace or a snapshot key.

- Method Repository.getDefaultWhenFullyInitialized()

  Returns the default instance of this class once the full initialization is done.

- Method Repository.reopenHome(AdaptationHome,Session)

  Reopens the specified home.

- Method RepositoryAnonymizer.RecordContext.setValue(Object,SchemaNode)

  Modifies the value of the specified node.

- Constant RepositoryId.LENGTH

  Repository identifier length.

- Constant RepositoryId.PATTERN

  Repository identifier string pattern.

- Method ValueContextForValidation.getFunctionalDataspace()

  Returns the dataspace that contains the adaptation for which the validation has been requested.

- Method ValueContextForValidationOnRecord.isRecordCreation()

  Returns true if the current record is being created.

- Method ValueContextForValidationOnTable.getFunctionalDataspace()

  Returns the dataspace that contains the table for which the validation has been requested.

### com.orchestranetworks.interactions

- Method SessionInteraction.getWorkItemKey()

  Returns the work item key associated to the current session interaction.

### com.orchestranetworks.module

- Method ModuleRegistration.handleSearchRegistration(ModuleSearchRegistrationContext)

  Override this method to register module-defined search templates and custom lists of synonyms and stopwords.

- Interface ModuleSearchRegistrationContext

  Context for registering custom search resources in EBX®.

### com.orchestranetworks.permissions

- Class QueryPermissionException

  This exception is thrown when a query fails because some nodes are not visible for the user.

### com.orchestranetworks.query

- Interface Query

  An object that represents a compiled and validated SQL query.

- Interface QueryBuilder

  A builder for query objects, capable of creating queries which reference tables from multiple datasets.

- Class QueryParseException

  Thrown if a SQL query string cannot be parsed.

- Interface QueryResult

  Represents the result of a query.

- Interface Tuple

  Interface for extracting the elements of a query result tuple.

### com.orchestranetworks.rest

- Constant ApplicationConstant.REST_DEFAULT_OPENAPI_APPLICATION_PATH

  Default OpenAPI web application URL mapping for JAX-RS OpenAPI application.

- Constructor LocalizedException(int,UserMessage)

  Constructs a new instance with the provided data, without functional error code.

- Constructor LocalizedException(int,UserMessage,Integer,Throwable)

  Constructs a new instance with the provided data, without functional error code.

- Constructor LocalizedException(int,UserMessage,Throwable)

  Constructs a new instance with the provided data, without functional error code.

- Constructor RESTApplicationAbstract(java.util.function.Consumer)

  Creates a new REST Toolkit application configuration initialized with mandatory and custom properties, resources and providers.

### com.orchestranetworks.rest.annotation

- Annotation ExtendedInput

  An annotation used to configure the extended JSON input format for a Data Transfer Object (DTO) field of type ContentHolder.

- Annotation ExtendedOutput

  Annotation used to configure the extended JSON output format for a Data Transfer Object (DTO) field of type ContentHolder.

- Annotation OpenApiApplicationPath

  Annotation used to automatically create a JAX-RS application serving OpenAPI REST resource for the underlying REST Toolkit application.

- Annotation OpenApiResource

  Annotation used to activate the OpenAPI documentation on the annotated REST resource Java class.

- Annotation Table

  Annotation used to reference a schema table linked to a Data Transfer Object (DTO) field of type ContentHolder.

### com.orchestranetworks.rest.inject

- Method SessionContext.getProcedureUtility()

  Returns a configured procedure utility instance.

### com.orchestranetworks.rest.serialization

- Class ContentHolder

  Provides a facade to a table record in EBX®.

- Class ContentHolderForInput

  Provides a facade to automatically parse a part of the request body that may represent a table record.

- Class ContentHolderForOutput

  Provides a facade to automatically serialize an Adaptation, that corresponds to a table record, into a JSON response body.

- Enum Include

  Holds the available options for configuring the content of the generated JSON response body.

### com.orchestranetworks.rest.util

- Constant BuiltinQueryParam.COMMIT_THRESHOLD

  The query parameter "ebx-commitThreshold" specifies the maximum size of a transaction during the execution of a Procedure.

- Class CategoryURIBuilder

  Maps each REST category and available version to their related URI builder.

- Interface ProcedureUtility

  This class eases Procedure execution through automatic pre-configuration.

- Interface URIBuilderForBuiltin.ForDataAndHistory

  Aggregates methods to generate built-in REST services URI to data and history category resources.

- Interface URIBuilderForBuiltin.ForDataset

  Contains methods to generate built-in REST services URI to a dataset.

- Interface URIBuilderForBuiltin.ForDataspace

  Beta feature: Contains methods to generate built-in REST services URI to a dataspace.

- Interface URIBuilderForBuiltin.ForNode

  Contains methods to generate built-in REST services URI to a record field or a dataset node.

- Interface URIBuilderForBuiltin.ForRecord

  Contains methods to generate built-in REST services URI to a record.

- Interface URIBuilderForBuiltin.ForTable

  Contains methods to generate built-in REST services URI to a table.

- Method URIBuilderForBuiltin.extendedAction(String)

  Appends the provided extended action to the generated URI path's end.

- Method URIBuilderForBuiltin.firstPage()

  Replaces the first page action from the existing set of query parameters.

- Method URIBuilderForBuiltin.lastPage()

  Replaces the last page action from the existing set of query parameters.

- Method URIBuilderForBuiltin.nextPage(String)

  Replaces the next page action and page record filter from the existing set of query parameters.

- Method URIBuilderForBuiltin.pageSize(int)

  Replaces the provided pageSize from the existing set of query parameters.

- Method URIBuilderForBuiltin.previousPage(String)

  Replaces the previous page action and page record filter from the existing set of query parameters.

- Method URIBuilderForBuiltin.queryParams(jakarta.ws.rs.core.MultivaluedMap)

  Appends the provided query parameters to the existing set of query parameters.

- Method URIBuilderForBuiltin.queryParams(java.util.Map)

  Appends the provided query parameters to the existing set of query parameters.

- Method URIInfoUtility.createBuilderForBuiltin(CategoryURIBuilder)

  Creates a URI builder useful for generating URIs for the EBX® built-in REST services.

- Method URIInfoUtility.createBuilderForBuiltin(CategoryURIBuilder,boolean)

  Creates a URI builder useful for generating URIs for the EBX® built-in REST services.

- Method URIInfoUtility.getBaseURIForBuiltin()

  Returns the EBX® built-in REST services base URI.

### com.orchestranetworks.schema

- Method DependenciesDefinitionContext.addDependencyToInsertAndDelete(Path)

  Specifies that the validation result of the current constraint depends on the insertions and deletions of the specified table node.

- Method DependenciesDefinitionContext.addDependencyToInsertDeleteAndModify(Path)

  Specifies that the validation result of the current constraint depends on insertions, modifications and deletions on the specified node.

- Method DependenciesDefinitionContext.addDependencyToInsertDeleteAndModifyInOtherInstance(Path,AdaptationReference)

  Specifies that the validation result of the current constraint depends on the insertions, modifications and deletions on the specified node in a given dataset in a specific dataspace.

- Method DependenciesDefinitionContext.addDependencyToInsertDeleteAndModifyInOtherInstance(Path,AdaptationReference,HomeKey)

  Specifies that the validation result of the current constraint depends on the insertions, modifications and deletions on the specified node in a given dataset in a specific dataspace.

- Method DependenciesDefinitionContext.addDependencyToModify(Path)

  Specifies that the validation result of the current constraint depends on the value of the specified source node in the same record.

- Interface JavaBeanVersion

  Defines a JavaBean behavior version.

- Method SchemaExtensionsContext.setAccessRuleForCreateOnNode(Path,AccessRuleForCreate,UserMessage)

  Declares that the access to a record node may be restricted by the specified rule while in a record creation context.

- Method SchemaExtensionsContext.setAccessRuleForCreateOnNodeAndAllDescendants(Path,boolean,AccessRuleForCreate,UserMessage)

  Declares that the access to an element's subtree may be restricted in a record creation context by the specified AccessRuleForCreate.

- Method SchemaExtensionsContext.setAccessRuleOnInstance(AccessRule,UserMessage)

  Declares that global access to a dataset may be restricted by the specified rule.

- Method SchemaExtensionsContext.setAccessRuleOnNode(Path,AccessRule,UserMessage)

  Declares that the access to an element may be restricted by the specified rule.

- Method SchemaExtensionsContext.setAccessRuleOnNodeAndAllDescendants(Path,boolean,AccessRule,UserMessage)

  Declares that the access to an element's subtree may be restricted by the specified rule.

- Method SchemaExtensionsContext.setAccessRuleOnOccurrence(Path,AccessRule,UserMessage)

  Declares that global access to a table record in the data model may be restricted by the specified rule.

- Method SchemaExtensionsContext.setServicePermissionRuleOnNode(Path,ServiceKey,ServicePermissionRule,UserMessage)

  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.

- Method SchemaExtensionsContext.setServicePermissionRuleOnNodeAndAllDescendants(Path,ServiceKey,ServicePermissionRule,UserMessage)

  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.

- Method SchemaLocation.getPathInModule()

  Returns the location of the related data model inside its container module if it is packaged in a module.

- Method SchemaLocation.getPublicationName()

  Returns the name of the publication if this instance is an embedded data model.

- Method SchemaLocation.isPublication()

  Returns true if this instance refers to a publication.

- Method SchemaNode.getBusinessObjectModel()

  Returns the business object model associated to this node if it is a table node.

- Method SchemaNode.getBusinessObjectModel(Adaptation,Session)

  Returns the business object model associated to this node if it is a table node.

- Method SchemaNode.getFacetOnMandatoryField()

  Returns the facet corresponding to the cardinality constraint related to a mandatory field (declares both minOccurs=1 and maxOccurs=1).

- Method SchemaNode.getNodeChildren(boolean)

  Returns the data model nodes defined directly under this node.

- Method SchemaNode.getRelationships(Adaptation,Session,boolean)

  Returns the relationships defined by this node.

- Method SchemaNode.getSchemaDefaultTableView()

  Returns the default table view properties for this node, as defined in the data model.

- Method SchemaNode.getSchemaLinkedField()

  Returns the information for a linked field.

- Method SchemaNode.getTableEntityName()

  Returns the entity name of this node if this node is a table node.

- Method SchemaNode.isLinkedNode()

  Returns true if this node is a linked node.

- Method TableRefFilterContext.setPrefilter(String)

  Specifies an XPath filter that will be applied before evaluating TableRefFilter.

### com.orchestranetworks.schema.businessObjects

- Interface BusinessObjectModel

  Represents the definition of a business object in the context of a data model.

- Interface BusinessObjectModelRelationship

  Represent a relationship in the context of a business object model.

- Interface ChildEntity

  Provides a read-only access facade to a record related to the main record of a business object.

- Interface DataModelBusinessObjectModels

  Holds the business object models defined in a data model.

- Interface Entity

  Provides a read-only access facade to a record of a business object.

- Interface MainEntity

  Provides a facade to the main record of a business object.

### com.orchestranetworks.schema.dynamic

- Method BeanElement.addFacetEnumeration(java.util.List)

  Sets a list of possible values for this element.

- Method BeanElement.setDefaultViewMode(DefaultViewMode)

  Sets the default view mode.

- Method BeanElement.setDisableTrimAtUserInput(boolean)

  Specifies if leading and trailing whitespaces must be preserved upon user input.

- Enum DefaultViewMode

  List of default view modes used to define how a group or association is displayed.

### com.orchestranetworks.schema.info

- Method AssociationLink.isConsistent(Adaptation)

  Returns true if this association is consistent with the specified record or dataset.

- Method SchemaFacet.getFacetValidationMessage()

  Returns the validation message defined in the data model.

- Method SchemaFacet.getSchemaNode()

  Returns the node associated to this facet.

- Method SchemaFacet.isFacetOnMandatoryField()

  Returns true if this facet is related to a mandatory field (defines both minOccurs="1" maxOccurs="1").

- Enum SchemaFacetBlocksCommit

  Represents the blocking policy defined by a facet using the property osd:validation/blocksCommit.

- Method SchemaFacetEnumeration.isConstraintEnumeration()

  Returns true if this enumeration is programmatic (declared using the element osd:constraintEnumeration).

- Method SchemaFacetEnumeration.isEnumerationStatic()

  Returns true if this enumeration is static (declared using the element xs:enumeration).

- Interface SchemaFacetOnMandatoryField

  This interface corresponds to a cardinality constraint on a mandatory field (defines both minOccurs="1" and maxOccurs="1").

- Method SchemaFacetTableRef.getXPathFilter()

  Returns the XPath filter defined on this foreign key constraint.

- Interface SchemaFacetValidationMessage

  Represents the validation messages defined by a facet in a data model.

- Interface SchemaLinkedField

  This interface contains the information for a linked node (node that defines osd:function linkedField="aPath" property).

- Interface SchemaNodeBreadcrumbProperties

  Represents the breadcrumb element associated with a table, a foreign key or an association node in a resolved data model.

- Method SchemaNodeDefaultView.isHiddenInAllViews()

  Returns true if the associated node is hidden in all views of a table.

- Method SchemaNodeDefaultView.isHiddenInQuickSearch()

  Returns true if the associated node is hidden in the quick search tool.

- Method UniquenessConstraint.getCaseSensitivity()

  Returns the case sensitivity used to check string fields defined in the uniqueness constraint.

### com.orchestranetworks.schema.metadata

- Interface SchemaMetadataConstants

  This interface contains the paths to the nodes that hold the metadata associated to table records.

### com.orchestranetworks.schema.relationships

- Method SchemaNodeExplicitRelationship.getBreadcrumbProperties()

  Returns the properties defined in the data model (property breadcrumb) related to the breadcrumb displayed in the user interface.

- Method SchemaNodeExplicitRelationship.getTableNode(Adaptation)

  Returns the table node referred to by this link in the context of the specified dataset.

- Method SchemaNodeExplicitRelationship.isDynamic()

  Returns true if this relationship refers to a dataset that is not statically defined in the data model.

- Method SchemaNodeRelationships.getExplicitRelationships(boolean)

  Returns the explicit relationships defined by the associated node.

### com.orchestranetworks.schema.trigger

- Interface AfterDuplicateInstanceContext

  Provides an execution context for handling post-dataset duplication operations.

- Interface AfterModifyInstanceContext

  Provides a context for executing operations after modifying dataset fields.

- Interface BeforeModifyInstanceContext

  Provides a context for executing operations before modifying dataset fields.

- Method InstanceTrigger.handleAfterDuplicate(AfterDuplicateInstanceContext)

  This method is called after the duplication of a dataset This method is invoked even if ProcedureContext.

- Method InstanceTrigger.handleAfterModify(AfterModifyInstanceContext)

  This method is called after the modification of a field outside a table.

- Method InstanceTrigger.handleBeforeModify(BeforeModifyInstanceContext)

  This method is called before the modification of a field outside a table.

### com.orchestranetworks.search.strategy

- Class SearchStrategyKey

  Identifies a search strategy.

- Interface StopWordsDeclaration

  This interface represents a list of stop words to be declared in a module.

- Class StopWordsKey

  Identifies a stop word list.

- Interface SynonymDeclaration

  This interface represents a list a synonyms to declare in a module.

- Interface SynonymPair

  Represents a pair of synonyms.

- Class SynonymsKey

  Identifies a Synonyms list.

### com.orchestranetworks.search.template

- Interface SearchTemplate

  The main interface to implement for a search template.

- Class SearchTemplateKey

  Identifies a search template.

- Interface SearchTemplateManager

  Provides access to the declared search templates.

### com.orchestranetworks.service

- Method AccessPermission.max(java.util.function.Supplier)

  Returns the least restrictive between this permission, and the permission supplied by the specified function.

- Method AccessPermission.min(java.util.function.Supplier)

  Returns the most restrictive between this permission, and the permission supplied by the specified function.

- Constructor MergeSpecForInstanceContents(boolean)

  Constructor that allows specifying whether to include all content types.

- Method ProcedureContext.doCreateOccurrence(ValueContext,AdaptationTable,UserReference,java.util.Date,UserReference,java.util.Date)

  Creates a record in the specified table with the specified system metadata.

- Constant ServiceKey.HIERARCHY_ATTACH

  Built-in service to attach nodes in a hierarchical view.

- Constant ServiceKey.HIERARCHY_DETACH

  Built-in service to detach nodes in a hierarchical view.

- Constant ServiceKey.MY_PROFILE

  Built-in service to access current user's profile settings.

- Method Session.isUserOwner(AdaptationHome)

  Returns true if this user is an owner of the specified dataspace.

- Method SessionPermissions.getGlobalPermissionToIde()

  Returns whether the user has permission to access the IDE user interface.

- Method URLQuery.format()

- Method URLQuery.format(String)

- Method ValidationReport.hasTooManyItemsOfConstraint(SchemaFacet)

  Returns true if the message threshold has been reached by the specified constraint.

- Method ValidationReportItem.getBlocksCommit()

  Returns the blocking policy associated with this item.

- Method ValidationReportItem.getFacet()

  Returns the facet that is associated with this item, null if no facet is associated with this item.

- Method ValidationReportItemIterator.close()

  Closes this iterator, relinquishing any underlying resources.

- Method ValidationReportItemSubject.isDatasetOrRecordSubject()

  Returns true if it represents the subject of a validation report item in the context of a dataset or record.

- Method ValidationReportItemSubject.isTableSubject()

  Returns true if it represents the subject of a validation report item in the context of a table.

- Enum ValueContextForUpdate.ValidationPolicy

  Defines the policy for validating this content.

- Method ValueContextForUpdate.getValidationReport()

  Returns the validation report of this content.

- Method ValueContextForUpdate.getValidationReport(ValueContextForUpdate.ValidationPolicy)

  Returns the validation report of this content.

- Method ValueContextForUpdate.setValue(Object,SchemaNode)

  Sets the value of the specified node.

- Method ValueContextForUpdate.setValueFromXsString(String,SchemaNode)

  Sets the string value specified.

### com.orchestranetworks.service.comparison

- Method DifferenceHelper.compareDatasetByDate(Adaptation,boolean,java.util.Date,java.util.Date)

  Performs a comparison between two transaction dates for a dataset and returns the result.

- Method DifferenceHelper.compareDatasetByDate(Adaptation,java.util.Date,java.util.Date)

  Performs a comparison between two transaction dates for a dataset and returns the result.

- Method DifferenceHelper.compareDatasetByTransactionID(Adaptation,boolean,long,long)

  Performs a comparison between two transaction for a dataset and returns the result.

- Method DifferenceHelper.compareDatasetByTransactionID(Adaptation,long,long)

  Performs a comparison between two transaction for a dataset and returns the result.

- Method DifferenceHelper.compareDataspaceByDate(AdaptationHome,boolean,java.util.Date,java.util.Date)

  Performs a comparison between two transaction dates for a dataspace and returns the result.

- Method DifferenceHelper.compareDataspaceByDate(AdaptationHome,java.util.Date,java.util.Date)

  Performs a comparison between two transaction dates for a dataspace and returns the result.

- Method DifferenceHelper.compareDataspaceByTransactionID(AdaptationHome,boolean,long,long)

  Performs a comparison between two transactions for a dataspace or a snapshot and returns the result.

- Method DifferenceHelper.compareDataspaceByTransactionID(AdaptationHome,long,long)

  Performs a comparison between two transactions for a dataspace or a snapshot and returns the result.

- Method DifferenceHelper.compareRecordByDate(Adaptation,boolean,java.util.Date,java.util.Date)

  Performs a comparison between two dates for a record and returns the result.

- Method DifferenceHelper.compareRecordByDate(Adaptation,java.util.Date,java.util.Date)

  Performs a comparison between two dates for a record and returns the result.

- Method DifferenceHelper.compareRecordByTransactionID(Adaptation,boolean,long,long)

  Performs a comparison between two transaction times for a record and returns the result.

- Method DifferenceHelper.compareRecordByTransactionID(Adaptation,long,long)

  Performs a comparison between two transaction times for a record and returns the result.

- Method DifferenceHelper.compareTableByDate(AdaptationTable,boolean,java.util.Date,java.util.Date)

  Performs a comparison between two dates for a table and returns the result.

- Method DifferenceHelper.compareTableByDate(AdaptationTable,java.util.Date,java.util.Date)

  Performs a comparison between two dates for a table and returns the result.

- Method DifferenceHelper.compareTableByTxId(AdaptationTable,boolean,long,long)

  Performs a comparison between two transaction times for a table and returns the result.

- Method DifferenceHelper.compareTableByTxId(AdaptationTable,long,long)

  Performs a comparison between two transaction times for a table and returns the result.

### com.orchestranetworks.service.directory

- Method Directory.hasUsersInRole(Role)

  Returns true if one or more users have the specified role.

- Method DirectoryDefault.formerEncryptString(String)

  Returns the encrypted string corresponding to the 'clear-text' password specified, as per releases prior to 6.

- Method DirectoryDefault.hasUsersInRole(Role)

  Returns true if one or more users have the specified role.

- Method DirectoryDefault.hashPassword(String,String)

  Returns the SHA-512 hash of the password, and uses the login as salt.

- Method DirectoryHandler.hasUsersInRole(Role)

- Class EncryptPassword

  Provides a EBX® Default Directory Utility to encrypt a user password.

- Interface HashComputation

  Defines an interface to compute the hash of a password.

### com.orchestranetworks.service.directory.ldap

- Class LdapDirectoryFactory

  Built-in LDAP directory factory for EBX®.

### com.orchestranetworks.staging.permission

- Class StgPermissionsBridge

  Deprecated.

### com.orchestranetworks.ui

- Method JavaScriptCatalog.ebx_form_setMandatoryIndicator(String,boolean)

  Adds or removes a mandatory indicator (*) next to the label of the specified node to simulate that it is mandatory.

- Method JavaScriptCatalog.ebx_getWorkspaceTitle()

  Gets the title of the current workspace in which the component is running.

- Constant UIButtonIcon.BINOCULARS

- Constant UIButtonIcon.BLOCK_COLLAPSE

- Constant UIButtonIcon.BLOCK_EXPAND

- Constant UIButtonIcon.DYNAMIC_HIDDEN

- Constant UIButtonIcon.FIND_NEXT

- Constant UIButtonIcon.FIND_PREVIOUS

- Constant UIButtonIcon.FULLSCREEN_OFF

- Constant UIButtonIcon.FULLSCREEN_ON

- Constant UIButtonIcon.NO_SEARCH

- Constant UIButtonIcon.SORT_BY_RELEVANCY

- Constant UIHttpManagerComponent.ViewFeatures.SEARCH_PANE

  Workspace search pane.

- Method UIHttpManagerComponent.createWithURIWithParameters(String)

  Creates an instance of this class in order to call the EBX® user interface from an external application.

- Method UIHttpManagerComponent.createWithURIWithParametersForSubSession(String,Session)

  Creates an instance of this class in order to call the EBX® user interface in a separate sub-session (namely, a Web Component).

- Method UIHttpManagerComponent.getWorkflowView()

  Returns the workflow view using the service ServiceKey.

- Method UIHttpManagerComponent.selectPerspective(String)

  Selects the specified perspective.

- Method UIHttpManagerComponent.selectPerspectiveAction(String,String)

  Selects the specified perspective action.

- Method UIHttpManagerComponentHelper.getReturnCodeFromHttpRequest(jakarta.servlet.ServletRequest)

  Extracts the return code generated by the EBX® Web Component; returns null if no return code is set in the request.

- Method UIJavaScriptWriter.addJS_switchToPerspectiveAction(String,String)

  Changes the page of the highest EBX® frame to the specified perspective action.

- Method UILabelRendererContext.getCurrentPerspective()

  Returns the current perspective.

- Method UILabelRendererContext.getCustomViewContext()

  Returns the view context.

- Method UILabelRendererForHierarchyContext.getMember()

  Returns the current hierarchy member being displayed.

- Method UIResourceLocator.getURLForPerspectiveSelection(String)

  Returns a URL that, when used, changes the current navigation context to the specified perspective action.

- Method UIResourceLocator.getURLForPerspectiveSelection(String,String)

  Returns a URL that, when used, changes the current navigation context to the specified perspective action.

- Method UITableFilterContext.getCustomViewContext()

  Returns the view context.

### com.orchestranetworks.ui.form

- Method UIFormContext.getCurrentPerspective()

  Returns the current perspective.

- Method UIFormContext.getCustomViewContext()

  Returns the view context.

- Method UIFormWriter.addJS_setNodeMandatoryIndicator(boolean,Path)

  Adds or removes a mandatory indicator (*) next to the label of the specified node to simulate that it is mandatory.

### com.orchestranetworks.ui.form.widget

- Method UITable.getRowToolbar()

  Returns the programmatic toolbar to display on row.

- Method UITable.getRowToolbarName()

  Returns the name of the toolbar to display on row.

- Method UITable.getTopToolbar()

  Returns the programmatic toolbar to display on top.

- Method UITable.getTopToolbarName()

  Returns the name of the toolbar to display on top.

- Method UITable.isRowToolbarHidden()

  Returns true if row toolbars are hidden.

- Method UITable.isTopToolbarHidden()

  Returns true if table toolbar is hidden.

- Method UITable.setRowToolbar(Toolbar)

  Specifies the programmatic toolbar to display on row.

- Method UITable.setRowToolbarHidden(boolean)

  Specifies if table should display its toolbars on rows.

- Method UITable.setRowToolbarName(String)

  Specifies the name of the toolbar to display on row.

- Method UITable.setTopToolbar(Toolbar)

  Specifies the programmatic toolbar to display on top.

- Method UITable.setTopToolbarHidden(boolean)

  Specifies if table should display its toolbar.

- Method UITable.setTopToolbarName(String)

  Specifies the name of the toolbar to display on top.

- Method WidgetDisplayContext.getCurrentPerspective()

  Returns the current perspective.

- Method WidgetDisplayContext.getCustomViewContext()

  Returns the view context.

- Method WidgetDisplayContext.getHierarchyMember()

  Returns the current hierarchy member if the current UIBeanEditor is instantiated in the context of a hierarchy.

- Method WidgetDisplayContext.isInherited()

  Returns true if the displayed value is inherited.

### com.orchestranetworks.ui.perspective

- Enum DisplayDensity

  Represents the display density mode.

- Interface Perspective

  Interface that provides information about a perspective.

- Interface PerspectiveAction

  Interface that represents the action of a perspective item.

- Interface PerspectiveActionItem

  Interface that represents a perspective action item.

- Class PerspectiveHandler

  An instance of this class offers methods to retrieve the perspectives defined in the current repository.

- Interface PerspectiveIcon

  Interface that represents an icon of a perspective menu item.

- Enum PerspectiveIconType

  Enumerates the different types of icons.

- Interface PerspectiveItem

  Interface that represents a perspective item.

- Interface PerspectiveItemContainer

  Interface representing an item that can have children.

- Enum PerspectiveItemType

  Lists the different items of the perspective menu.

- Interface PerspectiveItemWithIcon

  Interface that represents an item that can have an icon.

- Interface PerspectiveSectionItem

  Interface that represents an item of a perspective section.

- Interface PerspectiveTheme

  Interface that represents a perspective theme.

### com.orchestranetworks.ui.toolbar

- Method ToolbarButton.setDescription(String)

  Sets the description of the button.

- Method ToolbarButton.setDescription(UserMessage)

  Sets the description of the button.

- Method ToolbarButton.setHighlighted(boolean)

  Defines if this button should be highlighted.

- Constant ToolbarLocation.CUSTOM_LOCATION

  Menu displayed in a custom location.

- Constant ToolbarLocation.SIDEBAR

  Menu displayed as a sidebar in the app.

- Constant ToolbarLocation.TILE_VIEW

  Toolbar displayed on each tile of a tile view.

- Method ToolbarLocation.getCustomToolbarLocation(ServicePermissionRuleContext)

  Returns the custom toolbar location contextual information.

- Method ToolbarLocation.isCustom()

- Method ToolbarLocation.isSidebar()

- Method ToolbarLocation.isTileViewRow()

### com.orchestranetworks.ui.view

- Interface TileDescription

  Provides information on tile view description.

- Interface TileImage

  Provides information on tile view Image.

- Interface UICustomViewContext

  Provides information on custom view context.

- Interface UICustomViewKey

  Provides information on custom view key.

- Class UICustomViewKeyFactory

  Provides factory methods to create UICustomViewKeys.

- Interface UIHierarchicalView

  Provides information on hierarchical view.

- Interface UITabularView

  Provides information on tabular view.

- Interface UITileView

  Provides information on tile view.

- Interface UIView

  Provides information on custom view.

### com.orchestranetworks.userservice

- Interface UserServiceForCreate

  Extended interface that can be implemented by a user service replacing a creation form.

- Interface UserServiceGetCreatedRecordContext

  This interface defines methods to get contextual information about the user service being invoked.

- Method UserServicePaneContext.getCustomViewContext()

  Returns the view context.

- Method UserServiceRequest.getCurrentPerspective()

  Returns the current perspective.

### com.orchestranetworks.userservice.declaration

- Method UserServiceDeclaration.createUserService()

  Creates a new user service implementation.

- Method UserServicePropertiesDefinitionContext.setDescriptionForConfiguration(String)

  Defines the service description to be displayed in a configuration context.

- Method UserServicePropertiesDefinitionContext.setDescriptionForConfiguration(UserMessage)

  Defines the service description to be displayed in a configuration context.

- Method UserServicePropertiesDefinitionContext.setLabelForConfiguration(String)

  Defines the service label to be displayed in a configuration context.

- Method UserServicePropertiesDefinitionContext.setLabelForConfiguration(UserMessage)

  Defines the service label to be displayed in a configuration context.

### com.orchestranetworks.workflow

- Method CreationWorkItemSpec.forAllocationWithPossibleReallocation(UserReference,java.util.Collection)

  Allows to create a work item allocated to the specified user with the possibility to reallocate to a profile contained in offeredToProfiles.

- Method ProcessInstanceStep.isHiddenInProgressView()

  Indicates if the step has been defined as hidden in the progress view.

- Class ProcessLauncher

  Prepares and launches a workflow instance.

- Interface ProcessLauncherResult

  Represents the result of a workflow instance launcher.

- Class PublicationSpec

  Specifications for publishing a single workflow.

- Enum PublicationSpec.PublicationMode

  Retrieves the mode of the publication.

- Method SubWorkflowsCreationContext.setForegroundSubWorkflow(ProcessLauncher)

  Registers which sub-workflow should be opened, accordingly to the progress strategy of the previous step.

- Method UserTask.WorkItem.isCommentEnabled()

  Returns true if the comment is enabled for the work item (enable the comment is specified in the user task definition Reference: Enable Comments radio button).

- Method WorkflowEngine.getFromUserServiceContext(UserServiceRequest)

  Creates a workflow engine from a user service context.

- Method WorkflowEngine.getProcessInstanceKeysForDataContextVariableIncludingHistory(PublishedProcessKey,String,String)

  Retrieves process instance keys for a data context variable, including search in publication history.

- Method WorkflowEngine.isUserAuthorizedToLaunch(PublishedProcessKey)

  Returns true if the user of the current session is authorized to launch a workflow for the specified publication key.

- Method WorkflowEngine.unPublish(PublishedProcessKey,boolean,UserReference)

  Unpublishes a workflow process publication.

- Class WorkflowLauncherInfo

  Represents information about a workflow launcher activation, including details about the launcher, associated documentation, and context variables.

- Class WorkflowLauncherInfoHelper

  This class provides utility methods for retrieving and processing information about available workflow launcher activations.

- Interface WorkflowPublisher

  Publishes one or more workflow.

## Deprecated elements

### com.onwbp.adaptation

- Method AdaptationHome.findParent(Adaptation)

  Replaced by Adaptation.getParent().

- Method AdaptationHome.getValidationReportsMap(Severity)

  since 6.1.1.

- Method AdaptationHome.isMarkedForPurge()

- Method AdaptationTable.getRootKey()

  Does not work for mapped tables.

- Class InvalidChangeError

  Exception thrown when an operation is not allowed.

- Method PrimaryKey.parseList(java.util.List)

  This method does not support the use of certain characters in the elements of the specified List.

- Method RequestResult.refresh()

  This method does not do anything: in accordance to Query snapshot isolation, the result is frozen when Request.execute() is called.

- Method RequestResult.refreshIfNeeded()

  This method does not do anything: in accordance to Query snapshot isolation, the result is frozen when Request.execute() is called.

### com.orchestranetworks.d3

- Method D3Broadcast.getDeliveryStatus()

  Global delivery status depending on the delivery mode ('Cluster' or 'Federation').

- Class D3Engine

  Represents the external view of the D3 engine and offers master administrative functionalities.

- Method D3Engine.broadcast(VersionKey)

  Since 5.2.7.

- Method D3NodeAsMaster.getD3SlaveFromId(String)

  Since 5.5.1, this method has been replaced by getD3SlaveFromRepositoryLabel(String).

- Method D3NodeAsMaster.getD3SlaveFromRepositoryId(String)

  Since 5.5.1, this method has been replaced by D3Node.getD3SlaveFromRepositoryId(String).

- Method D3NodeAsMaster.getD3SlaveFromRepositoryLabel(String)

  Since 5.5.1, this method has been replaced by D3Node.getD3SlaveFromRepositoryLabel(String).

- Method D3NodeAsMaster.getRegisteredSlaves(BranchKey)

  Since 5.5.1, this method has been replaced by D3Node.getRegisteredSlaves(BranchKey).

- Method D3Slave.getSlaveId()

  Since 5.5.0, this method has been replaced by getRepositoryLabel().

### com.orchestranetworks.dataservices.rest

- Constant Constants.Data.KEY_TECHNICALS_CREATION_DATE

  since 6.1.0, replaced by KEY_TECHNICALS_CREATION_TIME.

- Constant Constants.Data.KEY_TECHNICALS_CREATION_USER

  since 6.1.0, replaced by KEY_TECHNICALS_CREATOR.

- Constant Constants.Data.KEY_TECHNICALS_LAST_UPDATE_DATE

  since 6.1.0, replaced by KEY_TECHNICALS_UPDATE_TIME.

- Constant Constants.Data.KEY_TECHNICALS_LAST_UPDATE_USER

  since 6.1.0, replaced by KEY_TECHNICALS_UPDATER.

- Constant Constants.Data.PARAM_CHECK_NOT_CHANGED_SINCE_LAST_UPDATE_DATE

  since 6.1.0, replaced by #PARAM_CHECK_NOT_CHANGED_SINCE_LAST_UPDATE_TIME.

- Constant Constants.Data.PARAM_COUNT

  since 6.0.0, replaced by URL_ACTION_COUNT.

- Constant Constants.Data.PARAM_INCLUDE_TECHNICALS

  since 6.1.0, replaced by PARAM_INCLUDE_METADATA with 'system' value.

- Constant Constants.Data.PARAM_INDENT

  since 6.0.0, replaced by PARAM_EBX_INDENT.

- Constant Constants.Data.PARAM_INHERIT_IF_IN_OCCULTING_MODE

  Since 5.8.1 due to simplification of the delete operation when attempting to change a record's inheritance from occult to inherit.

- Constant Constants.Error.KEY_ERRORS_SEVERITY

  since 6.0.0, replaced by KEY_ERRORS_LEVEL.

- Constant Constants.Meta.PARAM_INCLUDE_META

  since 6.1.0, replaced by PARAM_INCLUDE_METAMODEL.

- Constant Constants.Pagination.PARAM_PAGE_FIRST_RECORD_FILTER

  Since 5.9.0 and replaced by PARAM_PAGE_RECORD_FILTER.

- Constant Constants.Pagination.PARAM_PAGE_SIZE_UNBOUNDED_VALUE

  Since 6.0.0, the pagination becomes required.

- Class RESTEncodingHelper

  Helper for REST encoding.

### com.orchestranetworks.instance

- Method HomeCreationSpec.isRelationalModeDataSpace()

  since 6.0.

- Method HomeCreationSpec.setRelationalModeDataSpace(boolean)

  since 6.0.

- Method Repository.markHomeForPurge(AdaptationHome,Session)

  Replaced by deleteHome(AdaptationHome, Session).

- Method Repository.purgeHomes(Session)

  Replaced by purgeAll.

- Method RepositoryPurge.markHomeForPurge(AdaptationHome,Session)

  Replaced by Repository.deleteHome(AdaptationHome, Session).

- Method ValueContextForValidationOnRecord.removeRecordFromMessages(ValueContext)

### com.orchestranetworks.interactions

- Method InteractionHelper.complete(InteractionHelper.ParametersMap,Session)

  Replaced by SessionInteraction.complete(com.orchestranetworks.interactions.InteractionHelper.ParametersMap).

- Method InteractionHelper.getInputParameters(Session)

  Replaced by SessionInteraction.getInputParameters().

- Method InteractionHelper.getInternalParameters(Session)

  Replaced by SessionInteraction.getInternalParameters().

- Method InteractionHelper.isComplete(Session)

  Replaced by SessionInteraction.isComplete().

- Method InteractionHelper.setInternalParameters(InteractionHelper.ParametersMap,Session)

  Replaced by SessionInteraction.setInternalParameters(com.orchestranetworks.interactions.InteractionHelper.ParametersMap).

### com.orchestranetworks.schema

- Interface ConstraintNomenclature

  This interface specifies a nomenclature constraint that can be contextual and dynamic.

- Method SchemaLocation.getInputStream()

  Returns a stream for reading the content of the corresponding data model.

- Constant SchemaTypeName.XS_NMTOKEN

  Built-in data type xs:NMTOKEN.

- Constant SchemaTypeName.XS_NMTOKENS

  Built-in XML Schema data type xs:NMTOKENS.

### com.orchestranetworks.service

- Method ImportResult.getCreatedRecords()

  this method returns an internal object.

- Method ImportSpec.isUpdateByDelta()

  Since version 5.2.4, this method has been replaced by isByDelta.

- Method ImportSpec.setUpdateByDelta(boolean)

  Since version 5.2.4, this method has been replaced by setByDelta.

- Method ProcedureContext.disableDatasetValidation(Adaptation)

  Since 6.0.0, incremental validation is no longer triggered by a procedure.

- Method ProcedureContext.doCreateOverwriting(ValueContext,AdaptationTable)

- Method ProcedureContext.doCreateRoot(ValueContext,AdaptationTable)

  Creates a new root dataset.

- Method ProcedureContext.isPrivilegeToModifyReferenceBranch()

  Since version 5.0.0, the 'Reference' dataspace no longer has restricted behavior concerning direct modifications.

- Method ProcedureContext.setBatch()

  since 6.0.

- Method ProcedureContext.setPrivilegeToModifyReferenceBranch(boolean)

  Since version 5.0.0, the 'Reference' dataspace no longer has restricted behavior concerning direct modifications.

- Class ServiceContext

  This class provides the necessary context and navigation functions for integrating legacy user services.

- Method SessionPermissions.getSession()

  Since 5.4.1, this method returns null if this instance has been created directly to evaluate user permissions.

- Method ValidationReport.hasTooManyItemsOfSeverity(Severity)

  Since 6.0.

### com.orchestranetworks.service.directory

- Method Directory.getUserAuthenticationURI(Session)

  Since 6.1.3, it is recommended to use the property ebx.security.loginPage.url instead.

- Method DirectoryHandler.getUserAuthenticationURI(Session)

  Since 6.1.3, see Directory.getUserAuthenticationURI(Session).

### com.orchestranetworks.staging.permission

- Class StgPermissionsBridge

  Deprecated.

### com.orchestranetworks.ui

- Method UIAjaxContext.getServiceContext()

  From release 6.0, this API is no longer supported.

- Class UIBeanEditor

  Abstract class for customizing UI beans on master data.

- Method UIBeanEditor.addForPrint(UIResponseContext)

  This method is no longer invoked.

- Class UIBeanEditorV4

  Abstract class for implementing UIBeanEditor written in versions 4.

- Constant UICSSClasses.SMALL_FORM_BUTTONS

  Since 5.9.0, buttons in form are no more smaller than other buttons.

- Interface UIContext

  Common abstract class for UIBeanEditor contexts.

- Method UIContext.displayOccurrence(Object,boolean)

  Replaced by WidgetDisplayContext.displayOccurrence(Object, boolean).

- Method UIContext.getHierarchyMember()

  Replaced by WidgetDisplayContext.getHierarchyMember().

- Method UIContext.getHierarchyNode()

  Replaced by getHierarchyMember().

- Method UIContext.getLocale()

  Replaced by UISessionContext.getLocale().

- Method UIContext.getNode()

  Replaced by SchemaNode.getNode(Path) from WidgetDisplayContext.getNode().

- Method UIContext.getNode(Path)

  Replaced by SchemaNode.getNode(Path) from WidgetDisplayContext.getNode().

- Method UIContext.getPathForListOccurrence(int)

  Replaced by WidgetWriterForList.getPathForListOccurrence(int, boolean) Replaced by WidgetListValidationContext.getPathForListOccurrence(int, boolean).

- Method UIContext.getPathForListOccurrence(int,boolean)

  Replaced by WidgetWriterForList.getPathForListOccurrence(int, boolean) Replaced by WidgetListValidationContext.getPathForListOccurrence(int, boolean).

- Method UIContext.getPathInAdaptation()

  Replaced by SchemaNode.getPathInAdaptation() from WidgetDisplayContext.getNode().

- Method UIContext.getSession()

  Replaced by UISessionContext.getSession().

- Method UIContext.getValue()

  Replaced by ValueContext.getValue(Path) from WidgetDisplayContext.getValueContext().

- Method UIContext.getValue(Path)

  Replaced by ValueContext.getValue(Path) from WidgetDisplayContext.getValueContext().

- Method UIContext.getWebName()

  Replaced by WidgetWriter.getWidgetName() Replaced by WidgetValidationContext.getWidgetName().

- Method UIContext.getWebNameFor(String)

  Replaced by WidgetWriter.getWidgetName(String) Replaced by WidgetValidationContext.getWidgetName(String).

- Method UIContext.getWebNameForPath(Path)

  Replaced by WidgetWriter.getWidgetName(Path) Replaced by WidgetValidationContext.getWidgetName(Path).

- Method UIContext.getWebNameOfParent()

  Replaced by WidgetWriter.getWidgetNameOfParent() Replaced by WidgetValidationContext.getWidgetNameOfParent().

- Method UIContext.isCreatingRecord()

  Replaced by WidgetDisplayContext.isCreatingRecord().

- Method UIContext.isDuplicatingRecord()

  Replaced by WidgetDisplayContext.isDuplicatingRecord().

- Method UIFormSpec.setMarginForContent(boolean)

  Since 5.4.0 which provides new look & feel.

- Constant UIHttpManagerComponent.DataSetFeatures.BREADCRUMB

  This constant is no longer used.

- Constant UIHttpManagerComponent.RecordFeatures.BREADCRUMB

  This constant is no longer used.

- Constant UIHttpManagerComponent.ViewFeatures.BREADCRUMB

  This constant is no longer used.

- Method UIHttpManagerComponent.createOnAjaxContext(UIAjaxContext)

  This method has been replaced by UIResourceLocator.createWebComponentForSubSession().

- Method UIHttpManagerComponent.createOnServiceContext(ServiceContext)

  This method has been replaced by UIResourceLocator.createWebComponentForSubSession().

- Method UIHttpManagerComponent.createOnUIBeanContext(UIResponseContext)

  This method has been replaced by UIResourceLocator.createWebComponentForSubSession().

- Method UIHttpManagerComponent.createOnUILabelRendererForHierarchyContext(UILabelRendererForHierarchyContext)

  This method has been replaced by UIResourceLocator.createWebComponentForSubSession().

- Method UILabelRendererForHierarchyContext.getHierarchyNode()

  Returns the current hierarchy node being displayed.

- Constant UIRenderingMode.PRINT

- Method UIRenderingMode.isPrint()

- Interface UIRequestContext

  Encapsulates an HTTP request so that a bean editor can provide the user input validation context.

- Method UIRequestContext.getOptionalRequestParameterValue(String)

  Replaced by WidgetDisplayContext.getOptionalRequestParameterValue(String).

- Method UIRequestContext.getOptionalRequestParameterValues(String)

  Replaced by WidgetDisplayContext.getOptionalRequestParameterValues(String).

- Method UIRequestContext.getValueContext()

  Replaced by WidgetDisplayContext.getValueContext(Path).

- Method UIRequestContext.getValueContext(Path)

  Replaced by WidgetDisplayContext.getValueContext(Path).

- Interface 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.

- Method UIResponseContext.addComboBox(Path)

  please use newComboBox(Path) and addWidget(UIWidget).

- Method UIResponseContext.addComboBox(form.widget.UIComboBox)

  please use newComboBox(Path) and addWidget(UIWidget).

- Method UIResponseContext.addEmptyFieldButton(String,boolean,String)

  Replaced by WidgetWriter.addEmptyFieldButton(String, boolean, String).

- Method UIResponseContext.addFormRow(form.UIFormRow)

  Replaced by UIFormWriter.addFormRow(UIWidget).

- Method UIResponseContext.addFormRow(form.UIFormRow,form.widget.UIWidget)

  Replaced by UIFormWriter.addFormRow(UIWidget).

- Method UIResponseContext.addFormRow(form.widget.UIWidget)

  Replaced by UIFormWriter.addFormRow(UIWidget).

- Method UIResponseContext.addFormRowBestMatchingComponent(Path)

  Replaced by UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIFormWriter.addFormRow(UIFormRow).

- Method UIResponseContext.addFormRowBestMatchingComponent(Path,boolean)

  Replaced by UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIFormWriter.addFormRow(UIFormRow).

- Method UIResponseContext.addFormRowBestMatchingDisplay(Path)

  Replaced by UIFormWriter.newBestMatching(Path), UIWidget.setEditorDisabled(boolean), UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIFormWriter.addFormRow(UIFormRow, UIWidget).

- Method UIResponseContext.addFormRowBestMatchingDisplay(Path,boolean)

  Replaced by UIFormWriter.newBestMatching(Path), UIWidget.setEditorDisabled(boolean), UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIFormWriter.addFormRow(UIFormRow, UIWidget).

- Method UIResponseContext.addFormRowBestMatchingEditor(Path)

  Replaced by UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIFormWriter.addFormRow(UIFormRow).

- Method UIResponseContext.addFormRowBestMatchingEditor(Path,boolean)

  Replaced by UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIFormWriter.addFormRow(UIFormRow).

- Method UIResponseContext.addJS_getNodeValue(Path)

  Replaced by UIFormWriter.addJS_getNodeValue(Path).

- Method UIResponseContext.addJS_setNodeValue(String,Path)

  Replaced by UIFormWriter.addJS_setNodeValue(String, Path).

- Method UIResponseContext.addServiceButton(Path)

  Replaced by WidgetWriter.addServiceButton(Path).

- Method UIResponseContext.addUIBean(Path,String)

  please use addWidget(Path).

- Method UIResponseContext.addUIBestMatchingComponent(Path,String)

  please use addWidget(Path).

- Method UIResponseContext.addUIBestMatchingDisplay(Path,String)

  please use newBestMatching(Path), UIWidget.setEditorDisabled(boolean) and addWidget(UIWidget).

- Method UIResponseContext.addUIBestMatchingDisplay(Path,UIRenderingMode,String)

  please use newBestMatching(Path), UIWidget.setEditorDisabled(boolean) and addWidget(UIWidget).

- Method UIResponseContext.addUIBestMatchingEditor(Path,String)

  please use addWidget(Path).

- Method UIResponseContext.addUICheckBox(Path,String)

  please use newCheckBox(Path) and addWidget(UIWidget).

- Method UIResponseContext.addUICheckBox(int,Path,String)

  please use newCheckBox(Path) and addWidget(UIWidget).

- Method UIResponseContext.addUICheckBoxGroup(Path,String)

  please use newCheckBoxGroup(Path), UICheckBoxGroup.setColumnsNumber(int) (instead of htmlSeparator), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUICheckBoxGroup(Path,String,Nomenclature)

  please use newCheckBoxGroup(Path), UICheckBoxGroup.setColumnsNumber(int) (instead of htmlSeparator), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUICheckBoxGroup(Path,String,String)

  please use newCheckBoxGroup(Path), UICheckBoxGroup.setColumnsNumber(int) (instead of htmlSeparator), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUICheckBoxGroup(Path,String,String,Nomenclature)

  please use newCheckBoxGroup(Path), UICheckBoxGroup.setColumnsNumber(int) (instead of htmlSeparator), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUIComplexEditor(Path,String)

  please use addWidget(Path).

- Method UIResponseContext.addUIDescription(Path)

  Replaced by WidgetWriter.addUIDescription(Path).

- Method UIResponseContext.addUIDisplayValue(Path)

  Replaced by WidgetWriter.addUIDisplayValue(Path).

- Method UIResponseContext.addUIDropDownBox(Path,String)

  please use newDropDownList(Path), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUIDropDownBox(Path,String,Nomenclature)

  please use newDropDownList(Path), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUIDropDownBoxMultiple(Path,String)

  please use newListBox(Path) and addWidget(UIWidget).

- Method UIResponseContext.addUILabel(Path)

  Replaced by WidgetWriter.addUILabel(Path).

- Method UIResponseContext.addUIListSearch(Path,String)

  please use newComboBox(Path), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUIListSearch(Path,String,Nomenclature)

  please use newComboBox(Path), UIAtomicWithEnumeration.setSpecificNomenclature(Nomenclature) and addWidget(UIWidget).

- Method UIResponseContext.addUIOccurrenceEditor(Path,String)

  The default occurrence editor can only work with the default multi-occurrence editor.

- Method UIResponseContext.addUIPasswordInputField(Path,String)

  please use newPassword(Path) and addWidget(UIWidget).

- Method UIResponseContext.addUIRadioButton(Path,String,boolean,boolean,int)

  please use newRadioButton(Path), UIWidget.setEditorDisabled(boolean), UIAtomicWithEnumerationItem.setLabelEnabled(boolean), UIAtomicWithEnumerationItem.setIndex(int) and addWidget(UIWidget).

- Method UIResponseContext.addUIRadioButtonGroup(Path,String)

  please use newRadioButtonGroup(Path), UIRadioButtonGroup.setColumnsNumber(int) (instead of htmlSeparator) and addWidget(UIWidget).

- Method UIResponseContext.addUIRadioButtonGroup(Path,String,String)

  please use newRadioButtonGroup(Path), UIRadioButtonGroup.setColumnsNumber(int) (instead of htmlSeparator) and addWidget(UIWidget).

- Method UIResponseContext.addUITextAreaField(Path,String)

  please use newTextBox(Path), UITextBox.setMultiLine(boolean) and addWidget(UIWidget).

- Method UIResponseContext.addUITextHiddenInputField(Path,String)

  please use newTextBox(Path) and addWidget(UIWidget) with a <div style="display:none;">...</div> surrounding you widget. Example:.

- Method UIResponseContext.addUITextInputField(Path,String)

  please use newTextBox(Path) and addWidget(UIWidget).

- Method UIResponseContext.addUIValidationMessage(Path)

  Replaced by WidgetWriter.addUIValidationMessage(Path).

- Method UIResponseContext.addWidget(Path)

  Replaced by UIFormWriter.addWidget(UIWidget).

- Method UIResponseContext.addWidget(form.widget.UIWidget)

  Replaced by UIFormWriter.addWidget(UIWidget).

- Method UIResponseContext.enableEscapedHtml(boolean)

  See UIBeanEditorV4.

- Method UIResponseContext.getNextHtmlTabIndex()

  TabIndexes are no longer used in forms, the default order (no tabIndex) is preferable.

- Method UIResponseContext.getPrefixedPath(Path)

  Replaced by UIFormWriter.getPrefixedPath(Path).

- Method UIResponseContext.getTableCellStyleHandler()

  Replaced by WidgetWriter.getTableCellStyleHandler().

- Method UIResponseContext.getValueContext()

  Replaced by WidgetDisplayContext.getValueContext(Path).

- Method UIResponseContext.getValueContext(Path)

  Replaced by WidgetDisplayContext.getValueContext(Path).

- Method UIResponseContext.isEscapedHtmlEnable()

  See UIBeanEditorV4.

- Method UIResponseContext.jsBufferAddJavaScriptExpression(String)

  This method is inactive except if extending UIBeanEditorV4.

- Method UIResponseContext.jsBufferAddString(String)

  Use UIJavaScriptWriter.addJS(String) or UIBodyWriter.add(String) instead.

- Method UIResponseContext.jsBufferEndOfLine()

  This method is not used unless extending UIBeanEditorV4.

- Method UIResponseContext.jsBufferInitalize()

  This method is not used unless extending UIBeanEditorV4.

- Method UIResponseContext.jsBufferNewLine()

  This method is not used unless extending UIBeanEditorV4.

- Method UIResponseContext.jsBufferReenable(boolean)

  This method is inactive except if extending UIBeanEditorV4.

- Method UIResponseContext.jsBufferTemporaryDisable()

  This method is inactive except if extending UIBeanEditorV4.

- Method UIResponseContext.newBestMatching(Path)

  Replaced by UIFormWriter.newBestMatching(Path).

- Method UIResponseContext.newCheckBox(Path)

  Replaced by UIFormWriter.newCheckBox(Path).

- Method UIResponseContext.newCheckBoxGroup(Path)

  Replaced by UIFormWriter.newCheckBoxGroup(Path).

- Method UIResponseContext.newColorPicker(Path)

  Replaced by UIFormWriter.newColorPicker(Path).

- Method UIResponseContext.newComboBox(Path)

  Replaced by UIFormWriter.newComboBox(Path).

- Method UIResponseContext.newDateTime(Path)

  Replaced by UIFormWriter.newDateTime(Path).

- Method UIResponseContext.newDropDownList(Path)

  Replaced by UIFormWriter.newDropDownList(Path).

- Method UIResponseContext.newFormGroup(Path)

  Replaced by UIFormWriter.newFormGroup(Path).

- Method UIResponseContext.newFormRow(Path)

  Replaced by UIFormWriter.newFormRow(Path).

- Method UIResponseContext.newListBox(Path)

  Replaced by UIFormWriter.newListBox(Path).

- Method UIResponseContext.newPassword(Path)

  Replaced by UIFormWriter.newPassword(Path).

- Method UIResponseContext.newRadioButton(Path)

  Replaced by UIFormWriter.newRadioButton(Path).

- Method UIResponseContext.newRadioButtonGroup(Path)

  Replaced by UIFormWriter.newRadioButtonGroup(Path).

- Method UIResponseContext.newTable(Path)

  Replaced by UIFormWriter.newTable(Path).

- Method UIResponseContext.newTextBox(Path)

  Replaced by UIFormWriter.newTextBox(Path).

- Method UIResponseContext.newTextBox(Path,String)

  Replaced by UIFormWriter.newTextBox(Path).

- Method UIResponseContext.startFormGroup(Path)

  Replaced by UIFormWriter.startFormGroup(Path).

- Method UIResponseContext.startFormRow(Path)

  Replaced by UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIComponentWriter.startFormRow(UIFormRow).

- Method UIResponseContext.startFormRow(Path,boolean)

  Replaced by UIFormWriter.newFormRow(Path), UIFormRow.setIconDisplayed(boolean) and UIComponentWriter.startFormRow(UIFormRow).

- Interface UIServiceComponentWriter

  This interface allows building standard EBX® components, from a ServiceContext.

- Method UITableFilter.addForPrint(UITableFilterResponseContext)

  Use addForEdit(UITableFilterResponseContext) instead.

- Method UITableFilter.handleSelect(UITableFilterRequestContext)

  From v5.0.0, all filters are displayed on the screen.

### com.orchestranetworks.ui.form

- Method UIFormPaneWithTabs.getSelectedTabIndex()

  please use getSelectedTabId().

- Method UIFormPaneWithTabs.setHomeIconDisplayed(boolean)

  Since 5.9.0, home icon is no longer displayed.

- Method UIFormPaneWithTabs.setSelectedTabIndex(int)

  please use selectTab(String).

### com.orchestranetworks.ui.form.widget

- Method WidgetDisplayContext.getHierarchyNode()

  Replaced by getHierarchyMember().

### com.orchestranetworks.ui.toolbar

- Method ToolbarButton.setRelief(UIButtonRelief)

  Since 5.9.0, relief configuration is ignored, all buttons are rendered flat.

### com.orchestranetworks.userservice

- Method UserServiceResourceLocator.getURLForServiceSelection(Adaptation,SchemaNode,ServiceKey)

  Returns a user interface URL to start the specified service.

- Interface UserServiceRootTabbedPane

  Deprecated.

- Method UserServiceRootTabbedPane.setHomeIconDisplayed(boolean)

  Since 5.9.0, home icon is no longer displayed.

### com.orchestranetworks.workflow

- Method ActionPermissionsOnWorkflowContext.getProcessInstanceDescription(java.util.Locale)

  Use ProcessExecutionInfoContext.getProcessInstance() instead.

- Method ActionPermissionsOnWorkflowContext.getProcessInstanceLabel(java.util.Locale)

  Use ProcessExecutionInfoContext.getProcessInstance() instead.

- Method CreationWorkItemSpec.getOfferedTo()

  Since 5.7.0.

- Method ProcessExecutionContext.getProcessInstanceDescription(java.util.Locale)

  Use instead ProcessExecutionInfoContext.getProcessInstance().

- Method ProcessExecutionContext.getProcessInstanceLabel(java.util.Locale)

  Use instead ProcessExecutionInfoContext.getProcessInstance().

- Method ProcessInstanceStep.getSubWorkflowsInvocationSubWorkflows()

  Since 5.7.0.

- Method UserTask.WorkItem.getOfferedTo()

  Since 5.7.0.

- Method WorkflowEngine.getFromServiceContext(ServiceContext)

## Removed elements

### com.onwbp.adaptation

- Method AdaptationHome.toString()

- Method AdaptationTable.toString()

- Constructor InvalidPrimaryKeyException(String,Throwable)

- Method RequestResult.getAdaptation(int)

### com.orchestranetworks.d3

- Constructor DeliveryMode()

### com.orchestranetworks.dataservices.rest

- Constant Constants.Data.PARAM_VIEW_ID

- Interface Constants.Hierarchy

- Constant Constants.Selector.PARAM_FIRST_ELEMENT_INDEX

### com.orchestranetworks.instance

- Method RepositoryAnonymizer.RecordContext.setValue(SchemaNode,Path)

### com.orchestranetworks.module

- Constructor ModuleRegistrationListener()

### com.orchestranetworks.rest.util

- Method URIBuilderForBuiltin.buildForDataset(Adaptation)

- Method URIBuilderForBuiltin.buildForDataset(Adaptation,java.util.Map)

- Method URIBuilderForBuiltin.buildForDataset(HomeKey,AdaptationName)

- Method URIBuilderForBuiltin.buildForDataset(HomeKey,AdaptationName,java.util.Map)

- Method URIBuilderForBuiltin.buildForNode(Adaptation,Path)

- Method URIBuilderForBuiltin.buildForNode(Adaptation,Path,java.util.Map)

- Method URIBuilderForBuiltin.buildForNode(HomeKey,AdaptationName,Path)

- Method URIBuilderForBuiltin.buildForNode(HomeKey,AdaptationName,Path,java.util.Map)

- Method URIBuilderForBuiltin.buildForRecord(Adaptation)

- Method URIBuilderForBuiltin.buildForRecord(Adaptation,java.util.Map)

- Method URIBuilderForBuiltin.buildForTableFirstPage(Adaptation,SchemaNode,int,java.util.Map)

- Method URIBuilderForBuiltin.buildForTableLastPage(Adaptation,SchemaNode,int,java.util.Map)

- Method URIBuilderForBuiltin.buildForTableNextPage(Adaptation,SchemaNode,String,int,java.util.Map)

- Method URIBuilderForBuiltin.buildForTablePreviousPage(Adaptation,SchemaNode,String,int,java.util.Map)

- Method URIInfoUtility.createBuilderForBuiltin(CategoryVersion)

### com.orchestranetworks.service.directory

- Method AuthenticationException.getUserMessage()

### com.orchestranetworks.ui

- Constructor UIHttpManagerComponentHelper()

- Method UIHttpManagerComponentHelper.getReturnCodeFromHttpRequest(javax.servlet.http.HttpServletRequest)

Release Notes