# Uses of Interface
com.onwbp.adaptation.Adaptation

Packages that use Adaptation
Package
Description
com.onwbp.adaptation
Provides core classes and interfaces for accessing datasets, tables, and their records.
com.orchestranetworks.hierarchy
Provides an interface for accessing a hierarchy view node.
com.orchestranetworks.instance
Provides interfaces for accessing data sets.
com.orchestranetworks.permissions
com.orchestranetworks.query
Provides the API for accessing and processing data stored in EBX®.
com.orchestranetworks.rest.serialization
com.orchestranetworks.rest.util
com.orchestranetworks.schema
Represents XML Schema concepts and provides schema extensions capabilities.
com.orchestranetworks.schema.businessObjects
com.orchestranetworks.schema.info
Provides interfaces for accessing schema node facet.
com.orchestranetworks.schema.relationships
Provides interfaces for accessing relationships defined in a data model.
com.orchestranetworks.schema.trigger
Provides classes and interfaces for trigger creation.
com.orchestranetworks.schema.types.dataset
Interfaces to define sets of data set references.
com.orchestranetworks.schema.types.dataspace
Interfaces to define sets of data space keys.
com.orchestranetworks.service
Provides classes and interfaces for implementing specific services and access rules on EBX®.
com.orchestranetworks.service.comparison
Provides classes and interfaces for to compute differences between adaptations, homes and examine the results.
com.orchestranetworks.service.extensions
Provides classes and interfaces for specific extensions such as batch and adaptation tree optimizer.
com.orchestranetworks.ui
This package provides the capability to create custom user interface components that are integrated within EBX®.
com.orchestranetworks.ui.form
This package allows customizing forms.
com.orchestranetworks.ui.selection
This package provides interfaces with information about the selection.
com.orchestranetworks.userservice
A public API for user services.
com.orchestranetworks.userservice.permission
Allows the definition of activation rules and permission rules on user services.
com.orchestranetworks.workflow
Provides classes and interfaces for implementing workflow processes and invoking them.

