Interface ConvergenceName
-
public interface ConvergenceNameThe
ConvergenceNameinterface provides an SBB and SBB part with access to the convergence name that the root SBB of an SBB entity tree was created for.- Since:
- Rhino 2.4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddressgetAddress()Get the Address that was used during the construction of the convergence name.StringgetConvergenceName()Get a string representation of the computed convergence name.StringgetCustomName()Get the custom name that was used during the construction of the convergence name.booleanisActivityContextSelected()Determine if the Activity Context was selected for use in the convergence name.booleanisAddressProfileSelected()Determine if the Address Profile was selected for use in the convergence name.booleanisAddressSelected()Determine if the Address was selected for use in the convergence name.booleanisEventSelected()Determine if the event was selected for use in the convergence name.booleanisEventTypeSelected()Determine if the event type was selected for use in the convergence name.
-
-
-
Method Detail
-
isActivityContextSelected
boolean isActivityContextSelected()
Determine if the Activity Context was selected for use in the convergence name.
- Returns:
trueif the Activity Context was selected for use in the convergence name,falseotherwise.- Since:
- Rhino 2.4.0
-
isAddressProfileSelected
boolean isAddressProfileSelected()
Determine if the Address Profile was selected for use in the convergence name.
Note: an Address Profile will only be used in the construction of a convergence name if this method returns
trueandgetAddressreturns a non-null value.- Returns:
trueif the Address Profile was selected for use in the convergence name,falseotherwise.- Since:
- Rhino 2.4.0
-
isAddressSelected
boolean isAddressSelected()
Determine if the Address was selected for use in the convergence name.
Note: Addresses will only be used during the construction of a convergence name if this method returns
trueandgetAddressreturns a non-null value.- Returns:
trueif the Address was selected for use in the convergence name,falseotherwise.- Since:
- Rhino 2.4.0
-
isEventTypeSelected
boolean isEventTypeSelected()
Determine if the event type was selected for use in the convergence name.
- Returns:
trueif the event type was selected for use in the convergence name,falseotherwise.- Since:
- Rhino 2.4.0
-
isEventSelected
boolean isEventSelected()
Determine if the event was selected for use in the convergence name.
- Returns:
trueif the event was selected for use in the convergence name,falseotherwise.- Since:
- Rhino 2.4.0
-
getAddress
Address getAddress()
Get the Address that was used during the construction of the convergence name.
- Returns:
- the Address, or
nullif no address was set. - Since:
- Rhino 2.4.0
-
getCustomName
String getCustomName()
Get the custom name that was used during the construction of the convergence name.
- Returns:
- the custom name, or
nullif no custom name was set. - Since:
- Rhino 2.4.0
-
getConvergenceName
String getConvergenceName()
Get a string representation of the computed convergence name.
This format of this string is vendor-specific. A string value returned from this method will only be equal to a string value returned from the same method in some other
ConvergenceNameobject if the twoConvergenceNameobjects represent exactly the same convergence name.- Returns:
- a string representation of the computed convergence name.
- Since:
- Rhino 2.4.0
-
-