/****************************************************************************
**
** Copyright (C) 2013 Sandro S. Andrade <sandroandrade@kde.org>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtUml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QUMLCLAUSEOBJECT_H
#define QUMLCLAUSEOBJECT_H

#include <QtUml/QtUmlGlobal>

#include <QtModeling/QModelingObject>

QT_BEGIN_NAMESPACE

QT_MODULE(QtUml)

class QUmlClause;
class QModelingObjectPrivate;
class Q_UML_EXPORT QUmlClauseObject : public QModelingObject
{
    Q_OBJECT
    Q_DISABLE_COPY(QUmlClauseObject)
    Q_DECLARE_PRIVATE(QModelingObject)

    // Properties [Element]
    Q_PROPERTY(QSet<QObject *> ownedComments READ ownedComments NOTIFY ownedCommentsChanged)
    Q_PROPERTY(QSet<QObject *> ownedElements READ ownedElements NOTIFY ownedElementsChanged)
    Q_PROPERTY(QObject * owner READ owner NOTIFY ownerChanged)

    // Properties [Clause]
    Q_PROPERTY(QSet<QObject *> bodies READ bodies NOTIFY bodiesChanged)
    Q_PROPERTY(QList<QObject *> bodyOutputs READ bodyOutputs NOTIFY bodyOutputsChanged)
    Q_PROPERTY(QObject * decider READ decider WRITE setDecider NOTIFY deciderChanged)
    Q_PROPERTY(QSet<QObject *> predecessorClauses READ predecessorClauses NOTIFY predecessorClausesChanged)
    Q_PROPERTY(QSet<QObject *> successorClauses READ successorClauses NOTIFY successorClausesChanged)
    Q_PROPERTY(QSet<QObject *> tests READ tests NOTIFY testsChanged)

public:
    Q_INVOKABLE explicit QUmlClauseObject(QUmlClause *modelingElement);

    // Owned attributes [Element]
    Q_INVOKABLE const QSet<QObject *> ownedComments() const;
    Q_INVOKABLE const QSet<QObject *> ownedElements() const;
    Q_INVOKABLE QObject *owner() const;

    // Owned attributes [Clause]
    Q_INVOKABLE const QSet<QObject *> bodies() const;
    Q_INVOKABLE const QList<QObject *> bodyOutputs() const;
    Q_INVOKABLE QObject *decider() const;
    Q_INVOKABLE const QSet<QObject *> predecessorClauses() const;
    Q_INVOKABLE const QSet<QObject *> successorClauses() const;
    Q_INVOKABLE const QSet<QObject *> tests() const;

    // Operations [Element]
    Q_INVOKABLE QSet<QObject *> allOwnedElements() const;
    Q_INVOKABLE bool mustBeOwned() const;

public Q_SLOTS:

    // Slots for owned attributes [Element]
    void addOwnedComment(QObject *ownedComment);
    void removeOwnedComment(QObject *ownedComment);
    void Q_DECL_HIDDEN addOwnedElement(QObject *ownedElement);
    void Q_DECL_HIDDEN removeOwnedElement(QObject *ownedElement);
    void Q_DECL_HIDDEN setOwner(QObject *owner = 0);

    // Slots for owned attributes [Clause]
    void addBody(QObject *body);
    void removeBody(QObject *body);
    void addBodyOutput(QObject *bodyOutput);
    void removeBodyOutput(QObject *bodyOutput);
    void setDecider(QObject *decider = 0);
    void addPredecessorClause(QObject *predecessorClause);
    void removePredecessorClause(QObject *predecessorClause);
    void addSuccessorClause(QObject *successorClause);
    void removeSuccessorClause(QObject *successorClause);
    void addTest(QObject *test);
    void removeTest(QObject *test);

Q_SIGNALS:

    // Signals for owned attributes [Element]
    void ownedCommentsChanged(QSet<QObject *> ownedComments);
    void ownedElementsChanged(QSet<QObject *> ownedElements);
    void ownerChanged(QObject *owner);

    // Signals for owned attributes [Clause]
    void bodiesChanged(QSet<QObject *> bodies);
    void bodyOutputsChanged(QList<QObject *> bodyOutputs);
    void deciderChanged(QObject *decider);
    void predecessorClausesChanged(QSet<QObject *> predecessorClauses);
    void successorClausesChanged(QSet<QObject *> successorClauses);
    void testsChanged(QSet<QObject *> tests);

protected:
    virtual void setGroupProperties();
    virtual void setPropertyData();
};

QT_END_NAMESPACE

#endif // QUMLCLAUSEOBJECT_H