- ## Uses of Adaptation in com.onwbp.adaptation

  Methods in com.onwbp.adaptation that return Adaptation
  Modifier and Type
  Method
  Description
  `final Adaptation`
  AdaptationHome.`findAdaptationOrNull(AdaptationName aName)`
  Returns the specified dataset or record based on its `AdaptationName`.
  `final Adaptation`
  AdaptationHome.`findParent(Adaptation aDataSetOrRecord)`
  Deprecated.
  Replaced by `getParent()`.
  `Adaptation`
  Adaptation.`getContainer()`
  This method returns the dataset that contains this adaptation.
  `Adaptation`
  AdaptationTable.`getContainerAdaptation()`
  Returns the dataset that contains this table.
  `Adaptation`
  Adaptation.`getParent()`
  Returns the parent of the current dataset or record.
  `Adaptation`
  Adaptation.`getUpToDateInstance()`
  Returns an object that is up-to-date with respect to the underlying persistent entity (dataset or table record).
  `Adaptation`
  AdaptationTable.`lookupAdaptationByName(AdaptationName aName)`
  Returns the record based on the name specified; returns `null` if no record by that name exists.
  `Adaptation`
  AdaptationTable.`lookupAdaptationByPrimaryKey(PrimaryKey aKey)`
  Returns the record specified by its primary key.
  `Adaptation`
  AdaptationTable.`lookupAdaptationByPrimaryKey(PrimaryKey aKey, boolean includeOcculting)`
  Returns the record specified by its primary key.
  `Adaptation`
  AdaptationTable.`lookupAdaptationByPrimaryKey(ValueContext aContext)`
  Returns the record that has its primary key specified by the specified context.
  `Adaptation`
  AdaptationTable.`lookupAdaptationByPrimaryKey(ValueContext aContext, boolean includeOcculting)`
  Returns the record specified by its primary key.
  `Adaptation`
  AdaptationTable.`lookupFirstRecordMatchingPredicate(boolean checkActualPrimaryKey, String aPredicateExpression)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  `Adaptation`
  AdaptationTable.`lookupFirstRecordMatchingPredicate(boolean checkActualPrimaryKey, String aPredicateExpression, boolean includeOcculting)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  `Adaptation`
  AdaptationTable.`lookupFirstRecordMatchingPredicate(String aPredicateExpression)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  `static Adaptation`
  XPathExpressionHelper.`lookupFirstRecordMatchingXPath(boolean checkActualPrimaryKey, Adaptation aDataSet, String anXPath)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  `static Adaptation`
  XPathExpressionHelper.`lookupFirstRecordMatchingXPath(boolean checkActualPrimaryKey, Adaptation aDataSet, String anXPath, boolean includeOcculting)`
  Returns a record based on the specified dataset and XPath expression, `null` if no such record exists.
  `static Adaptation`
  XPathExpressionHelper.`lookupFirstRecordMatchingXPath(Adaptation aDataSet, String anXPath)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  `Adaptation`
  RequestResult.`nextAdaptation()`
  Moves the cursor to the next record in the result and returns it.
  Methods in com.onwbp.adaptation that return types with arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `Map<SchemaNode,Adaptation>`
  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.
  `abstract List<Adaptation>`
  AdaptationHome.`findAllChildren(Adaptation aDataSetOrRecord)`
  Returns a list of all datasets or records that are direct children of the one specified.
  `abstract List<Adaptation>`
  AdaptationHome.`findAllDescendants(Adaptation aDataSetOrRecord)`
  Returns a list of all the datasets and records that inherit from the one specified, either as direct children or as descendants (recursive).
  `abstract List<Adaptation>`
  AdaptationHome.`findAllRoots()`
  Returns all the dataset roots of this `AdaptationHome`.
  `List<Adaptation>`
  RequestPagination.Page.`getRows()`
  Returns the rows of the current page, never `null`.
  `List<Adaptation>`
  AdaptationTable.`selectOccurrences(String aPredicateExpression)`
  Returns a list of records for the specified predicate.
  `List<Adaptation>`
  AdaptationTable.`selectOccurrences(String aPredicate, RequestSortCriteria sortCriteria)`
  Returns a list of records for the specified predicate and sort criteria.
  Methods in com.onwbp.adaptation with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `final boolean`
  AbstractPrefilteredAdaptationFilter.`accept(Adaptation aRecord)`
  `boolean`
  AdaptationFilter.`accept(Adaptation aRecord)`
  Returns whether or not a record is included in the filter result.
  `abstract boolean`
  AbstractPrefilteredAdaptationFilter.`acceptPrefilteredRecord(Adaptation aRecord)`
  Returns whether or not a record is included in the filter result, without taking the prefilter into account.
  `PrimaryKey`
  AdaptationTable.`computePrimaryKey(Adaptation anOccurrence)`
  Returns the same result as `getOccurrencePrimaryKey()`.
  `boolean`
  RequestResult.`contains(Adaptation aRecord)`
  Returns `true` if the specified record belongs to the result of this request (even if the record is obsolete).
  `static Request`
  XPathExpressionHelper.`createRequestForXPath(Adaptation aDataSet, String anXPath)`
  Creates a new request given a dataset and an XPath expression.
  `boolean`
  Adaptation.`equalsToAdaptation(Adaptation other)`
  Indicates whether the other specified dataset or record is "equal to" this one, that is, it has the `same reference` in the same `dataspace`.
  `abstract List<Adaptation>`
  AdaptationHome.`findAllChildren(Adaptation aDataSetOrRecord)`
  Returns a list of all datasets or records that are direct children of the one specified.
  `abstract List<Adaptation>`
  AdaptationHome.`findAllDescendants(Adaptation aDataSetOrRecord)`
  Returns a list of all the datasets and records that inherit from the one specified, either as direct children or as descendants (recursive).
  `final Adaptation`
  AdaptationHome.`findParent(Adaptation aDataSetOrRecord)`
  Deprecated.
  Replaced by `getParent()`.
  `RequestPagination.Page`
  RequestPagination.`getNextPage(Adaptation rowJustBeforePage)`
  Returns the page which contains the records just after the specified row.
  `RequestPagination.Page`
  RequestPagination.`getPreviousPage(Adaptation rowJustAfterPage)`
  Returns the page which contains the records just before the specified row.
  `boolean`
  IncompatibleChangeError.`isRemovedInstance(Adaptation aDataSet)`
  `static Adaptation`
  XPathExpressionHelper.`lookupFirstRecordMatchingXPath(boolean checkActualPrimaryKey, Adaptation aDataSet, String anXPath)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  `static Adaptation`
  XPathExpressionHelper.`lookupFirstRecordMatchingXPath(boolean checkActualPrimaryKey, Adaptation aDataSet, String anXPath, boolean includeOcculting)`
  Returns a record based on the specified dataset and XPath expression, `null` if no such record exists.
  `static Adaptation`
  XPathExpressionHelper.`lookupFirstRecordMatchingXPath(Adaptation aDataSet, String anXPath)`
  Returns the first record that matches the specified XPath predicate, `null` if no such record exists.
  Constructors in com.onwbp.adaptation with parameters of type Adaptation
  Modifier
  Constructor
  Description
  ``
  `IncompatibleChangeError(String aMessage, Adaptation aRemovedInstance)`

- ## Uses of Adaptation in com.orchestranetworks.hierarchy

  Methods in com.orchestranetworks.hierarchy that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  HierarchyNode.`getJoinOccurrence()`
  Returns the association record that links the current node with its parent.
  `Adaptation`
  HierarchyNode.`getOccurrence()`
  Returns the current record being displayed.

- ## Uses of Adaptation in com.orchestranetworks.instance

  Methods in com.orchestranetworks.instance that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  ValueContext.`getAdaptationInstance()`
  Returns the current dataset.
  Methods in com.orchestranetworks.instance with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `void`
  ValueContextForValidationOnTable.`addMessage(Adaptation aRecord, UserMessage aMessage)`
  Adds the specified validation message concerning a single record.
  `void`
  ValueContextForValidationOnTable.`addMessage(Adaptation aRecord, SchemaNode aNode, UserMessage aMessage)`
  Adds the specified validation message concerning a node in a single record.
  Method parameters in com.orchestranetworks.instance with type arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `void`
  ValueContextForValidationOnTable.`addMessage(List<Adaptation> records, UserMessage aMessage)`
  Adds the specified validation message concerning a set of records.

- ## Uses of Adaptation in com.orchestranetworks.permissions

  Methods in com.orchestranetworks.permissions that return types with arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `Map<SchemaNode,Adaptation>`
  QueryPermissionException.`getForbiddenNodes()`
  Returns the forbidden nodes used in the query and the dataset in which these are forbidden.
  Method parameters in com.orchestranetworks.permissions with type arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `static QueryPermissionException`
  QueryPermissionException.`create(Session aSession, Map<SchemaNode,Adaptation> forbiddenNodes)`
  Creates a QueryPermissionException.
  `static QueryPermissionException`
  QueryPermissionException.`create(Session aSession, Map<SchemaNode,Adaptation> forbiddenNodes, String message)`

