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

# 6.1 Java API changes

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

## Added elements

### com.onwbp.adaptation

- Method Adaptation.getLabel(Session)

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

- Method Adaptation.getLabelOrName(Session)

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

- Method Adaptation.getLastTransactionId()

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

- Method AdaptationHome.getValidationReport(Severity)

  Returns all validation reports for datasets in this AdaptationHome that have at least one validation item of the specified severity or higher.

- 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 UnavailableRepositoryException

  Checked exception thrown when the repository is not available.

### com.onwbp.adaptation.validation

- Interface DataspaceValidationReport

  Defines the validation report of a dataspace.

### 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 Constants.Data.CATEGORY_BUSINESS_OBJECT

- Constant Constants.Data.CATEGORY_BUSINESS_OBJECT_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_LOCALE

- Constant Constants.Data.KEY_MODULE

- 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_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_INCLUDE_METADATA

- Constant Constants.Data.URL_ACTION_CHILDREN

- Constant Constants.Data.URL_ACTION_INFORMATION

- Constant Constants.Data.URL_ACTION_MASS

- Constant Constants.Data.VALUE_FILTER_SELECT_ALL

  Selects all the entities for update or delete.

- Constant Constants.Data.VALUE_INCLUDE_METADATA_ALL

  @see #PARAM_INCLUDE_METADATA @since 6.1.0

- 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_BUSINESS_OBJECT_RELATION

- Constant Constants.Meta.PARAM_INCLUDE_METAMODEL

- Constant Constants.Pagination.KEY_CURSOR

- Constant Constants.Pagination.KEY_MAX

- Constant Constants.Pagination.PARAM_FIRST_ELEMENT_INDEX

### com.orchestranetworks.instance

- Method Repository.getDefaultWhenFullyInitialized()

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

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

- Method QueryPermissionException.create(Session, Map, String)

### com.orchestranetworks.query

- Method Query.setIncludeOcculting(boolean)

  Sets whether or not the query must consider records in occulting mode.

### com.orchestranetworks.rest

- Constant ApplicationConstant.REST_DEFAULT_OPENAPI_APPLICATION_PATH

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

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

### com.orchestranetworks.rest.serialization

- Constant Include.MERGE_INFO

  Includes the history merge information.

### com.orchestranetworks.rest.util

- Constant CategoryURIBuilder.DATA_BO_V1

  Mapping for REST category {data-bo} and version {v1}.

- Constant CategoryURIBuilder.DATA_COMPACT_BO_V1

  Mapping for REST category {data-compact-bo} and version {v1}.

### com.orchestranetworks.schema

- Method DependenciesDefinitionContext.addDependencyToInsertAndDelete(Path)

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

- Method DependenciesDefinitionContext.addDependencyToInsertDeleteAndModify(Path)

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

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

- 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 source node with the specified path in the same record.

- 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 table node.

- Method SchemaNode.getBusinessObjectModel(Adaptation, Session)

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

- 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.getTableEntityName()

  Returns the entity name of this node if this node is a {#isTableNode() table node}.

### 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 {BusinessObjectModel 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(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 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 {Path paths} to the nodes that hold the metadata associated to table records.

### com.orchestranetworks.schema.relationships

- 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.search.strategy

- Constant SearchStrategyKey.ASSOCIATION

  Only used for association nodes @see SchemaNodeSearchStrategy_Association @since 6.1.1

- Constant SearchStrategyKey.DOUBLE_METAPHONE

- Constant SearchStrategyKey.LEVENSHTEIN

- Constant SearchStrategyKey.NGRAM

- Constant SearchStrategyKey.SOUNDEX

- Method StopWordsKey.getModel()

  Returns the name of the data model to which the stop words list belongs, or null if the list does not belong to a specific model.

- Method StopWordsKey.getName()

- Method SynonymsKey.getModel()

  Returns the name of the data model to which the synonyms list belongs, or null if the list does not belong to a specific model.

- Method SynonymsKey.getName()

### com.orchestranetworks.search.template

- Method SearchTemplateManager.getModuleTemplates(com.onwbp.base.repository.Module)

  Returns the search templates registered in the given module.

### com.orchestranetworks.service

- Method ProcedureContext.doCreateOccurrence(ValueContext, AdaptationTable, UserReference, Date, UserReference, 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.

- Method URLQuery.format()

- Method URLQuery.format(String)

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

### com.orchestranetworks.service.comparison

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

  Performs a comparison between two transaction dates 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, Date, Date)

  Performs a comparison between two transaction dates for a dataspace 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, Date, Date)

  Performs a comparison between two dates 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, Date, Date)

  Performs a comparison between two dates 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.0.2.

