Package com.orchestranetworks.schema.relationships

# Interface ReverseRelationshipResultInDataspace

public interface ReverseRelationshipResultInDataspace
Represents the result of a reverse relationship in a specific dataspace.

Since:
  5.7.1
See Also:
  - `ReverseRelationshipIntraDataset.getReferringRecords(Adaptation)`
  - `ReverseRelationshipResultsInterDataset`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `HomeKey`
  `getDataspaceKey()`
  Returns the reference of the dataspace containing the result of a reverse relationship.
  `Iterable<ReverseRelationshipResult>`
  `getResultByDatasets()`
  Returns the result of this reverse relationship in the current dataspace.
  `ReverseRelationshipResult`
  `getResultInDataset(AdaptationName aDatasetName)`
  Returns the result of this reverse relationship in the specified dataset.

- ## Method Details

  - ### getDataspaceKey

    HomeKey getDataspaceKey()
    Returns the reference of the dataspace containing the result of a reverse relationship.

  - ### getResultByDatasets

    Iterable<ReverseRelationshipResult> getResultByDatasets()
    Returns the result of this reverse relationship in the current dataspace.

    Permissions are applied if the corresponding reverse relationship has been retrieved using a specific `Session`. As a consequence, this method returns only the results in the datasets that can be viewed by the end-user associated with the specified session.

    See Also:
      - `ReverseRelationshipResult`

  - ### getResultInDataset

    ReverseRelationshipResult getResultInDataset(AdaptationName aDatasetName)
    Returns the result of this reverse relationship in the specified dataset. Returns `null` if there is no result in the specified dataset.
    Throws:
      `IllegalArgumentException` - if the specified dataset is `null`.
    See Also:
      - `ReverseRelationshipResult`