- ## Uses of Adaptation in com.orchestranetworks.query

  Methods in com.orchestranetworks.query with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `QueryBuilder`
  QueryBuilder.`addDataset(String aName, Adaptation aDataset)`
  Adds the specified dataset using the provided name.

- ## Uses of Adaptation in com.orchestranetworks.rest.serialization

  Methods in com.orchestranetworks.rest.serialization with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `static ContentHolderForOutput`
  ContentHolderForOutput.`createForRecord(Adaptation aRecord)`
  Returns a new `ContentHolderForOutput` instance.

- ## Uses of Adaptation in com.orchestranetworks.rest.util

  Methods in com.orchestranetworks.rest.util with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `URI`
  URIBuilderForBuiltin.ForDataset.`buildForDataset(Adaptation aDataset)`
  Returns an absolute `URI` to a specified dataset in its automatically computed dataspace.
  `URI`
  URIBuilderForBuiltin.ForNode.`buildForNode(Adaptation aRecordOrDataset, Path aNodePath)`
  Returns an absolute `URI` to a specified record field or a dataset node, in its automatically computed dataspace.
  `URI`
  URIBuilderForBuiltin.ForRecord.`buildForRecord(Adaptation aRecord)`
  Returns an absolute `URI` to a specified record.
  `URI`
  URIBuilderForBuiltin.ForTable.`buildForTable(Adaptation aRecordOrDataset, SchemaNode aTableOrAssociationNode)`
  Returns an absolute `URI` to a specified table.
  `UriBuilder`
  URIBuilderForBuiltin.ForDataset.`dataset(Adaptation aDataset)`
  Returns a configured `URI` builder which can generate built-in REST services `URI` to a dataset in its automatically computed dataspace.
  `UriBuilder`
  URIBuilderForBuiltin.ForNode.`node(Adaptation aRecordOrDataset, Path aNodePath)`
  Returns a configured `URI` builder which can generate built-in REST services `URI` to a specified record field or dataset node, in its automatically computed dataspace.
  `UriBuilder`
  URIBuilderForBuiltin.ForRecord.`record(Adaptation aRecord)`
  Returns a configured `URI` builder which can generate built-in REST services `URI` to a specified record.
  `UriBuilder`
  URIBuilderForBuiltin.ForTable.`table(Adaptation aRecordOrDataset, SchemaNode aTableOrAssociationNode)`
  Returns a configured `URI` builder which can generate built-in REST services `URI` to a specified table.

- ## Uses of Adaptation in com.orchestranetworks.schema

  Methods in com.orchestranetworks.schema with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `boolean`
  TableRefFilter.`accept(Adaptation aRecord, ValueContext currentContext)`
  Returns whether the specified record is included in the filter result.
  `String`
  TableRefDisplay.`displayOccurrence(Adaptation aRecord, Locale aLocale)`
  Returns an end-user label for the specified record.
  `BusinessObjectModel`
  SchemaNode.`getBusinessObjectModel(Adaptation aDataset, Session aSession)`
  Returns the business object model associated to this node if it is a table node.
  `SchemaNodeRelationships`
  SchemaNode.`getRelationships(Adaptation aDataset, Session aSession)`
  Returns the relationships defined by this node.
  `SchemaNodeRelationships`
  SchemaNode.`getRelationships(Adaptation aDataset, Session aSession, boolean includeMetadata)`
  Returns the relationships defined by this node.
  `default UserMessage`
  TableRefFilter.`getValidationMessage(Adaptation aRecord, ValueContext currentContext)`
  Returns a validation message according to the specified context.
  `Object`
  ValueFunction.`getValue(Adaptation aDataSetOrRecord)`
  Returns the value in the context of the specified record or dataset.

- ## Uses of Adaptation in com.orchestranetworks.schema.businessObjects

  Methods in com.orchestranetworks.schema.businessObjects that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  Entity.`getRecord()`
  Returns the record linked to this entity.
  Methods in com.orchestranetworks.schema.businessObjects with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `List<BusinessObjectModel>`
  DataModelBusinessObjectModels.`getBusinessObjectModels(Adaptation aDataset, Session aSession)`
  Returns all the business object models defined in the data model.
  `BusinessObjectModel`
  DataModelBusinessObjectModels.`getBusinessObjetModelForTable(SchemaNode aTableNode, Adaptation aDataset, Session aSession)`
  Returns the business object model associated to the specified table.
  `MainEntity`
  BusinessObjectModel.`initForRead(Adaptation aRecord, Session aSessionOrNull)`
  Creates a read only facade from the specified record of the main table of this business object model.
  `BusinessObjectModel`
  DataModelBusinessObjectModels.`lookupBusinessObjectModel(String aName, Adaptation aDataset, Session aSession)`
  Return the business object model associated to the specified name.

