Interface ConvergenceName
-
public interface ConvergenceName
The
ConvergenceName
interface 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 Address
getAddress()
Get the Address that was used during the construction of the convergence name.String
getConvergenceName()
Get a string representation of the computed convergence name.String
getCustomName()
Get the custom name that was used during the construction of the convergence name.boolean
isActivityContextSelected()
Determine if the Activity Context was selected for use in the convergence name.boolean
isAddressProfileSelected()
Determine if the Address Profile was selected for use in the convergence name.boolean
isAddressSelected()
Determine if the Address was selected for use in the convergence name.boolean
isEventSelected()
Determine if the event was selected for use in the convergence name.boolean
isEventTypeSelected()
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:
true
if the Activity Context was selected for use in the convergence name,false
otherwise.- 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
true
andgetAddress
returns a non-null value.- Returns:
true
if the Address Profile was selected for use in the convergence name,false
otherwise.- 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
true
andgetAddress
returns a non-null value.- Returns:
true
if the Address was selected for use in the convergence name,false
otherwise.- Since:
- Rhino 2.4.0
-
isEventTypeSelected
boolean isEventTypeSelected()
Determine if the event type was selected for use in the convergence name.
- Returns:
true
if the event type was selected for use in the convergence name,false
otherwise.- Since:
- Rhino 2.4.0
-
isEventSelected
boolean isEventSelected()
Determine if the event was selected for use in the convergence name.
- Returns:
true
if the event was selected for use in the convergence name,false
otherwise.- 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
null
if 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
null
if 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
ConvergenceName
object if the twoConvergenceName
objects represent exactly the same convergence name.- Returns:
- a string representation of the computed convergence name.
- Since:
- Rhino 2.4.0
-
-