5.8.1 Java API changes

• This document lists the Java API changes made in this release. The comparison is performed between the current version and 5.8.0[v1054].

Added elements

com.onwbp.base.text

• Nomenclature.addItemValue(T, String)

  Adds a NomenclatureItemValue with the specified content to this instance.

• Nomenclature.addItemValue(T, String[])

  Adds to this instance a {NomenclatureItemValue} with the specified content.

• Nomenclature.addItemValue(T, String[], Locale[])

  Adds a {NomenclatureItemValue} with the specified content to this instance.

• Nomenclature.addItemWithMessage(T, UserMessage)

  Adds a NomenclatureItemWithMessage with the specified content to this instance.

• Nomenclature.comparatorByLabel()

  Returns a label comparator.

• Nomenclature.empty()

  Returns the empty nomenclature (immutable).

• Nomenclature.getComparatorByLabel()

• Nomenclature.hashCode()

• NomenclatureItem.setValue(T)

  Replaces the value with the specified object.

• NomenclatureItemValue.hashCode()

• public NomenclatureItemValue(T, java.lang.String)

• public NomenclatureItemValue(T, java.lang.String[])

• public NomenclatureItemValue(T, java.lang.String[], java.util.Locale[])

com.orchestranetworks.dataservices.rest

• com.orchestranetworks.dataservices.rest.RestConstants

  This interface provides constants for the built-in RESTful services.

• com.orchestranetworks.dataservices.rest.RestConstants.Admin

  Administration report keys, parameters and operation name.

• com.orchestranetworks.dataservices.rest.RestConstants.Auth

  Authentication report keys, parameters and operation name.

• com.orchestranetworks.dataservices.rest.RestConstants.Data

  Data keys and parameters.

• com.orchestranetworks.dataservices.rest.RestConstants.Error

  Error report keys.

• com.orchestranetworks.dataservices.rest.RestConstants.History

  History keys and parameters.

• com.orchestranetworks.dataservices.rest.RestConstants.Meta

  Meta keys and parameters.

• com.orchestranetworks.dataservices.rest.RestConstants.Pagination

  Pagination keys and parameters.

• com.orchestranetworks.dataservices.rest.RestConstants.ProcedureContext

  Procedure context keys.

• com.orchestranetworks.dataservices.rest.RestConstants.Selector

  Selector keys and parameters.

com.orchestranetworks.instance

• HomeCreationSpec.isCopyParentValidationReports()

  Indicates if the validation reports of the datasets contained in the parent dataspace are copied during the creation of the new dataspace.

• HomeCreationSpec.setCopyParentValidationReports(boolean)

  Specifies whether the validation reports of the datasets contained in the parent dataspace must by copied in the child to be created.

com.orchestranetworks.interactions

• com.orchestranetworks.interactions.IllegalInteractionStateException

  This runtime exception is thrown by some methods which try to change the interaction state while the current interaction state has already been accepted or rejected.

• com.orchestranetworks.interactions.InteractionException

  This runtime exception is thrown by some methods related to interactions.

com.orchestranetworks.schema

• Constraint.checkOccurrence(T, ValueContextForValidation)

  Checks the specified value and adds an error message if invalid.

• ConstraintEnumeration.displayOccurrence(T, ValueContext, Locale)

  Returns a string representation of the value specified for the end-user (a label).

• SchemaNode.getUniquenessConstraints()

  Returns the uniqueness constraints applied on this table using the property xs:unique.

• SchemaNode.isValidationDisabled()

  Returns true if the validation is disabled on this node.

• TableRefFilterContext.setFilterForSearch(String)

  Specifies an XPath filter that will be applied in the user interface to perform a search on the associated foreign key field.

com.orchestranetworks.schema.info

• AssociationLink.isXPathLink()

  Returns true if this association is over an XPath predicate.

• SchemaFacet.getValidationPolicy()

  Returns the validation policy of this facet.

• com.orchestranetworks.schema.info.AssociationLinkByXPathLink

  This interface contains the information for an association that is over an XPath predicate (osd:association/xpathLink property).

• com.orchestranetworks.schema.info.SchemaFacetValidationPolicy

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

• com.orchestranetworks.schema.info.UniquenessConstraint

  Defines a uniqueness constraint (property xs:unique) held by a table node in a data model.

com.orchestranetworks.service

• ImportSpec.isUnmatchedXMLElementIgnored()

  @see #setUnmatchedXMLElementIgnored(boolean) @since 5.8.1

• ImportSpec.setUnmatchedXMLElementIgnored(boolean)

  Specifies whether the XML import should be tolerant to ignore extra columns that are not defined in the model.

• Session.isUserInRoles(Iterable)

  Returns true if the current user or the session has at least one profile from the specified profile list.

• com.orchestranetworks.service.URLQuery

  Represents a list of URL query parameters.

• public static final com.orchestranetworks.service.ServiceKey OPEN_LINK_RECORD

  Built-in service to edit the record that links an associated object to its parent record.

com.orchestranetworks.ui

• UIHttpManagerComponent.setFirstCallDisplayHierarchyExpanded()

  Specifies that the hierarchy must be displayed expanded.

• UIResourceLocator.getURLForRest(String, URLQuery)

  Returns the REST URL string for the specified path and query.

• public static final com.orchestranetworks.ui.UIButtonIcon DUPLICATE

  @since 5.8.1

com.orchestranetworks.ui.form

• UIFormWriter.newDatasetSelector(Path)

  Returns a new dataset selector.