- ## Uses of Adaptation in com.orchestranetworks.schema.info

  Methods in com.orchestranetworks.schema.info that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  SchemaFacetTableRef.`getLinkedRecord(Adaptation aRecord)`
  Returns the linked record for the specified record.
  `Adaptation`
  SchemaFacetTableRef.`getLinkedRecord(ValueContext aContext)`
  Returns the linked record for the specified context.
  `Adaptation`
  SchemaInheritanceProperties.`getLinkedRecord(Adaptation aRecord)`
  Returns the linked record containing the inherited node for the specified record.
  Methods in com.orchestranetworks.schema.info that return types with arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `List<Adaptation>`
  SchemaFacetTableRef.`getLinkedRecords(Adaptation aRecord)`
  Returns the linked records for the specified record.
  `List<Adaptation>`
  SchemaFacetTableRef.`getLinkedRecords(ValueContext aContext)`
  Returns the linked records for the specified context.
  Methods in com.orchestranetworks.schema.info with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `RequestResult`
  AssociationLink.`getAssociationResult(Adaptation aRecord)`
  Returns the result of the association link, in the context of the specified record.
  `Adaptation`
  SchemaFacetTableRef.`getLinkedRecord(Adaptation aRecord)`
  Returns the linked record for the specified record.
  `Adaptation`
  SchemaInheritanceProperties.`getLinkedRecord(Adaptation aRecord)`
  Returns the linked record containing the inherited node for the specified record.
  `List<Adaptation>`
  SchemaFacetTableRef.`getLinkedRecords(Adaptation aRecord)`
  Returns the linked records for the specified record.
  `AdaptationTable`
  AssociationLinkByLinkTable.`getLinkTable(Adaptation aRecordOrDataSet)`
  Returns the link table of this association.
  `RequestResult`
  SelectionLink.`getSelectionResult(Adaptation aRecord)`
  Returns the result of the selection link, in the context of the specified record.
  `Request`
  SchemaFacetTableRef.`getTableRefRequest(Adaptation aRecord)`
  Returns the request of the foreign key constraint, in the context of the specified record.
  `AdaptationTable`
  AssociationLink.`getTargetTable(Adaptation aRecordOrDataSet)`
  Returns the target table of this association.
  `boolean`
  AssociationLink.`isConsistent(Adaptation aRecordOrDataSet)`
  Returns `true` if this association is consistent with the specified record or dataset.

- ## Uses of Adaptation in com.orchestranetworks.schema.relationships

  Methods in com.orchestranetworks.schema.relationships that return types with arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `Iterable<Adaptation>`
  ReverseRelationshipInterDataset.`getOwnerDatasets(Adaptation aReferencedRecordOrDataset)`
  Returns the datasets that are an instance of the data model containing the node that defines the corresponding foreign key constraint, selection link or association link.
  Methods in com.orchestranetworks.schema.relationships with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `ExplicitRelationship`
  SchemaNodeExplicitRelationship.`getExplicitRelationship(Adaptation aDataset, Session aSession)`
  Returns the `ExplicitRelationship` object associated with this relationship.
  `static RequestResult`
  RelationshipsHelper.`getExplicitRelationshipResult(Adaptation aRecord, SchemaNode anExplicitRelationshipNode, Session aSession)`
  Returns the result of the explicit relationship defined by the specified node, in the context of the specified record.
  `static ReverseRelationshipResult`
  RelationshipsHelper.`getInterDatasetReferringRecords(Adaptation aReferencedRecord, SchemaNode aReferringNode, Adaptation aReferringDataset, Session aSession)`
  Returns the records in the specified referring dataset that refer to the specified record through the corresponding foreign key constraint, selection link or association link.
  `static ReverseRelationshipResult`
  RelationshipsHelper.`getIntraDatasetReferringRecords(Adaptation aReferencedRecord, SchemaNode aReferringNode, Session aSession)`
  Returns the records in the same dataset that refer to the specified record through the corresponding foreign key constraint, selection link or association link.
  `Iterable<Adaptation>`
  ReverseRelationshipInterDataset.`getOwnerDatasets(Adaptation aReferencedRecordOrDataset)`
  Returns the datasets that are an instance of the data model containing the node that defines the corresponding foreign key constraint, selection link or association link.
  `ReverseRelationshipResultsInterDataset`
  ReverseRelationshipInterDataset.`getReferringRecords(Adaptation aReferencedRecord)`
  Returns the records in the repository that refers to the specified record through the corresponding foreign key constraint, selection link or association link.
  `ReverseRelationshipResult`
  ReverseRelationshipIntraDataset.`getReferringRecords(Adaptation aReferencedRecord)`
  Returns the records in the dataset that refer to the specified record through the corresponding foreign key constraint, selection link or association link.
  `RequestResult`
  ExplicitRelationship.`getResult(Adaptation aRecord)`
  Returns the result of the relationship, in the context of the specified record.
  `RequestResult`
  SchemaNodeExplicitRelationship.`getResult(Adaptation aRecord, Session aSessionOrNull)`
  Returns the result of this relationship, in the context of the specified record.
  `SchemaNode`
  SchemaNodeExplicitRelationship.`getTableNode(Adaptation aDataset)`
  Returns the table node referred to by this link in the context of the specified dataset.

- ## Uses of Adaptation in com.orchestranetworks.schema.trigger

  Methods in com.orchestranetworks.schema.trigger that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  AfterCreateInstanceContext.`getAdaptationInstance()`
  Returns the dataset created.
  `Adaptation`
  BeforeDeleteInstanceContext.`getAdaptationInstance()`
  Returns the dataset to be deleted.
  `Adaptation`
  AfterCreateOccurrenceContext.`getAdaptationOccurrence()`
  Returns the record that has been created.
  `Adaptation`
  AfterModifyOccurrenceContext.`getAdaptationOccurrence()`
  Returns the record that has been modified.
  `Adaptation`
  BeforeDeleteOccurrenceContext.`getAdaptationOccurrence()`
  Returns the record to be deleted.
  `Adaptation`
  BeforeModifyOccurrenceContext.`getAdaptationOccurrence()`
  Returns the record to be modified.
  `Adaptation`
  AfterDuplicateInstanceContext.`getDataset()`
  Returns the dataset created after the duplication.
  `Adaptation`
  AfterModifyInstanceContext.`getDataset()`
  Returns the dataset that has been modified.
  `Adaptation`
  BeforeModifyInstanceContext.`getDataset()`
  Returns the dataset to be modified.
  `Adaptation`
  AfterDuplicateInstanceContext.`getDatasetToDuplicate()`
  Returns the dataset that has been duplicated.

