# Uses of Class
com.orchestranetworks.instance.HomeKey

Packages that use HomeKey
Package
Description
com.onwbp.adaptation
Provides core classes and interfaces for accessing datasets, tables, and their records.
com.orchestranetworks.instance
Provides interfaces for accessing data sets.
com.orchestranetworks.rest.util
com.orchestranetworks.schema
Represents XML Schema concepts and provides schema extensions capabilities.
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.types.dataspace
Interfaces to define sets of data space keys.
com.orchestranetworks.ui
This package provides the capability to create custom user interface components that are integrated within EBX®.

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

  Methods in com.onwbp.adaptation that return HomeKey
  Modifier and Type
  Method
  Description
  `final HomeKey`
  AdaptationHome.`getKey()`
  Returns the key that identifies this dataspace or snapshot in the current repository.

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

  Subclasses of HomeKey in com.orchestranetworks.instance
  Modifier and Type
  Class
  Description
  `final class`
  `BranchKey`
  Identifies a dataspace in a repository.
  `final class`
  `VersionKey`
  Identifies a snapshot in a repository.
  Methods in com.orchestranetworks.instance that return HomeKey
  Modifier and Type
  Method
  Description
  `HomeKey`
  HomeCreationSpec.`getKey()`
  `static final HomeKey`
  HomeKey.`parse(String aString)`
  Parses the specified string, so as to return either a dataspace or snapshot key.
  Methods in com.orchestranetworks.instance with parameters of type HomeKey
  Modifier and Type
  Method
  Description
  `abstract AdaptationHome`
  Repository.`createHome(AdaptationHome parentDataSpace, HomeKey aKey, Profile owner, Session aSession, UserMessage aLabel, UserMessage aDescription)`
  Creates the specified dataspace or snapshot.
  `abstract AdaptationHome`
  Repository.`lookupHome(boolean d3Lookup, HomeKey aKey)`
  Returns the specified dataspace or snapshot.
  `abstract AdaptationHome`
  Repository.`lookupHome(HomeKey aKey)`
  Returns the specified dataspace or snapshot.
  `void`
  HomeCreationSpec.`setKey(HomeKey aDataSpaceOrSnapshotKey)`
  Specifies the unique identifier of the dataspace or snapshot to be created.

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

  Methods in com.orchestranetworks.rest.util with parameters of type HomeKey
  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.ForDataspace.`buildForDataspace(HomeKey aDataspaceKey)`
  Beta feature: Returns an absolute `URI` to the specified dataspace key.
  `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.ForDataspace.`dataspace(HomeKey aDataspaceKey)`
  Beta feature: Returns a configured `URI` builder which can generate built-in REST services `URI` to a 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 HomeKey in com.orchestranetworks.schema

  Methods in com.orchestranetworks.schema with parameters of type HomeKey
  Modifier and Type
  Method
  Description
  `void`
  DependenciesDefinitionContext.`addDependencyToInsertAndDeleteInOtherInstance(Path tablePathInContainer, AdaptationReference containerReference, HomeKey homeReference)`
  Specifies that the validation result of the current constraint depends on the insertions and deletions of the specified table node of a given dataset in a specific dataspace.
  `void`
  DependenciesDefinitionContext.`addDependencyToInsertDeleteAndModifyInOtherInstance(Path nodePath, AdaptationReference containerReference, HomeKey homeReference)`
  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.
  `void`
  DependenciesDefinitionContext.`addDependencyToInsertDeleteAndModifyInOtherInstance(SchemaNode sourceNode, AdaptationReference containerDataSetReference, HomeKey dataSpaceReference)`
  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.

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

  Methods in com.orchestranetworks.schema.info that return HomeKey
  Modifier and Type
  Method
  Description
  `HomeKey`
  SchemaFacetTableRef.`getContainerHome()`
  Returns the container dataspace of this foreign key constraint, if an external container in a dataspace or snapshot is defined (property `branch`), otherwise returns `null`.
  `HomeKey`
  AssociationLink.`getDataSpaceReference()`
  Returns the reference of the dataspace of this association, if an external dataset in another dataspace is defined by the data model (property `dataSpace`); otherwise returns `null`.

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

  Methods in com.orchestranetworks.schema.relationships that return HomeKey
  Modifier and Type
  Method
  Description
  `HomeKey`
  SchemaNodeExplicitRelationship.`getContainerHome()`
  Returns the reference of the dataspace of this link, if an external dataset in another dataspace is defined by the data model, otherwise returns `null`.
  `HomeKey`
  ReverseRelationshipResultInDataspace.`getDataspaceKey()`
  Returns the reference of the dataspace containing the result of a reverse relationship.
  Methods in com.orchestranetworks.schema.relationships with parameters of type HomeKey
  Modifier and Type
  Method
  Description
  `ReverseRelationshipResultInDataspace`
  ReverseRelationshipResultsInterDataset.`getResultInDataspace(HomeKey aDataspaceKey)`
  Returns the result of this reverse relationship in the specified dataspace.

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

  Methods in com.orchestranetworks.schema.types.dataspace with parameters of type HomeKey
  Modifier and Type
  Method
  Description
  `boolean`
  DataspaceSetFilter.`accept(HomeKey aHomeKey, DataspaceSetFilterContext aContext)`
  Returns whether the specified dataspace is included in the filter result.
  `void`
  DataspaceSet.`excludeDataspacesMatching(HomeKey aHomeKey, DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)`
  From the set of dataspaces created thanks to the include methods, excludes the dataspace matching the given key and its descendants according to the provided children policy.
  `void`
  DataspaceSet.`includeDataspacesMatching(HomeKey aHomeKey, DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)`
  Includes the dataspace matching the given key and its descendants according to the provided children policy.

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

  Methods in com.orchestranetworks.ui that return HomeKey
  Modifier and Type
  Method
  Description
  `HomeKey`
  UIHttpManagerComponent.`getHomeKey()`
  `HomeKey`
  UIHttpManagerComponent.`getHomeKeyToCompareWith()`
  Methods in com.orchestranetworks.ui with parameters of type HomeKey
  Modifier and Type
  Method
  Description
  `void`
  UIHttpManagerComponent.`compareSelectionWithEntity(HomeKey homeOnRightKey, AdaptationName instanceOnRight, String tableOrOccurrenceOnRight)`
  Specifies the activation of the `comparison service`.
  `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.`selectHome(HomeKey aDataSpaceOrSnapshotKey)`
  Selects the specified dataspace or snapshot.
  `void`
  UIHttpManagerComponent.`selectInstance(HomeKey aDataSpaceOrSnapshotKey, AdaptationName aDataSetReference)`
  Selects the specified dataset.