- Method DirectoryDefault.hasUsersInRole(Role)

- Method DirectoryDefault.hashPassword(String, String)

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

- Method DirectoryHandler.hasUsersInRole(Role)

  @see Directory#hasUsersInRole(Role) @since 6.0.6

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

- Method UIHttpManagerComponent.initFromHttpRequest(HttpServletRequest)

  Initializes this instance with the specified incoming request.

- Method UIHttpManagerComponentHelper.getReturnCodeFromHttpRequest(ServletRequest)

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

- Method UILabelRendererContext.getCustomViewContext()

  Returns the view context.

- Method UITableFilterContext.getCustomViewContext()

  Returns the view context.

### com.orchestranetworks.ui.form

- Method UIFormContext.getCustomViewContext()

  Returns the view context.

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

- Method WidgetDisplayContext.getCustomViewContext()

  Returns the view context.

### 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.TILE_VIEW

  Toolbar displayed on each tile of a tile view.

- 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 {UICustomViewKey}s.

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

### com.orchestranetworks.userservice.declaration

- 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, Collection)

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

- Class PublicationSpec

  Specifications for publishing a single workflow.

- Enum PublicationSpec.PublicationMode

  Retrieves the mode of the publication.

- Method WorkflowEngine.getWorkflowPublisher()

  Retrieves an instance of the WorkflowPublisher class.

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

- Interface WorkflowPublisher

  Publishes one or more workflow.

## Deprecated elements

### com.onwbp.adaptation

- Method AdaptationHome.findParent(Adaptation)

- Method AdaptationHome.getValidationReportsMap(Severity)

- Method AdaptationHome.isMarkedForPurge()

  Always returns false.

- Method AdaptationTable.getRootKey()

  Returns the key to the virtual root record of this table.

- Method PrimaryKey.parseList(List)

- Method RequestResult.refresh()

- Method RequestResult.refreshIfNeeded()

### com.onwbp.base.repository

- Method ModulesRegister.getDependentModuleNames(ServletContext)

### com.orchestranetworks.d3

- Method D3Broadcast.getDeliveryStatus()

  Returns the global delivery status of the broadcast handler for the default delivery mode (clustered).

- Method D3Engine.broadcast(VersionKey)

  Asynchronously broadcasts a snapshot.

- Method D3NodeAsMaster.getD3SlaveFromId(String)

  Returns the replica for the specified identifier.

- Method D3NodeAsMaster.getD3SlaveFromRepositoryId(String)

  Returns the replica for the specified identifier.

- Method D3NodeAsMaster.getD3SlaveFromRepositoryLabel(String)

  Returns the replica for the specified label.

- Method D3NodeAsMaster.getRegisteredSlaves(BranchKey)

  Returns the list of the {D3Slave} object(s) subscribed to the dataspace specified in the parameter.

- Method D3Slave.getSlaveId()

  Returns the repository label of the replica node.

### com.orchestranetworks.dataservices.rest

- Constant Constants.Data.KEY_TECHNICALS_CREATION_DATE

- Constant Constants.Data.KEY_TECHNICALS_CREATION_USER

- Constant Constants.Data.KEY_TECHNICALS_LAST_UPDATE_DATE

- Constant Constants.Data.KEY_TECHNICALS_LAST_UPDATE_USER

- Constant Constants.Data.PARAM_CHECK_NOT_CHANGED_SINCE_LAST_UPDATE_DATE

  @deprecated since 6.1.0, replaced by #PARAM_CHECK_NOT_CHANGED_SINCE_LAST_UPDATE_TIME

- Constant Constants.Data.PARAM_INCLUDE_TECHNICALS

