/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   copyright (C) 2003-2006                                               *
 *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
 ***************************************************************************/

#ifndef UMLROLE_H
#define UMLROLE_H

#include "umlobject.h"

class UMLAssociation;

/**
 * This class contains the non-graphic representation of an association role.
 *
 * @author Brian Thomas <brian.thomas@gsfc.nasa.gov>
 * @see UMLObject
 */

class UMLRole : public UMLObject {
    Q_OBJECT
public:
    /**
     * Sets up an association.
     *
     * @param parent    The parent (association) of this UMLRole.
     * @param parentUMLObject The Parent UML Object of this UMLRole
     * @param role  The Uml::Role_Type of this UMLRole
     */
    UMLRole (UMLAssociation * parent, UMLObject * parentUMLObject, Uml::Role_Type role);

    /**
     * Overloaded '==' operator
     */
    bool operator==(const UMLRole & rhs);

    /**
     * Standard deconstructor.
     */
    virtual ~UMLRole();

    /**
     * Returns the UMLObject assigned to the role.
     * @return  Pointer to the UMLObject in role.
     */
    UMLObject* getObject();

    /**
     * Returns the Changeablity of the role.
     *
     * @return  Changeability_Type of role.
     */
    Uml::Changeability_Type getChangeability() const;

    /**
     * Returns the multiplicity assigned to the role.
     *
     * @return  The multiplicity assigned to the role.
     */
    QString getMultiplicity() const;

    /**
     * Sets the UMLObject playing the role in the association.
     *
     * @param obj               Pointer to the UMLObject of role.
     */
    void setObject(UMLObject *obj);

    /**
     * Sets the changeability of the role.
     *
     * @param value     Changeability_Type of role changeability.
     */
    void setChangeability (Uml::Changeability_Type value);

    /**
     * Sets the multiplicity of the role.
     *
     * @param multi             The multiplicity of role.
     */
    void setMultiplicity ( const QString &multi );

    UMLAssociation * getParentAssociation ();

    /** get the 'id' of the role (NOT the parent object). This could be
     * either Uml::A or Uml::B. Yes, it would be better if we
     * could get along without this, but we need it to distinguish saved
     * umlrole objects in the XMI for 'self' associations where both roles
     * will point to the same underlying UMLObject.
     */
    Uml::Role_Type getRole();

    /**
     * Make a clone of this object.
     * Not yet implemented.
     */
    UMLObject* clone() const { return NULL; }

    /**
     * Creates the <UML:AssociationEnd> XMI element.
     */
    void saveToXMI(QDomDocument& qDoc, QDomElement& qElement);

protected:
    /**
     * Loads the <UML:AssociationEnd> XMI element.
     * Auxiliary to UMLObject::loadFromXMI.
     */
    bool load(QDomElement& element);

private:

    /** do some initialization at construction time */
    void init (UMLAssociation * parent, UMLObject * parentObj, Uml::Role_Type r);

    UMLAssociation * m_pAssoc;
    Uml::Role_Type m_role;
    QString m_Multi;
    Uml::Changeability_Type m_Changeability;
};

#endif
