# Uses of Class
com.onwbp.adaptation.AdaptationName

Packages that use AdaptationName
Package
Description
com.onwbp.adaptation
Provides core classes and interfaces for accessing datasets, tables, and their records.
com.onwbp.adaptation.validation
com.orchestranetworks.rest.util
com.orchestranetworks.schema.relationships
Provides interfaces for accessing relationships defined in a data model.
com.orchestranetworks.schema.types.dataset
Interfaces to define sets of data set references.
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.ui
This package provides the capability to create custom user interface components that are integrated within EBX®.
com.orchestranetworks.workflow
Provides classes and interfaces for implementing workflow processes and invoking them.

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

  Subclasses of AdaptationName in com.onwbp.adaptation
  Modifier and Type
  Class
  Description
  `final class`
  `AdaptationReference`
  Uniquely identifies a dataset in a given dataspace or snapshot.
  Methods in com.onwbp.adaptation that return AdaptationName
  Modifier and Type
  Method
  Description
  `static AdaptationName`
  AdaptationName.`forName(String aName)`
  Returns an instance of `AdaptationReference`.
  `AdaptationName`
  Adaptation.`getAdaptationName()`
  Returns the name that uniquely identifies this dataset or record in the current dataspace.
  `AdaptationName`
  AdaptationTable.`getRootKey()`
  Deprecated.
  Does not work for mapped tables.
  Methods in com.onwbp.adaptation that return types with arguments of type AdaptationName
  Modifier and Type
  Method
  Description
  `abstract Map<AdaptationName,ValidationReport>`
  AdaptationHome.`getValidationReportsMap(Severity minimalSeverity)`
  Deprecated.
  since 6.1.1.
  Methods in com.onwbp.adaptation with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `final Adaptation`
  AdaptationHome.`findAdaptationOrNull(AdaptationName aName)`
  Returns the specified dataset or record based on its `AdaptationName`.
  `Adaptation`
  AdaptationTable.`lookupAdaptationByName(AdaptationName aName)`
  Returns the record based on the name specified; returns `null` if no record by that name exists.

