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 6.1

## Added elements

### com.onwbp.adaptation

- Class AbstractPrefilteredAdaptationFilter

  Defines a base class for implementing a PrefilteredAdaptationFilter.

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

- Interface PrefilteredAdaptationFilter

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

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

- Constant Constants.Data.URL_ACTION_CHILDREN

- Constant Constants.Data.URL_ACTION_INFORMATION

- Constant Constants.History.KEY_HISTORY_CHILDREN_DETAILS

- Constant Constants.Meta.KEY_BUSINESS_OBJECT_RELATION

- Constant Constants.Pagination.KEY_CURSOR

  Pagination cursor position.

- Constant Constants.Pagination.KEY_MAX

  Maximum page cursor position.

- Constant Constants.Pagination.PARAM_FIRST_ELEMENT_INDEX

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

- 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 SchemaNode.getSchemaDefaultTableView()

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

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

### com.orchestranetworks.schema.info

- 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

- Constant SchemaMetadataConstants.DEFINITION_MODE_PATH

  Path to the node that specifies the definition mode of a record.

### com.orchestranetworks.search.strategy

- Constant SearchStrategyKey.ASSOCIATION

  Only used for association nodes.

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

- Constructor MergeSpecForInstanceContents(boolean)

  Constructor that allows specifying whether to include all content types.

- 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 SessionPermissions.getGlobalPermissionToIde()

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

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

- Class LdapDirectoryFactory

  Built-in LDAP directory factory for EBX®.

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

- Method WidgetDisplayContext.isInherited()

  Returns true if the displayed value is inherited.

### com.orchestranetworks.ui.perspective

- Method PerspectiveTheme.getButtonsHighlightTextColor()

  Returns the text Hex color code of buttons selected by default.

- Method PerspectiveTheme.getFormHTMLEditorsMaxHeight()

  Returns the maximum height in pixels of HTML editors in forms.

- Method PerspectiveTheme.getFormHTMLEditorsMaxWidth()

  Returns the maximum width in pixels of HTML editors in forms.

- Method PerspectiveTheme.getFormHTMLEditorsMinHeight()

  Returns the minimum height in pixels of HTML editors in forms.

- Method PerspectiveTheme.getFormHTMLEditorsMinWidth()

  Returns the minimum width in pixels of HTML editors in forms.

- Method PerspectiveTheme.getPerspectiveNavigationPaneSelectionTextColor()

  Returns the text Hex color code used for selected menu items in the perspective navigation pane.

- Method PerspectiveTheme.getWorkflowBadgeTextAndBorderColor()

  Returns the text and border Hex color code of the workflow task counters.

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

- Class PublicationSpec

  Specifications for publishing a single workflow.

- Enum PublicationSpec.PublicationMode

  Retrieves the mode of the publication.

- 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.getProcessInstanceKeysForDataContextVariableIncludingHistory(PublishedProcessKey,String,String)

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

- 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.getValidationReportsMap(Severity)

  since 6.1.1.

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

- Method PerspectiveTheme.getFormHTMLEditorsHeight()

  Since 6.2.1, is not used anymore.

- Method PerspectiveTheme.getFormHTMLEditorsWidth()

  Since 6.2.1, is not used anymore.

## Removed elements

### com.orchestranetworks.dataservices.rest

- Constant Constants.Selector.PARAM_FIRST_ELEMENT_INDEX

Release Notes