- Constant Constants.Data.PARAM_INDENT

- Constant Constants.Data.PARAM_INHERIT_IF_IN_OCCULTING_MODE

- Constant Constants.Meta.PARAM_INCLUDE_META

- Constant Constants.Pagination.PARAM_PAGE_FIRST_RECORD_FILTER

- Constant Constants.Pagination.PARAM_PAGE_SIZE_UNBOUNDED_VALUE

- Class RESTEncodingHelper

  Helper for REST encoding.

### com.orchestranetworks.instance

- Method Repository.markHomeForPurge(AdaptationHome, Session)

- Method Repository.purgeHomes(Session)

  Performs a complete deletion of the physical entities that have been partially deleted or marked for purge.

- Method RepositoryPurge.markHomeForPurge(AdaptationHome, Session)

### com.orchestranetworks.interactions

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

- Method InteractionHelper.getInputParameters(Session)

- Method InteractionHelper.getInternalParameters(Session)

- Method InteractionHelper.isComplete(Session)

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

### com.orchestranetworks.schema

- Method SchemaLocation.getInputStream()

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

- Constant SchemaTypeName.XS_NMTOKEN

- Constant SchemaTypeName.XS_NMTOKENS

### com.orchestranetworks.service

- Method ImportResult.getCreatedRecords()

  Returns an iterator over XPath predicate strings.

- Method ImportSpec.isUpdateByDelta()

- Method ImportSpec.setUpdateByDelta(boolean)

- Method ProcedureContext.disableDatasetValidation(Adaptation)

- Method ProcedureContext.doCreateOverwriting(ValueContext, AdaptationTable)

  Creates a record in the specified table.

- Method ProcedureContext.doCreateRoot(ValueContext, AdaptationTable)

  Creates a record in the specified table.

- Method ProcedureContext.isPrivilegeToModifyReferenceBranch()

- Method ProcedureContext.setBatch()

  This method has no effect.

- Method ProcedureContext.setPrivilegeToModifyReferenceBranch(boolean)

- Method SessionPermissions.getSession()

  Returns the associated user session, or null if this instance has been created directly to evaluate user permissions.

### com.orchestranetworks.service.directory

- Method Directory.getUserAuthenticationURI(Session)

  This method allows defining a specific URL to replace the default login page.

- Method DirectoryHandler.getUserAuthenticationURI(Session)

### com.orchestranetworks.ui

- Method UIAjaxContext.getServiceContext()

  Returns an instance of ServiceContext if this AJAX component is called from a UIService, Returns null otherwise.

- Method UIBeanEditor.addForPrint(UIResponseContext)

- Constant UICSSClasses.SMALL_FORM_BUTTONS

  Apply this class on a container to reduce the size of all the children buttons, like in form rows.

- Method UIContext.displayOccurrence(Object, boolean)

  Returns a string to display the specified value according to the current locale of this context.

- Method UIContext.getHierarchyMember()

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

- Method UIContext.getHierarchyNode()

- Method UIContext.getLocale()

  Returns the current locale of the user session.

- Method UIContext.getNode()

  Returns the node to which the component is attached, as specified in the data model.

- Method UIContext.getNode(Path)

  Returns the node located at the specified path.

- Method UIContext.getPathForListOccurrence(int)

  Returns the absolute path of an occurrence at the specified index under the current aggregated list field (maxOccurs > 1).

- Method UIContext.getPathForListOccurrence(int, boolean)

  Returns the path of an occurrence at the specified index under the current aggregated list field (maxOccurs > 1).

- Method UIContext.getPathInAdaptation()

  Returns the path of the current node to which the component is attached.

- Method UIContext.getSession()

  Returns the current session.

- Method UIContext.getValue()

  Returns the current value of the current node.

- Method UIContext.getValue(Path)

  Returns the value at the specified path.

- Method UIContext.getWebName()

  Returns a string that uniquely identifies the current component in the current page.

- Method UIContext.getWebNameFor(String)

  Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

- Method UIContext.getWebNameForPath(Path)

  Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

- Method UIContext.getWebNameOfParent()

  Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

- Method UIContext.isCreatingRecord()

  Returns true if this component is displayed in the context of a new record creation.