- ## Uses of Adaptation in com.orchestranetworks.schema.types.dataset

  Methods in com.orchestranetworks.schema.types.dataset that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  DatasetSetFilterContext.`getCurrentDataset()`
  Returns the dataset currently selected.

- ## Uses of Adaptation in com.orchestranetworks.schema.types.dataspace

  Methods in com.orchestranetworks.schema.types.dataspace that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  DataspaceSetFilterContext.`getCurrentDataset()`
  Returns the dataset currently selected.

- ## Uses of Adaptation in com.orchestranetworks.service

  Methods in com.orchestranetworks.service that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  ProcedureContext.`doCopy(Adaptation aDataSet)`
  Copies the specified dataset.
  `Adaptation`
  ProcedureContext.`doCopy(AdaptationReference aName, Adaptation aDataSet)`
  Copies the specified dataset and gives it the specified reference.
  `Adaptation`
  ProcedureContext.`doCreateChild(AdaptationName aParentName, AdaptationReference requestedNameOrNull)`
  Creates a new dataset that is the child of the parent specified by `aParentName`.
  `Adaptation`
  ProcedureContext.`doCreateChild(AdaptationName aParentName, AdaptationReference requestedNameOrNull, Profile owner)`
  Creates a new dataset that is the child of the parent specified by `aParentName`.
  `Adaptation`
  ProcedureContext.`doCreateOcculting(ValueContext aKey, AdaptationTable aTable)`
  Creates an occulting record in the specified table.
  `Adaptation`
  ProcedureContext.`doCreateOccurrence(ValueContext aContent, AdaptationTable aTable)`
  Creates a record in the specified table.
  `Adaptation`
  ProcedureContext.`doCreateOccurrence(ValueContext aContent, AdaptationTable aTable, UserReference aCreator, Date aCreationTime, UserReference aLastUpdater, Date aLastUpdateTime)`
  Creates a record in the specified table with the specified system metadata.
  `Adaptation`
  ProcedureContext.`doCreateOverwriting(ValueContext aContent, AdaptationTable aTable)`
  Deprecated.
  `Adaptation`
  ProcedureContext.`doCreateRoot(ValueContext aContent, AdaptationTable aTable)`
  Deprecated.
  `Adaptation`
  ProcedureContext.`doCreateRoot(SchemaLocation aSchemaLocation, AdaptationReference requestedNameOrNull, Profile owner)`
  Creates a new root dataset.
  `Adaptation`
  ProcedureContext.`doModifyContent(Adaptation aTarget, ValueContext aContent)`
  Modifies the content as specified.
  `Adaptation`
  ProcedureContext.`doOccult(Adaptation aRecord)`
  Occults the specified record.
  `Adaptation`
  ValidationReportItemSubjectForAdaptation.`getAdaptation()`
  Returns the dataset or record containing the node associated with this validation item.
  `abstract Adaptation`
  ServiceContext.`getCurrentAdaptation()`
  Deprecated.
  Returns the dataset or record currently selected in the user interface.
  `Adaptation`
  ExportSpec.`getSourceAdaptation()`
  `Adaptation`
  ImportSpec.`getTargetAdaptation()`
  Methods in com.orchestranetworks.service that return types with arguments of type Adaptation
  Modifier and Type
  Method
  Description
  `abstract List<Adaptation>`
  ServiceContext.`getSelectedOccurrences()`
  Deprecated.
  Returns the records currently selected in the user interface.
  Methods in com.orchestranetworks.service with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `void`
  ProcedureContext.`disableDatasetValidation(Adaptation aDataset)`
  Deprecated.
  Since 6.0.0, incremental validation is no longer triggered by a procedure.
  `Adaptation`
  ProcedureContext.`doCopy(Adaptation aDataSet)`
  Copies the specified dataset.
  `Adaptation`
  ProcedureContext.`doCopy(AdaptationReference aName, Adaptation aDataSet)`
  Copies the specified dataset and gives it the specified reference.
  `Adaptation`
  ProcedureContext.`doModifyContent(Adaptation aTarget, ValueContext aContent)`
  Modifies the content as specified.
  `Adaptation`
  ProcedureContext.`doOccult(Adaptation aRecord)`
  Occults the specified record.
  `AccessPermission`
  SessionPermissions.`getAdaptationAccessPermission(Adaptation aDataSetOrRecord)`
  Returns the current user's access rights on the specified dataset or record.
  `ValueContextForUpdate`
  ProcedureContext.`getContextForNewOccurrence(Adaptation recordToCopy, AdaptationTable aTable)`
  Provides an interface for copying a context from an existing record.
  `ActionPermission`
  SessionPermissions.`getInstanceActionPermissionForService(ServiceKey serviceKey, Adaptation aDataSet)`
  Returns the current user's permissions for executing the dataset service specified.
  `ActionPermission`
  SessionPermissions.`getInstanceActionPermissionToActivateInstance(Adaptation aDataSet)`
  Returns the current user's permissions for activating the dataset specified.
  `ActionPermission`
  SessionPermissions.`getInstanceActionPermissionToCreateChild(Adaptation aDataSet)`
  Returns the current user's permissions for creating child datasets from the dataset specified.
  `ActionPermission`
  SessionPermissions.`getInstanceActionPermissionToCreateDuplicate(Adaptation aDataSet)`
  Returns the current user's permissions for duplicating the dataset specified.
  `ActionPermission`
  SessionPermissions.`getInstanceActionPermissionToDeleteInstance(Adaptation aDataSet)`
  Returns the current user's permissions for deleting the dataset specified.
  `AccessPermission`
  SessionPermissions.`getNodeAccessPermission(SchemaNode aNode, Adaptation aDataSetOrRecord)`
  Returns the current user's access rights on the specified node in an update/display context.
  `AccessPermission`
  SessionPermissions.`getNodeAccessPermissionForForm(SchemaNode aNode, Adaptation aDataSetOrRecord)`
  Returns the current user's access rights on the specified node when displayed in a form.
  `ActionPermission`
  SessionPermissions.`getNodeActionPermissionForService(ServiceKey aServiceKey, SchemaNode aNode, Adaptation aDataSetOrRecord)`
  Returns the current user's permissions for executing the service on the specified node.
  `ActionPermission`
  SessionPermissions.`getOccurrenceActionPermissionToDelete(Adaptation aRecord, AdaptationTable aTable)`
  Returns the current user's permissions for deleting the specified table record.
  `ActionPermission`
  SessionPermissions.`getOccurrenceActionPermissionToOccult(Adaptation aRecord, AdaptationTable aTable)`
  Returns the current user's permissions for occulting the specified table record.
  `ActionPermission`
  SessionPermissions.`getOccurrenceActionPermissionToOverwrite(Adaptation aRecord, AdaptationTable aTable)`
  Returns the current user's permissions for overwriting the specified table record.
  `AccessPermission`
  AccessRule.`getPermission(Adaptation aDataSetOrRecord, Session aSession, SchemaNode aNode)`
  Returns permissions for the specified arguments.
  `AccessPermission`
  AccessRule.NoWriteRule.`getPermission(Adaptation anAdaptation, Session aSession, SchemaNode aNode)`
  `ActionPermission`
  ServicePermission.`getPermission(SchemaNode aNode, Adaptation aDataSetOrRecord, Session aSession)`
  Returns a permission for the specified arguments.
  `abstract String`
  ServiceContext.`getURLForServiceSelection(AdaptationHome aHome, Adaptation aRecordOrInstance, SchemaNode aNode, ServiceKey aServiceKey)`
  Deprecated.
  Returns a user interface URL that selects the specified node in the given record or dataset and starts the specified service on it, in the context of the given `AdaptationHome`.
  `abstract String`
  ServiceContext.`getURLForServiceSelection(AdaptationHome aHome, Adaptation aRecordOrInstance, ServiceKey aServiceKey)`
  Deprecated.
  Returns a user interface URL that selects the specified record or dataset and starts the specified service on it, in the context of the given `AdaptationHome`.
  `abstract String`
  ServiceContext.`getURLForServiceSelection(Adaptation aRecordOrInstance, SchemaNode aNode, ServiceKey aServiceKey)`
  Deprecated.
  Returns a user interface URL which selects the specified node in the given record or dataset and starts the specified service on it.
  `abstract String`
  ServiceContext.`getURLForServiceSelection(Adaptation aRecordOrInstance, ServiceKey aServiceKey)`
  Deprecated.
  Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.
  `boolean`
  Session.`isUserOwner(Adaptation aDataset)`
  Returns `true` if this user is an owner of the specified dataset.
  `void`
  ProcedureContext.`setInstanceActivation(Adaptation aDataSet, boolean activationState)`
  Activates or deactivates the specified dataset.
  `void`
  ProcedureContext.`setInstanceDescription(Adaptation aDataSet, UserMessage aDescription)`
  Specifies a description for the specified dataset.
  `void`
  ProcedureContext.`setInstanceLabel(Adaptation aDataSet, UserMessage aLabel)`
  Specifies a label for the specified dataset.
  `void`
  ProcedureContext.`setInstanceOwner(Adaptation aDataSet, Profile newOwner)`
  Defines the owner of the specified dataset.
  `void`
  ExportSpec.`setSourceAdaptation(Adaptation aSource)`
  Specifies the source dataset of the export.
  `void`
  ImportSpec.`setTargetAdaptation(Adaptation aTarget)`
  Specifies the target dataset of the import.