• UIFormWriter.newDataspaceSelector(Path)

  Returns a dataspace selector.

com.orchestranetworks.ui.form.widget

• UIComboBox.getViewForAdvancedSelection()

  Returns the published view that will be used in the combo-box selection of the associated foreign key field.

• UIComboBox.setViewForAdvancedSelection(String)

  Specifies the name of the published view that will be used in the combo-box selection of the associated foreign key field.

• UITextBox.getForegroundColor()

  Returns the previously set foreground color.

• UITextBox.setForegroundColor(String)

  Sets the foreground color of the component input.

• com.orchestranetworks.ui.form.widget.UIDatasetSelector

  A widget made of a combo box displaying the dataset tree and a text box for filtering.

• com.orchestranetworks.ui.form.widget.UIDataspaceSelector

  A widget made of a combo box displaying the dataspace tree and a text box for filtering.

com.orchestranetworks.userservice

• UserServiceDisplayConfigurator.setToolbar(Toolbar)

  Sets the toolbar to one defined programmatically.

• UserServiceNext.nextURL(String)

  The current user service will close and user will be redirected.

• UserServiceObjectContext.isDataDeleted(ObjectKey)

  Returns true if the underlying record or dataset has been deleted, possibly by another user.

• UserServiceObjectContextBuilder.registerNewDuplicatedRecord(ObjectKey, Adaptation)

  Registers a new duplicated record in the object context.

• UserServiceResourceLocator.getURLForAction(UserServiceEvent, URLQuery)

  Returns a URL that will trigger an action event when clicked by a user.

• UserServiceResourceLocator.getURLForAjaxRequest(UserServiceAjaxRequest, URLQuery)

  Returns a URL that will invoke an Ajax request callback.

• UserServiceResourceLocator.getURLForGetRequest(UserServiceGetRequest, URLQuery)

  Returns a URL that will invoke a GET request callback.

• UserServiceResourceLocator.getURLForResource(String, String, URLQuery)

  Returns the URL string for the specified web resource.

• UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, Adaptation, SchemaNode)

  Returns a user interface URL which selects the specified node of the given record or dataset and starts the specified service on it.

• UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, Adaptation, SchemaNode, URLQuery)

  Returns a user interface URL which selects the specified node of the given record or dataset and starts the specified service on it.

• UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, Adaptation, URLQuery)

  Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.

• UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, AdaptationHome, URLQuery)

  Returns a user interface URL that selects the specified dataspace or snapshot and starts the specified service on it.

• UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, URLQuery)

  Returns a user interface URL to start the specified service.

• UserServiceTransaction.add(ObjectKey, UserServiceTransaction.DeletedObjectOutcome)

  Adds an object to be created or updated.

• com.orchestranetworks.userservice.UserServiceExtended

  Extended interface that can be implemented by a user service.

• com.orchestranetworks.userservice.UserServiceInitializeContext

  This interface provides information and utility methods useful when initializing a user service.

• com.orchestranetworks.userservice.UserServiceTransaction.DeletedObjectOutcome

  Enumeration for specifying the outcome of a transaction when the underlying data, of the object being updated, was deleted by another thread.

com.orchestranetworks.userservice.declaration

• WebComponentDeclarationContext.setAvailableAsWorkflowUserTask(boolean, boolean)

  Defines if the service is proposed in the user interface used to define a workflow user task, and if this user service auto-completes itself by calling {SessionInteraction#complete(com.orchestranetworks.interactions.InteractionHelper.ParametersMap)} in its implementation.

com.orchestranetworks.workflow

• IncomingEvent.parse(String)

• ProcessLauncher.getPublishedProcessKey()

  Returns the publication identifier associated to the workflow launcher.

• WorkflowEngine.cleanHistory(Date)

  Deletes the data in history for workflows terminated from a given date.

• WorkflowEngine.cleanHistory(ProcessInstanceKey)

  Deletes the data in history for workflows terminated for a given ProcessInstanceKey.

• WorkflowEngine.getProcessInstanceKeysFromHistory(PublishedProcessKey)

  Returns a list containing all the process instance keys for the specified publication key, including deleted processes.

• WorkflowEngine.replayCurrentStep(ProcessInstanceKey)

  Replays the current step of the specified workflow.

Removed elements

com.onwbp.base.text

• Nomenclature.addItemValue(Object, String)

  Adds a NomenclatureItemValue with the specified content to this instance.

• Nomenclature.addItemValue(Object, String[])

  Adds to this instance a {NomenclatureItemValue} with the specified content.

• Nomenclature.addItemValue(Object, String[], Locale[])

  Adds a {NomenclatureItemValue} with the specified content to this instance.

• Nomenclature.addItemWithMessage(Object, UserMessage)

  Adds a NomenclatureItemWithMessage with the specified content to this instance.

• NomenclatureItem.setValue(Object)

  Replaces the value with the specified object.

• public NomenclatureItemValue(java.lang.Object, java.lang.String)

• public NomenclatureItemValue(java.lang.Object, java.lang.String[])

• public NomenclatureItemValue(java.lang.Object, java.lang.String[], java.util.Locale[])

com.orchestranetworks.interactions

• com.orchestranetworks.interactions.InteractionException

com.orchestranetworks.schema

• Constraint.checkOccurrence(Object, ValueContextForValidation)

  Checks the specified value and adds an error message if invalid.

• ConstraintEnumeration.displayOccurrence(Object, ValueContext, Locale)

  Returns a string representation of the value specified for the end-user (a label).

com.orchestranetworks.workflow

• IncomingEvent.parse(String)