- Method UIContext.isDuplicatingRecord()

  Returns true if this component is displayed in the context of the duplication of an existing record.

- Method UIFormSpec.setMarginForContent(boolean)

  Forms are used to display node values (tree layout), or other content (text layout).

- Constant UIHttpManagerComponent.DataSetFeatures.BREADCRUMB

  Navigation bread crumb.

- Constant UIHttpManagerComponent.RecordFeatures.BREADCRUMB

  Navigation bread crumb.

- Constant UIHttpManagerComponent.ViewFeatures.BREADCRUMB

  Navigation bread crumb.

- Method UIHttpManagerComponent.createOnAjaxContext(UIAjaxContext)

- Method UIHttpManagerComponent.createOnServiceContext(ServiceContext)

- Method UIHttpManagerComponent.createOnUIBeanContext(UIResponseContext)

- Method UIHttpManagerComponent.createOnUILabelRendererForHierarchyContext(UILabelRendererForHierarchyContext)

- Method UILabelRendererForHierarchyContext.getHierarchyNode()

- Constant UIRenderingMode.PRINT

  @deprecated

- Method UIRenderingMode.isPrint()

  @deprecated

- Method UIRequestContext.getOptionalRequestParameterValue(String)

  Returns the HTTP parameter value in the incoming request.

- Method UIRequestContext.getOptionalRequestParameterValues(String)

  Returns the HTTP parameter values in the incoming request.

- Method UIRequestContext.getValueContext()

  Returns the local validation context, relative to the node contained by this component.

- Method UIRequestContext.getValueContext(Path)

- Method UIResponseContext.addComboBox(Path)

  Adds the combo box component for user search and selection in a list.

- Method UIResponseContext.addComboBox(UIComboBox)

  Adds the specified combo box component for user search and selection in a list.

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

  Adds a button with the built-in "empty field" button look and feel.

- Method UIResponseContext.addFormRow(UIFormRow)

  Adds a complete form row in the UIBean.

- Method UIResponseContext.addFormRow(UIFormRow, UIWidget)

  Adds a complete form row in the UIBean according to the given specification with the specified user interface widget.

- Method UIResponseContext.addFormRow(UIWidget)

  Adds a form row in the UIBean with the specified widget.

- Method UIResponseContext.addFormRowBestMatchingComponent(Path)

  Adds a form row (without icon) containing the best matching component.

- Method UIResponseContext.addFormRowBestMatchingComponent(Path, boolean)

  Adds a form row with the best matching component.

- Method UIResponseContext.addFormRowBestMatchingDisplay(Path)

  Adds a form row (without icon) with the best matching display.

- Method UIResponseContext.addFormRowBestMatchingDisplay(Path, boolean)

  Adds a form row with the best matching display.

- Method UIResponseContext.addFormRowBestMatchingEditor(Path)

  Adds a form row (no icon) with the best matching editor.

- Method UIResponseContext.addFormRowBestMatchingEditor(Path, boolean)

  Adds a form row with the best matching editor.

- Method UIResponseContext.addJS_getNodeValue(Path)

  Adds JavaScript code to get the current value of a node as set in the form.

- Method UIResponseContext.addJS_setNodeValue(String, Path)

  Adds JavaScript code to set the value of a node from a JavaScript variable.

- Method UIResponseContext.addServiceButton(Path)

  Adds a service menu button to the specified node.

- Method UIResponseContext.addUIBean(Path, String)

  The specified path must not refer to an indexed element in its last position.

- Method UIResponseContext.addUIBestMatchingComponent(Path, String)

  Adds the user interface component corresponding to the specified field or group.

- Method UIResponseContext.addUIBestMatchingDisplay(Path, String)

  Adds the user interface component corresponding to the specified field or group, in 'read-only' mode.

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

  Adds the user interface component corresponding to the specified field or group, in 'read-only' mode.

- Method UIResponseContext.addUIBestMatchingEditor(Path, String)

  Adds the user interface component corresponding to the specified field or group, in 'read-write' mode.

- Method UIResponseContext.addUICheckBox(Path, String)

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