- ## Uses of Adaptation in com.orchestranetworks.service.comparison

  Methods in com.orchestranetworks.service.comparison that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  DifferenceBetweenContents.`getContentOnLeft()`
  Returns the content on the left side.
  `Adaptation`
  DifferenceBetweenInstances.`getContentOnLeft()`
  `Adaptation`
  DifferenceBetweenOccurrences.`getContentOnLeft()`
  `Adaptation`
  DifferenceBetweenContents.`getContentOnRight()`
  Returns the content on the right side.
  `Adaptation`
  DifferenceBetweenInstances.`getContentOnRight()`
  `Adaptation`
  DifferenceBetweenOccurrences.`getContentOnRight()`
  `Adaptation`
  ExtraAdaptationOnLeft.`getExtraAdaptationOnLeft()`
  `Adaptation`
  ExtraInstanceOnLeft.`getExtraAdaptationOnLeft()`
  `Adaptation`
  ExtraOccurrenceOnLeft.`getExtraAdaptationOnLeft()`
  `Adaptation`
  ExtraAdaptationOnRight.`getExtraAdaptationOnRight()`
  `Adaptation`
  ExtraInstanceOnRight.`getExtraAdaptationOnRight()`
  `Adaptation`
  ExtraOccurrenceOnRight.`getExtraAdaptationOnRight()`
  `Adaptation`
  ExtraInstance.`getExtraInstance()`
  Returns the extra dataset.
  `Adaptation`
  ExtraOccurrence.`getExtraOccurrence()`
  Returns the extra record.
  `Adaptation`
  DifferenceBetweenInstances.`getInstanceOnLeft()`
  Returns the dataset on the left.
  `Adaptation`
  DifferenceBetweenInstances.`getInstanceOnRight()`
  Returns the dataset on the right.
  `Adaptation`
  DifferenceBetweenOccurrences.`getOccurrenceOnLeft()`
  Returns the record on the left side.
  `Adaptation`
  DifferenceBetweenOccurrences.`getOccurrenceOnRight()`
  Returns the record on the right side.
  Methods in com.orchestranetworks.service.comparison with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `static DifferenceBetweenInstances`
  DifferenceHelper.`compareDatasetByDate(Adaptation aDataset, boolean isResolvedMode, Date aStartDate, Date aEndDate)`
  Performs a comparison between two transaction dates for a dataset and returns the result.
  `static DifferenceBetweenInstances`
  DifferenceHelper.`compareDatasetByDate(Adaptation aDataset, Date aStartDate, Date aEndDate)`
  Performs a comparison between two transaction dates for a dataset and returns the result.The comparison operates in unresolved mode by default.
  `static DifferenceBetweenInstances`
  DifferenceHelper.`compareDatasetByTransactionID(Adaptation aDataset, boolean isResolvedMode, long aStartTransactionId, long aEndTransactionId)`
  Performs a comparison between two transaction for a dataset and returns the result.
  `static DifferenceBetweenInstances`
  DifferenceHelper.`compareDatasetByTransactionID(Adaptation aDataset, long aStartTransactionId, long aEndTransactionId)`
  Performs a comparison between two transaction for a dataset and returns the result.The comparison operates in unresolved mode by default.
  `static DifferenceBetweenInstances`
  DifferenceHelper.`compareInstances(Adaptation instanceOnLeft, Adaptation instanceOnRight, boolean isResolvedMode)`
  Performs a comparison between two datasets.
  `static DifferenceBetweenOccurrences`
  DifferenceHelper.`compareOccurrences(Adaptation recordOnLeft, Adaptation recordOnRight, boolean isResolvedMode)`
  Performs a comparison between two records.
  `static DifferenceBetweenOccurrences`
  DifferenceHelper.`compareOccurrences(Adaptation recordOnLeft, Adaptation recordOnRight, boolean isResolvedMode, boolean showDetails)`
  Performs a comparison between two records.
  `static DifferenceBetweenOccurrences`
  DifferenceHelper.`compareRecordByDate(Adaptation aRecord, boolean isResolvedMode, Date aStartDate, Date aEndDate)`
  Performs a comparison between two dates for a record and returns the result.
  `static DifferenceBetweenOccurrences`
  DifferenceHelper.`compareRecordByDate(Adaptation aRecord, Date aStartDate, Date aEndDate)`
  Performs a comparison between two dates for a record and returns the result.The comparison operates in unresolved mode by default.
  `static DifferenceBetweenOccurrences`
  DifferenceHelper.`compareRecordByTransactionID(Adaptation aRecord, boolean isResolvedMode, long aStartTransactionId, long aEndTransactionId)`
  Performs a comparison between two transaction times for a record and returns the result.
  `static DifferenceBetweenOccurrences`
  DifferenceHelper.`compareRecordByTransactionID(Adaptation aRecord, long aStartTransactionId, long aEndTransactionId)`
  Performs a comparison between two transaction times for a record and returns the result.The comparison operates in unresolved mode by default.