- ## Uses of AdaptationName in com.onwbp.adaptation.validation

  Methods in com.onwbp.adaptation.validation that return types with arguments of type AdaptationName
  Modifier and Type
  Method
  Description
  `Map<AdaptationName,ValidationReport>`
  DataspaceValidationReport.`getAllValidationReports()`
  Returns a map of all validation reports of datasets in the dataspace.
  Methods in com.onwbp.adaptation.validation with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `ValidationReport`
  DataspaceValidationReport.`getDatasetValidationReport(AdaptationName adaptationName)`
  Returns the validation report of the specified dataset or NULL

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

  Methods in com.orchestranetworks.rest.util with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `URI`
  URIBuilderForBuiltin.ForDataset.`buildForDataset(HomeKey aDataspaceKey, AdaptationName aDatasetName)`
  Returns an absolute `URI` to a specified dataset in a specified dataspace.
  `URI`
  URIBuilderForBuiltin.ForNode.`buildForNode(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath)`
  Returns an absolute `URI` to a specified dataset node, in a specified dataspace.
  `UriBuilder`
  URIBuilderForBuiltin.ForDataset.`dataset(HomeKey aDataspaceKey, AdaptationName aDatasetName)`
  Returns a configured `URI` builder which can generate built-in REST services `URI` to a specified dataset in a specified dataspace.
  `UriBuilder`
  URIBuilderForBuiltin.ForNode.`node(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath)`
  Returns a configured `URI` builder which can generate built-in REST services `URI` to a specified dataset node, in a specified dataspace.

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

  Methods in com.orchestranetworks.schema.relationships with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `ReverseRelationshipResult`
  ReverseRelationshipResultInDataspace.`getResultInDataset(AdaptationName aDatasetName)`
  Returns the result of this reverse relationship in the specified dataset.

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

  Methods in com.orchestranetworks.schema.types.dataset with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `boolean`
  DatasetSetFilter.`accept(AdaptationName aDatasetName, DatasetSetFilterContext aContext)`
  Returns whether the specified dataset is included in the filter result in the context of the specified record or dataset.
  `void`
  DatasetSet.`excludeDatasetsMatching(AdaptationName aDatasetName, DatasetSet.DatasetChildrenPolicy aChildrenPolicy)`
  From the datasets set created thanks to the include methods, excludes the datasets matching the specified name, and its descendants according to the provided children policy.
  `void`
  DatasetSet.`includeDatasetsMatching(AdaptationName aDatasetName, DatasetSet.DatasetChildrenPolicy aChildrenPolicy)`
  Includes the datasets matching the given name and its descendants according to the provided children policy.

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

  Methods in com.orchestranetworks.service with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `void`
  ArchiveExportSpec.`addInstance(AdaptationName aDataSetName, boolean exportAllDescendants)`
  Adds a dataset to export.
  `void`
  ArchiveExportSpec.`addInstance(AdaptationName aDataSetName, InstanceContentSpec aHeader)`
  Adds a dataset to export.
  `void`
  ArchiveImportSpec.`addInstance(AdaptationName aDataSet, boolean includeAllDescendants)`
  Adds a dataset to import.
  `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`.
  `void`
  ProcedureContext.`doDelete(AdaptationName aName, boolean isDeletingChildren)`
  Deletes the specified dataset or record.
  `ValueContextForUpdate`
  ProcedureContext.`getContext(AdaptationName aName)`
  Provides an interface for reading and/or updating persisted content.
  `MergeSpecForInstanceContents`
  MergeSpecForHome.`getSpecForInstanceReference(AdaptationName aDataSetReference)`
  `void`
  MergeSpecForHome.`setAllContentsForInstanceReference(AdaptationName aDataSetReference)`
  Defines that a dataset must be globally merged (its values, its permissions and its header).
  `void`
  MergeSpecForHome.`setContentsForInstanceReference(AdaptationName aDataSetReference, MergeSpecForInstanceContents aSpec)`
  Defines what must be merged for a given dataset reference.

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

  Methods in com.orchestranetworks.service.comparison that return AdaptationName
  Modifier and Type
  Method
  Description
  `AdaptationName`
  ExtraInstance.`getExtraInstanceName()`
  `AdaptationName`
  ExtraOccurrence.`getExtraOccurrenceName()`
  `AdaptationName`
  DifferenceBetweenInstances.`getInstanceOnRightName()`
  Methods in com.orchestranetworks.service.comparison with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `DifferenceBetweenInstances`
  DifferenceBetweenHomes.`getDeltaInstance(AdaptationName instanceName)`
  For values, returns the differences of the dataset, `null` if there are no differences or if dataset only exists on the left or on the right.
  `ExtraInstanceOnLeft`
  DifferenceBetweenHomes.`getExtraInstanceOnLeft(AdaptationName adaptationName)`
  Returns the specified extra dataset on the left, `null` if there is not such dataset.
  `ExtraInstanceOnRight`
  DifferenceBetweenHomes.`getExtraInstanceOnRight(AdaptationName adaptationName)`
  Returns the specified extra dataset on the right, `null` if there no such dataset.

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

  Methods in com.orchestranetworks.ui with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `void`
  UIHttpManagerComponent.`compareSelectionWithEntity(HomeKey homeOnRightKey, AdaptationName instanceOnRight, String tableOrOccurrenceOnRight)`
  Specifies the activation of the `comparison service`.
  `static UIHttpManagerComponent`
  UIHttpManagerComponent.`createWithBaseURI(String baseURI, boolean enforceStrongEncoding, AdaptationName aManagerReference)`
  Deprecated.
  Since 5.9.0, use instead `UIHttpManagerComponent.createWithBaseURI(String, AdaptationName)`.
  `static UIHttpManagerComponent`
  UIHttpManagerComponent.`createWithBaseURI(String baseURI, AdaptationName aManagerReference)`
  Creates an instance of this class in order to call the EBX® user interface from an external application.
  `void`
  UIHttpManagerComponent.`select(HomeKey aDataSpaceOrSnapshotKey, AdaptationName aDataSetReference, Path aPath)`
  Selects the node in the specified dataset.
  `void`
  UIHttpManagerComponent.`select(HomeKey aDataSpaceOrSnapshotKey, AdaptationName aDataSetReference, String aXPathExpression)`
  Specifies an entity selection in the EBX® repository.
  `void`
  UIHttpManagerComponent.`selectInstance(HomeKey aDataSpaceOrSnapshotKey, AdaptationName aDataSetReference)`
  Selects the specified dataset.

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

  Methods in com.orchestranetworks.workflow that return AdaptationName
  Modifier and Type
  Method
  Description
  `AdaptationName`
  PublicationSpec.`getAdaptationName()`
  Retrieves the identifier of the workflow model associated with this publication.
  `AdaptationName`
  PublishedProcess.`getAdaptationName()`
  Returns the name of the associated workflow model.
  Methods in com.orchestranetworks.workflow with parameters of type AdaptationName
  Modifier and Type
  Method
  Description
  `ProcessLauncher`
  SubWorkflowsCreationContext.`registerSubWorkflow(AdaptationName aWorkflowModel, String aSubWorkflowName)`
  Registers the launch of a sub-workflow.
  Constructors in com.orchestranetworks.workflow with parameters of type AdaptationName
  Modifier
  Constructor
  Description
  ``
  `PublicationSpec(AdaptationName adaptationName, String publicationName, PublicationSpec.PublicationMode publicationMode)`
  Constructor.