com.softwareag.centrasite.appl.framework.types
Interface AssociationType

All Known Implementing Classes:
AssociationTypeImpl

public interface AssociationType

Represents a Centrasite 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.


Method Summary
 java.lang.String getBackwardLabel(java.util.Locale locale)
          Return the backward label of this AssociationType in the given locale.
 java.lang.String getForwardLabel(java.util.Locale locale)
          Return the forward label of this AssociationType in the given locale.
 java.lang.String getName(java.util.Locale locale)
          Return the name of this AssociationType in the given locale.
 java.lang.String getValue()
          Return the value of this AssociationType.
 void setBackwardLabel(java.lang.String backwardLabel, java.util.Locale locale)
          Set the backward label of this AssociationType, in the given locale.
 void setForwardLabel(java.lang.String forwardLabel, java.util.Locale locale)
          Set the forward label of this AssociationType, in the given locale.
 void setName(java.lang.String name, java.util.Locale locale)
          Set the name of this AssociationType, in the given locale.
 

Method Detail

getValue

java.lang.String getValue()
                          throws CSAppFrameworkException
Return the value of this AssociationType.

Returns:
the value of this AssociationType.
Throws:
CSAppFrameworkException

getName

java.lang.String getName(java.util.Locale locale)
                         throws CSAppFrameworkException
Return the name of this AssociationType in the given locale. The evaluation of the locale follows the behaviour of CentraSiteInternationalString.getLocalStringValue().

Parameters:
locale - the locale for the name to be returned. If null, the default locale will be used.
Returns:
the name of this AssociationType
Throws:
CSAppFrameworkException
See Also:
CentraSiteInternationalString

getForwardLabel

java.lang.String getForwardLabel(java.util.Locale locale)
                                 throws CSAppFrameworkException
Return the forward label of this AssociationType in the given locale. The evaluation of the locale follows the behaviour of CentraSiteInternationalString.getLocalStringValue().

Parameters:
locale - the locale for the forward label to be returned. If null, the default locale will be used.
Returns:
the forward label of this AssociationType
Throws:
CSAppFrameworkException
See Also:
CentraSiteInternationalString

getBackwardLabel

java.lang.String getBackwardLabel(java.util.Locale locale)
                                  throws CSAppFrameworkException
Return the backward label of this AssociationType in the given locale. The evaluation of the locale follows the behaviour of CentraSiteInternationalString.getLocalStringValue().

Parameters:
locale - the locale for the backward label to be returned. If null, the default locale will be used.
Returns:
the forward label of this AssociationType
Throws:
CSAppFrameworkException
See Also:
CentraSiteInternationalString

setName

void setName(java.lang.String name,
             java.util.Locale locale)
             throws CSAppFrameworkException
Set the name of this AssociationType, in the given locale.

Parameters:
name - the name of this AssociationType
locale - the locale. If null, the locale of the underlying JAXR connection will be used.
Throws:
CSAppFrameworkException

setForwardLabel

void setForwardLabel(java.lang.String forwardLabel,
                     java.util.Locale locale)
                     throws CSAppFrameworkException
Set the forward label of this AssociationType, in the given locale.

Parameters:
forwardLabel - the forward label of this AssociationType
locale - the locale. If null, the locale of the underlying JAXR connection will be used.
Throws:
CSAppFrameworkException

setBackwardLabel

void setBackwardLabel(java.lang.String backwardLabel,
                      java.util.Locale locale)
                      throws CSAppFrameworkException
Set the backward label of this AssociationType, in the given locale.

Parameters:
backwardLabel - the backward label of this AssociationType
locale - the locale. If null, the locale of the underlying JAXR connection will be used.
Throws:
CSAppFrameworkException