- ## Uses of Adaptation in com.orchestranetworks.service.extensions

  Methods in com.orchestranetworks.service.extensions that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  AdaptationTreeOptimizerIterator.`currentAdaptation()`
  Returns the current dataset, which will be optimized on the next call to `AdaptationTreeOptimizerIterator.executeCurrent()`.
  `Adaptation`
  AdaptationTreeOptimizerIterator.`executeCurrent()`
  Optimizes current dataset and sets the cursor to the next one.
  `Adaptation`
  AdaptationTreeOptimizerSpec.`getAdaptation()`
  `Adaptation`
  AdaptationTreeOptimizerIterator.`nextAdaptation()`
  Returns the next dataset, which will become the current one after the next call to `AdaptationTreeOptimizerIterator.executeCurrent()`.
  Methods in com.orchestranetworks.service.extensions with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `static ReplicationUnit`
  ReplicationUnit.`newReplicationUnit(ReplicationUnitKey aUnitKey, Adaptation aDataSet)`
  Returns the replication unit for the specified dataset and unit name.
  Constructors in com.orchestranetworks.service.extensions with parameters of type Adaptation
  Modifier
  Constructor
  Description
  ``
  `AdaptationTreeOptimizerSpec_MutualizeCommons(Adaptation aDataSet, boolean includeAllDescendants)`
  Creates a specification for factoring common values in a dataset tree.
  ``
  `AdaptationTreeOptimizerSpec_RemoveDuplicates(Adaptation aDataSet, boolean includeAllDescendants)`
  Constructs a specification for removing duplicates in a dataset tree.

