DataExchangeServiceContext (EBX® Add-ons Version 5.3.0 Java API)

```
public interface DataExchangeServiceContext
```
Provides the necessary context for integrating {addon.label} services.

Since:

2.4.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.onwbp.adaptation.Adaptation`	`getAdaptation()` Returns the current dataset or the currently selected record.
`com.onwbp.adaptation.Request`	`getCurrentRequestOnSelectedOccurrences()` Returns the request of the currently selected records.
`com.onwbp.adaptation.Request`	`getRequest()` Returns the request corresponding to the current table view, including the filters and sort criteria set on the view.
`com.orchestranetworks.service.Session`	`getSession()` Returns the current session context.
`com.orchestranetworks.schema.SchemaNode`	`getTableNode()` Returns the currently selected table node.
`List<com.orchestranetworks.schema.SchemaNode>`	`getViewedSchemaNodes()` Returns the nodes (or "columns" from a user perspective) currently displayed by the tabular view.
`boolean`	`isCalledOnHierarchyNode()` Returns `true` if the current service is called from the contextual menu of a hierarchy node.
`boolean`	`isCalledOnHome()` Returns `true` if the current service is called from a data space or snapshot menu.
`boolean`	`isCalledOnInstance()` Returns `true` if the current service is called from a data set menu.
`boolean`	`isCalledOnOccurrencePage()` Returns `true` if the current service is called from a record page.
`boolean`	`isCalledOnTable()` Returns `true` if the current service is called on the whole table view.
`boolean`	`isCalledOnTableSelection()` Returns `true` if the current service is called on the selected records of the view.

- Method Detail
  - getAdaptation
```
com.onwbp.adaptation.Adaptation getAdaptation()
```
    Returns the current dataset or the currently selected record.
  - getTableNode
```
com.orchestranetworks.schema.SchemaNode getTableNode()
```
    Returns the currently selected table node.
  - getRequest
```
com.onwbp.adaptation.Request getRequest()
```
    Returns the request corresponding to the current table view, including the filters and sort criteria set on the view.
  - getCurrentRequestOnSelectedOccurrences
```
com.onwbp.adaptation.Request getCurrentRequestOnSelectedOccurrences()
```
    Returns the request of the currently selected records. Returns null if this service is called outside the context of a table. If no records are selected, the returned request will have an empty result.
  - getViewedSchemaNodes
```
List<com.orchestranetworks.schema.SchemaNode> getViewedSchemaNodes()
```
    Returns the nodes (or "columns" from a user perspective) currently displayed by the tabular view.
  - isCalledOnHierarchyNode
```
boolean isCalledOnHierarchyNode()
```
    Returns true if the current service is called from the contextual menu of a hierarchy node.
  - isCalledOnHome
```
boolean isCalledOnHome()
```
    Returns true if the current service is called from a data space or snapshot menu.
  - isCalledOnInstance
```
boolean isCalledOnInstance()
```
    Returns true if the current service is called from a data set menu.
  - isCalledOnOccurrencePage
```
boolean isCalledOnOccurrencePage()
```
    Returns true if the current service is called from a record page.
  - isCalledOnTable
```
boolean isCalledOnTable()
```
    Returns true if the current service is called on the whole table view.
  - isCalledOnTableSelection
```
boolean isCalledOnTableSelection()
```
    Returns true if the current service is called on the selected records of the view.
  - getSession
```
com.orchestranetworks.service.Session getSession()
```
    Returns the current session context.

EBX® Add-ons Version 5.3.0.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Interface DataExchangeServiceContext

Method Summary

Method Detail

getAdaptation

getTableNode

getRequest

getCurrentRequestOnSelectedOccurrences

getViewedSchemaNodes

isCalledOnHierarchyNode

isCalledOnHome

isCalledOnInstance

isCalledOnOccurrencePage

isCalledOnTable

isCalledOnTableSelection

getSession