/*----------------------------------------------------------------------------
Copyright © 1998 Object International Software GmbH
----------------------------------------------------------------------------*/
package oisoft.togetherx.scriptapi.UML;

//------------------------------------------------------------------------------
/**
 * Presents association end (class role).
 *
 * An association can have roles connected to each
 * of the classes involved in the association. 
 * The role name indicates the role played by the class 
 * in terms of association.
 * <i>getName()</i> for <i>UMLAssociationEnd</i> returns 
 * the role name for the connected class in this association.
 *
 * @see UMLAssociation
 * @version  2.1.05  15.07.1998
 * @author   Andrei Ivanov
 */
public interface UMLAssociationEnd extends UMLElement
{
  /** Returns cardinality of the role
   *
   * Cardinality specifies how many instances of one
   * class may be associated with a single instance
   * of another class.
   * @return
   * The possible values returned by this method
   * are (<any> - any number):<br>
   *
   * 0..0  Zero <br>
   * 0..1  Zero or one <br>
   * 0..n  Zero or more <br>
   * 1..1  One <br>
   * 1..n  One or more <br>
   * n      Unlimited number <br>
   * <any>   Exact number, Example:  21  <br>
   * <any>..n  Exact number or more, Example:  21..n indicating 21 or more <br>
   * <any>..<any>  Specified range, Example:  21..45 <br>
   * <any>..<any>, <any> Specified range or exact number
   *  (Example:  21..45, 50, indicating 21 through 45 and 50) <br>
   * <literal>..<literal>, <literal>..<literal>
   *  Multiple specified ranges (Example:  21..45, 50..60) <br>
   */
  String        getCardinality();

  /** Returns qualifier of the association.
   *
   * Association can be qualified. Qualified assocation
   * are used with one-to-many or many-to-many
   * associations. The qualifier distinguishes among
   * the set of objects at the "many" end of association.
   * The qualifier specifies how a specific object at the
   * "many" end of association is identified. 
   * It can be considred as a kind of key to recognizing all the
   * objects in the association.
   */
  String        getQualifier();

  /**
   * Indicates whether the role is navigable.
   *
   * It is possible to use navigable association.
   * They are shown in the diagram with an arrow.
   * @return true, if this role is navigate.
   */
  boolean       isNavigable();

  /**
   * Indicates whether objects on this role side are ordered.
   * The links between objects may have
   * an implicit order.
   * @return true, if oredered.
   * @see UMLAssociationEnd#getQualifier
   */
  boolean       isOrdered();
}
//------------------------------------------------------------------------------