- Method UIResponseContext.addUICheckBoxGroup(Path, String)

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

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

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

- Method UIResponseContext.addUIComplexEditor(Path, String)

  The specified path must not refer to an indexed element in its last position.

- Method UIResponseContext.addUIDescription(Path)

- Method UIResponseContext.addUIDisplayValue(Path)

  Displays the value of the specified field.

- Method UIResponseContext.addUIDropDownBox(Path, String)

  Adds a simple HTML drop-down for the user to select from a list.

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

  Adds a simple HTML drop-down for user selection in a list.

- Method UIResponseContext.addUIDropDownBoxMultiple(Path, String)

- Method UIResponseContext.addUILabel(Path)

  Adds the standard label of the specified data model node.

- Method UIResponseContext.addUIListSearch(Path, String)

  Adds a user input component for search and selection in a list.

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

  Adds a user input component for search and selection in a list.

- Method UIResponseContext.addUIOccurrenceEditor(Path, String)

  The specified path must refer to an indexed element in its last position.

- Method UIResponseContext.addUIPasswordInputField(Path, String)

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

- Method UIResponseContext.addUIRadioButtonGroup(Path, String)

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

- Method UIResponseContext.addUITextAreaField(Path, String)

- Method UIResponseContext.addUITextHiddenInputField(Path, String)

- Method UIResponseContext.addUITextInputField(Path, String)

- Method UIResponseContext.addUIValidationMessage(Path)

  Adds the validation message associated with the specified node.

- Method UIResponseContext.addWidget(Path)

  Adds the default widget, adapted to the data type and the facets of the specified node.

- Method UIResponseContext.addWidget(UIWidget)

  Adds the specified widget.

- Method UIResponseContext.enableEscapedHtml(boolean)

  Temporarily enables or disables writing escaped HTML to the stream.

- Method UIResponseContext.getNextHtmlTabIndex()

  Returns the next value for the HTML tab index in the response.

- Method UIResponseContext.getPrefixedPath(Path)

  Gets the prefixed path.

- Method UIResponseContext.getTableCellStyleHandler()

  This method allows customizing the look of a table cell.

- Method UIResponseContext.getValueContext()

  Returns the validation context of the current node.

- Method UIResponseContext.getValueContext(Path)

  Returns the validation context of the specified node.

- Method UIResponseContext.isEscapedHtmlEnable()

  Tests whether output stream is currently escaping HTML.

- Method UIResponseContext.jsBufferAddJavaScriptExpression(String)

  Adds a JavaScript expression to JavaScript writer.

- Method UIResponseContext.jsBufferAddString(String)

  If extending {UIBeanEditorV4}, adds a String to JavaScript writer.

- Method UIResponseContext.jsBufferEndOfLine()

  Adds an end of line when adding content to the JavaScript writer.

- Method UIResponseContext.jsBufferInitalize()

  Initializes a JavaScript writer.

- Method UIResponseContext.jsBufferNewLine()

  Continue adding content to JavaScript writer as a new line of JavaScript code This method is not used unless extending {UIBeanEditorV4}.

- Method UIResponseContext.jsBufferReenable(boolean)

  Ensures JavaScript buffer writing mode is re-enabled.

- Method UIResponseContext.jsBufferTemporaryDisable()

  Ensures JavaScript buffer writing mode is temporary disabled.

- Method UIResponseContext.newBestMatching(Path)

  Returns a new widget that will be automatically selected according to the corresponding node definition in the data model.

- Method UIResponseContext.newCheckBox(Path)

  Returns a new check box widget.

- Method UIResponseContext.newCheckBoxGroup(Path)

  Returns a new check box group widget.

- Method UIResponseContext.newColorPicker(Path)

  Returns a new color picker.

- Method UIResponseContext.newComboBox(Path)

  Returns a new combo box.

- Method UIResponseContext.newDateTime(Path)

  Returns a date/time field.

- Method UIResponseContext.newDropDownList(Path)

  Returns a new drop-down list.

- Method UIResponseContext.newFormGroup(Path)

  Builds the default model-driven form group based on the specified node.

- Method UIResponseContext.newFormRow(Path)

  Builds the default model-driven form row based on the specified node.

