Interface DataExchangeServiceContext
-
public interface DataExchangeServiceContextProvides the necessary context for integrating {addon.label} services.- Since:
- 2.4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.onwbp.adaptation.AdaptationgetAdaptation()Returns the current dataset or the currently selected record.com.onwbp.adaptation.RequestgetCurrentRequestOnSelectedOccurrences()Returns the request of the currently selected records.com.onwbp.adaptation.RequestgetRequest()Returns the request corresponding to the current table view, including the filters and sort criteria set on the view.com.orchestranetworks.service.SessiongetSession()Returns the current session context.com.orchestranetworks.schema.SchemaNodegetTableNode()Returns the currently selected table node.java.util.List<com.orchestranetworks.schema.SchemaNode>getViewedSchemaNodes()Returns the nodes (or "columns" from a user perspective) currently displayed by the tabular view.booleanisCalledOnHierarchyNode()Returnstrueif the current service is called from the contextual menu of a hierarchy node.booleanisCalledOnHome()Returnstrueif the current service is called from a data space or snapshot menu.booleanisCalledOnInstance()Returnstrueif the current service is called from a data set menu.booleanisCalledOnOccurrencePage()Returnstrueif the current service is called from a record page.booleanisCalledOnTable()Returnstrueif the current service is called on the whole table view.booleanisCalledOnTableSelection()Returnstrueif 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. Returnsnullif this service is called outside the context of a table. If no records are selected, the returned request will have an empty result.
-
getViewedSchemaNodes
java.util.List<com.orchestranetworks.schema.SchemaNode> getViewedSchemaNodes()
Returns the nodes (or "columns" from a user perspective) currently displayed by the tabular view.
-
isCalledOnHierarchyNode
boolean isCalledOnHierarchyNode()
Returnstrueif the current service is called from the contextual menu of a hierarchy node.
-
isCalledOnHome
boolean isCalledOnHome()
Returnstrueif the current service is called from a data space or snapshot menu.
-
isCalledOnInstance
boolean isCalledOnInstance()
Returnstrueif the current service is called from a data set menu.
-
isCalledOnOccurrencePage
boolean isCalledOnOccurrencePage()
Returnstrueif the current service is called from a record page.
-
isCalledOnTable
boolean isCalledOnTable()
Returnstrueif the current service is called on the whole table view.
-
isCalledOnTableSelection
boolean isCalledOnTableSelection()
Returnstrueif the current service is called on the selected records of the view.
-
getSession
com.orchestranetworks.service.Session getSession()
Returns the current session context.
-
-