- ## Uses of Adaptation in com.orchestranetworks.ui

  Methods in com.orchestranetworks.ui that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  UIAjaxContext.`getCurrentAdaptation()`
  Returns the dataset or record currently selected in the session.
  `Adaptation`
  UIAjaxContext.`getCurrentDataSet()`
  Returns the dataset currently selected in the session.
  `Adaptation`
  UIFormRequestContext.`getCurrentDataSet()`
  Returns the dataset currently selected.
  `Adaptation`
  UIAjaxContext.`getCurrentRecord()`
  Returns the record currently selected in the session.
  `Adaptation`
  UILabelRendererContext.`getOccurrence()`
  Returns the current record that is being displayed.
  `Adaptation`
  UILabelRendererForHierarchyContext.`getOccurrence()`
  Returns the current record being displayed.
  Methods in com.orchestranetworks.ui with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `String`
  UIResourceLocator.`getURLForSelection(Adaptation aDataSetOrRecord)`
  Returns a URL that, when used, changes the current navigation context to the specified dataset or record.
  `String`
  UIResourceLocator.`getURLForSelection(Adaptation aDataSetOrRecord, Path aPath)`
  Returns a URL that, when used, changes the current navigation context to the specified node and dataset or record.
  `String`
  UIResourceLocator.`getURLForViewSelection(Adaptation instance, String viewPublication)`
  Returns a URL that, when used, changes the current navigation context to the specified custom view in the specified dataset.
  `void`
  UIHttpManagerComponent.`selectInstanceOrOccurrence(Adaptation aDataSetOrRecord)`
  Selects the specified dataset or record.
  `void`
  UIHttpManagerComponent.`selectInstanceOrOccurrenceWithPredicate(Adaptation aDataSetOrRecord, String aPredicate)`
  Selects the specified dataset or record with the specified predicate restriction.
  `void`
  UIHttpManagerComponent.`selectNode(Adaptation aDataSetOrRecord, Path aNode)`
  Selects the specified node.
  `void`
  UIHttpManagerComponent.`selectNode(Adaptation aDataSetOrRecord, Path aNode, String aPredicate)`
  Selects the specified node with the specified predicate restriction.

- ## Uses of Adaptation in com.orchestranetworks.ui.form

  Methods in com.orchestranetworks.ui.form that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  UIFormContext.`getCurrentDataSet()`
  Returns the dataset containing the current record.
  `Adaptation`
  UIFormContext.`getCurrentRecord()`
  Returns the persisted record being edited.

- ## Uses of Adaptation in com.orchestranetworks.ui.selection

  Methods in com.orchestranetworks.ui.selection that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  AssociationTableEntitySelection.`getAssociationSourceRecord()`
  Returns the association source record.
  `Adaptation`
  DatasetEntitySelection.`getDataset()`
  Returns the currently selected dataset.
  `Adaptation`
  AssociationRecordEntitySelection.`getRecord()`
  Returns the currently selected associated record.
  `Adaptation`
  RecordEntitySelection.`getRecord()`
  Returns the currently selected record.

- ## Uses of Adaptation in com.orchestranetworks.userservice

  Methods in com.orchestranetworks.userservice that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  UserServiceForCreate.`getCreatedRecord(UserServiceGetCreatedRecordContext<S> aContext)`
  Should return the main record created by this service, or null if no record was created.
  `Adaptation`
  UserServiceGetCreatedRecordContext.`getCreatedRecord(ObjectKey aKey)`
  If a record was created using the method `UserServiceTransaction.add(ObjectKey)`, then this method will return the corresponding adaptation.
  Methods in com.orchestranetworks.userservice with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `String`
  UserServiceResourceLocator.`getURLForServiceSelection(Adaptation aRecordOrInstance, SchemaNode aNode, ServiceKey aServiceKey)`
  Deprecated.
  Instead use {`UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, Adaptation, SchemaNode, URLQuery)`.
  `String`
  UserServiceResourceLocator.`getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrDataSet)`
  Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.
  `String`
  UserServiceResourceLocator.`getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrInstance, SchemaNode aNode)`
  Returns a user interface URL which selects the specified node of the given record or dataset and starts the specified service on it.
  `String`
  UserServiceResourceLocator.`getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrInstance, SchemaNode aNode, URLQuery aQuery)`
  Returns a user interface URL which selects the specified node of the given record or dataset and starts the specified service on it.
  `String`
  UserServiceResourceLocator.`getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrDataSet, URLQuery aQuery)`
  Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.
  `static UserServiceEventOutcome`
  UserServiceNext.`nextService(ServiceKey aServiceKey, Adaptation aRecordOrDataSet)`
  The current user service will close, the specified record or dataset will be selected and the specified service started.
  `static UserServiceEventOutcome`
  UserServiceNext.`nextTableView(Adaptation aDataSet, String aTableViewPublicationId)`
  The current user service will close and the specified table view will be selected.
  `void`
  UserServiceObjectContextBuilder.`registerNewDuplicatedRecord(ObjectKey anObjectKey, Adaptation aRecord)`
  Registers a new duplicated record in the object context.
  `void`
  UserServiceObjectContextBuilder.`registerRecordOrDataSet(ObjectKey anObjectKey, Adaptation aRecordOrDataSet)`
  Registers an existing record or dataset in the object context.
  `void`
  UserServiceDisplayConfigurator.`setToolbar(Toolbar aToolbar, Adaptation aRecord)`
  Sets the toolbar to one defined programmatically for a record.
  `void`
  UserServiceDisplayConfigurator.`setToolbar(String aToolbarName, Adaptation aRecord)`
  Sets the toolbar to one defined in a schema for a record.

- ## Uses of Adaptation in com.orchestranetworks.userservice.permission

  Methods in com.orchestranetworks.userservice.permission that return Adaptation
  Modifier and Type
  Method
  Description
  `Adaptation`
  ServiceActivationRuleForDatasetContext.`getDataset()`
  Returns the current dataset.

- ## Uses of Adaptation in com.orchestranetworks.workflow

  Methods in com.orchestranetworks.workflow with parameters of type Adaptation
  Modifier and Type
  Method
  Description
  `static List<WorkflowLauncherInfo>`
  WorkflowLauncherInfoHelper.`getAvailableActivations(Repository repository, Adaptation dataset, String tableInput, String locale)`
  Retrieves a list of WorkflowLauncherInfo objects representing available workflow launcher activations.