Skip to content
Reference > Classes

Relationship

Definition

Relationship var = .... ;

Extends

Extended By

None

Description

A relationship between two panels (the green arrows between panels) used to dictate user work flows.

Method Summary

Owner Name Return Type Description
Relationship execute() Panel Forcefully runs this relationship.
Relationship executeOnAllRows() Panel Forcefully runs this relationship on all rows from source table, regardless of selection.
DashboardResource getCallback(callbackName) Callback Returns a callback by name
DashboardResource getCallbacks() Map Returns a map of all callback definitions.
DashboardResource getChildren() List Returns a list of the child dashboard resources.
Object getClassName() String Returns the string name of this object's class type.
Relationship getClauses() Map Returns a map of the clauses for this relationship.
DashboardResource getDRI() String Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
DashboardResource getDashboardResourceType() String Returns the Dashboard Resource Type as a string
DashboardResource getFormula(formulaName) Formula Returns a Formula given the formula name.
DashboardResource getFormulaNames() Set Returns a set of the names of all formulas for this object.
DashboardResource getFormulas() Map Returns a map of all available formulas for this object. The key is the formula name.
Relationship getId() String Returns the user-assigned ID for this relationship.
DashboardResource getLRI() String Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
Relationship getLayout() Layout Returns the layout that owns this relationship.
DashboardResource getOwner() DashboardResource Returns the DashboardResource that owns this object.
Relationship getSource() Panel Returns the source panel.
Relationship getTarget() Panel Returns the target panel.
DashboardResource invokeCallback(callbackName, args) Object Executes the specified callback definition and returns the result from the callback.
DashboardResource isTransient() Boolean Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
Object toJson() String Returns a json representation of this object.

Method Definitions


execute()

Panel Relationship::execute()

Description

Forcefully runs this relationship.


executeOnAllRows()

Panel Relationship::executeOnAllRows()

Description

Forcefully runs this relationship on all rows from source table, regardless of selection.


getClauses()

Map Relationship::getClauses()

Description

Returns a map of the clauses for this relationship.


getId()

String Relationship::getId()

Description

Returns the user-assigned ID for this relationship.


getLayout()

Layout Relationship::getLayout()

Description

Returns the layout that owns this relationship.


getSource()

Panel Relationship::getSource()

Description

Returns the source panel.


getTarget()

Panel Relationship::getTarget()

Description

Returns the target panel.