/****************************************************************************
**
** 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 QUMLOPERATION_H
#define QUMLOPERATION_H

#include <QtUml/QtUmlGlobal>

#include <QtUml/QUmlTemplateableElement>
#include <QtUml/QUmlBehavioralFeature>
#include <QtUml/QUmlParameterableElement>

QT_BEGIN_NAMESPACE

QT_MODULE(QtUml)

class QUmlClass;
class QUmlConstraint;
class QUmlDataType;
class QUmlInterface;
class QUmlOperationTemplateParameter;
class QUmlParameter;
class QUmlRedefinableElement;
class QUmlType;

class Q_UML_EXPORT QUmlOperation : public QUmlTemplateableElement, public QUmlBehavioralFeature, public QUmlParameterableElement
{
public:
    explicit QUmlOperation(bool createQModelingObject = true);
    virtual ~QUmlOperation();

    virtual QModelingElement *clone() const;

    // Owned attributes
    QUmlConstraint *bodyCondition() const;
    void setBodyCondition(QUmlConstraint *bodyCondition);
    QUmlClass *class_() const;
    void setClass(QUmlClass *class_);
    QUmlDataType *datatype() const;
    void setDatatype(QUmlDataType *datatype);
    QUmlInterface *interface_() const;
    void setInterface(QUmlInterface *interface_);
    bool isOrdered() const;
    Q_DECL_HIDDEN void setOrdered(bool isOrdered);
    bool isQuery() const;
    void setQuery(bool isQuery);
    bool isUnique() const;
    Q_DECL_HIDDEN void setUnique(bool isUnique);
    int lower() const;
    Q_DECL_HIDDEN void setLower(int lower);
    const QList<QUmlParameter *> ownedParameters() const;
    void addOwnedParameter(QUmlParameter *ownedParameter);
    void removeOwnedParameter(QUmlParameter *ownedParameter);
    const QSet<QUmlConstraint *> postconditions() const;
    void addPostcondition(QUmlConstraint *postcondition);
    void removePostcondition(QUmlConstraint *postcondition);
    const QSet<QUmlConstraint *> preconditions() const;
    void addPrecondition(QUmlConstraint *precondition);
    void removePrecondition(QUmlConstraint *precondition);
    const QSet<QUmlType *> raisedExceptions() const;
    void addRaisedException(QUmlType *raisedException);
    void removeRaisedException(QUmlType *raisedException);
    const QSet<QUmlOperation *> redefinedOperations() const;
    void addRedefinedOperation(QUmlOperation *redefinedOperation);
    void removeRedefinedOperation(QUmlOperation *redefinedOperation);
    QUmlOperationTemplateParameter *templateParameter() const;
    void setTemplateParameter(QUmlOperationTemplateParameter *templateParameter);
    QUmlType *type() const;
    Q_DECL_HIDDEN void setType(QUmlType *type);
    QString upper() const;
    Q_DECL_HIDDEN void setUpper(QString upper);

    // Operations
    bool isConsistentWith(QUmlRedefinableElement *redefinee) const;
    QSet<QUmlParameter *> returnResult() const;

protected:
    QUmlConstraint *_bodyCondition;
    QUmlClass *_class_;
    QUmlDataType *_datatype;
    QUmlInterface *_interface_;
    bool _isQuery;
    QList<QUmlParameter *> _ownedParameters;
    QSet<QUmlConstraint *> _postconditions;
    QSet<QUmlConstraint *> _preconditions;
    QSet<QUmlType *> _raisedExceptions;
    QSet<QUmlOperation *> _redefinedOperations;
    QUmlOperationTemplateParameter *_templateParameter;
};

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOperation) *)

#endif // QUMLOPERATION_H