QGIS/python/server/auto_generated/qgsserverexception.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/server/qgsserverexception.h                                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/








class QgsServerException
{
%Docstring(signature="appended")
Exception base class for server exceptions.
%End

%TypeHeaderCode
#include "qgsserverexception.h"
%End
  public:
    QgsServerException( const QString &message, int responseCode = 500 );
%Docstring
Constructor
%End

    int responseCode() const;
%Docstring

:return: the return HTTP response code associated with this exception
%End

    virtual QByteArray formatResponse( QString &responseFormat /Out/ ) const;
%Docstring
Formats the exception for sending to client


:return: - QByteArray The formatted response.
         - responseFormat: QString to store the content type of the response format.

The default implementation returns text/xml format.
%End

};

class QgsOgcServiceException
{
%Docstring(signature="appended")
Exception base class for service exceptions.

Note that this exception is associated with a default return code 200 which may be
not appropriate in some situations.
%End

%TypeHeaderCode
#include "qgsserverexception.h"
%End
  public:
    QgsOgcServiceException( const QString &code, const QString &message, const QString &locator = QString(), int responseCode = 200, const QString &version = QStringLiteral( "1.3.0" ) );
%Docstring
Construction
%End

    QString message() const;
%Docstring
Returns the exception message
%End

    QString code() const;
%Docstring
Returns the exception code
%End

    QString locator() const;
%Docstring
Returns the locator
%End

    QString version() const;
%Docstring
Returns the exception version
%End

    virtual QByteArray formatResponse( QString &responseFormat /Out/ ) const;


};



/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/server/qgsserverexception.h                                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/