- Method UIResponseContext.newListBox(Path)

  Returns a new list box.

- Method UIResponseContext.newPassword(Path)

  Returns a password field.

- Method UIResponseContext.newRadioButton(Path)

  Returns a new radio button widget.

- Method UIResponseContext.newRadioButtonGroup(Path)

  Returns a new radio button group widget.

- Method UIResponseContext.newTable(Path)

  Returns a table widget aPath location of the target node, relative to the current node; it must refer to a node that is a {SchemaNode#isAssociationNode() association}.

- Method UIResponseContext.newTextBox(Path)

  Returns a text input field, which can be one-line or multi-line.

- Method UIResponseContext.newTextBox(Path, String)

  Returns a text input field with specified id, which can be one-line or multi-line.

- Method UIResponseContext.startFormGroup(Path)

  Starts a form group for the node at the given path.

- Method UIResponseContext.startFormRow(Path)

  Starts a form row (without icon) containing a label and plain HTML content.

- Method UIResponseContext.startFormRow(Path, boolean)

  Starts a form row containing an icon, a label, and plain HTML content.

- Method UITableFilter.addForPrint(UITableFilterResponseContext)

  Adds HTML content for displaying information about the current filter's settings on a printable page.

- Method UITableFilter.handleSelect(UITableFilterRequestContext)

  Handles the request when this filter is selected from the list of filters.

### com.orchestranetworks.ui.form

- Method UIFormPaneWithTabs.getSelectedTabIndex()

  Returns the selected tab index.

- Method UIFormPaneWithTabs.setHomeIconDisplayed(boolean)

  Specifies if the first tab must display the default "home" icon in its label.

- Method UIFormPaneWithTabs.setSelectedTabIndex(int)

  Specifies the selected tab when the page is displayed.

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

- Method WidgetDisplayContext.getHierarchyNode()

### com.orchestranetworks.ui.toolbar

- Method ToolbarButton.setRelief(UIButtonRelief)

  Sets the relief of the button.

### com.orchestranetworks.userservice

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

- Method UserServiceRootTabbedPane.setHomeIconDisplayed(boolean)

### com.orchestranetworks.workflow

- Method ActionPermissionsOnWorkflowContext.getProcessInstanceDescription(Locale)

  Returns the current process instance description.

- Method ActionPermissionsOnWorkflowContext.getProcessInstanceLabel(Locale)

  Returns the current process instance label.

- Method CreationWorkItemSpec.getOfferedTo()

  Returns the role to whom the work item must be offered.

- Method ProcessExecutionContext.getProcessInstanceDescription(Locale)

  Returns the current process instance description.

- Method ProcessExecutionContext.getProcessInstanceLabel(Locale)

  Returns the current process instance label.

- Method ProcessInstanceStep.getSubWorkflowsInvocationSubWorkflows()

  Returns the list of sub-workflows created by this step or null if this step is not a sub-workflow invocation.

- Method WorkItem.getOfferedTo()

  Returns the role to which the work item is offered.

- Method WorkflowEngine.getFromServiceContext(ServiceContext)

  @deprecated

## Removed elements

### com.orchestranetworks.d3

- Constructor DeliveryMode()

### com.orchestranetworks.dataservices.rest

- Constant Constants.Selector.PARAM_FIRST_ELEMENT_INDEX

### com.orchestranetworks.search.template

- Method SearchTemplateManager.getModuleTemplates(Module): Collection

### com.orchestranetworks.service

- Method ServiceContext.getCurrentHierarchy(): Hierarchy

- Method ServiceContext.getCurrentHierarchyMember(): Member

- Method ServiceContext.isCalledOnHierarchyMember(): boolean

### com.orchestranetworks.service.directory

- Method AuthenticationException.getUserMessage(): UserMessage

### com.orchestranetworks.ui

- Method UIHttpManagerComponent.initFromHttpRequest(HttpServletRequest, UsdServiceManager): void

- Constructor UIHttpManagerComponentHelper()

- Method UIHttpManagerComponentHelper.getReturnCodeFromHttpRequest(HttpServletRequest): UIHttpManagerComponentReturnCode

Release Notes