public interface AssociationType
An AssociationType is uniquely identified by its value. The value is specified when the AssociationType is created, and it cannot be modified later.
Optionally, an AssociationType can have locale-specific display names. If not specifed, the display name defaults to the value.
Each AssociationType has a forward label, which for example is shown when a corresponding association is displayed by the impact analysis. Optionally, also a backward label can be specified. Different AssociationTypes can share forward and/or backward labels.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBackwardLabel(java.util.Locale locale)
Returns the backward label of this AssociationType in the given locale.
|
java.lang.String |
getForwardLabel(java.util.Locale locale)
Returns the forward label of this AssociationType in the given locale.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the name of this AssociationType in the given locale.
|
java.lang.String |
getValue()
Returns the value of this AssociationType.
|
void |
setBackwardLabel(java.lang.String backwardLabel,
java.util.Locale locale)
Sets the backward label of this AssociationType, in the given locale.
|
void |
setForwardLabel(java.lang.String forwardLabel,
java.util.Locale locale)
Sets the forward label of this AssociationType, in the given locale.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the name of this AssociationType, in the given locale.
|
java.lang.String getValue() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.java.lang.String getName(java.util.Locale locale) throws CSAppFrameworkException
CentraSiteInternationalString
.getLocalStringValue().locale
- the locale for the name to be returned. If null, the default locale will be used.CSAppFrameworkException
- if an internal error occurs.CentraSiteInternationalString
java.lang.String getForwardLabel(java.util.Locale locale) throws CSAppFrameworkException
CentraSiteInternationalString
.getLocalStringValue().locale
- the locale for the forward label to be returned. If null, the default locale will be used.CSAppFrameworkException
- if an internal error occurs.CentraSiteInternationalString
java.lang.String getBackwardLabel(java.util.Locale locale) throws CSAppFrameworkException
CentraSiteInternationalString
.getLocalStringValue().locale
- the locale for the backward label to be returned. If null, the default locale will be used.CSAppFrameworkException
- if an internal error occurs.CentraSiteInternationalString
void setName(java.lang.String name, java.util.Locale locale) throws CSAppFrameworkException
name
- the name of this AssociationTypelocale
- the locale. If null, the locale of the underlying JAXR connection will be used.CSAppFrameworkException
- if an internal error occurs.void setForwardLabel(java.lang.String forwardLabel, java.util.Locale locale) throws CSAppFrameworkException
forwardLabel
- the forward label of this AssociationTypelocale
- the locale. If null, the locale of the underlying JAXR connection will be used.CSAppFrameworkException
- if an internal error occurs.void setBackwardLabel(java.lang.String backwardLabel, java.util.Locale locale) throws CSAppFrameworkException
backwardLabel
- the backward label of this AssociationTypelocale
- the locale. If null, the locale of the underlying JAXR connection will be used.CSAppFrameworkException
- if an internal error occurs.