Dokumentace třídy Httpd::ControllerStatuses

Manipulace se stavy ticketů ...

#include <controllerstatuses.h>

Diagram dědičnosti pro třídu Httpd::ControllerStatuses:

Veřejné metody
	ControllerStatuses (HobrasoftHttpd::HttpConnection *parent)
Veřejné metody dědí se z Httpd::AbstractController
	AbstractController (HobrasoftHttpd::HttpConnection *parent)
	Konstruktor.
virtual void	service (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Obsluha požadavku.
void	setCheckId (bool x)
	Nastavuje kontrolu položky ID v datech při PUT a POST.
void	setAuthorizer (RequestAuthorizer *authorizer)
AuthenticatedUser *	authenticatedUser () const
bool	checkId () const
	Vrací stav kontroly položky ID v datech při PUT a POST.
Db::Database *	db ()

Chráněné metody
void	serviceList (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response) Q_DECL_OVERRIDE
	Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.
void	serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou GET.
void	serviceIdPut (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
void	serviceIdPost (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
void	serviceIdDelete (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.
Chráněné metody dědí se z Httpd::AbstractController
virtual bool	exists (const QString &id)
	Kontrola existence zadaného ID.
virtual bool	exists (HobrasoftHttpd::HttpRequest *request, const QString &id)
	Kontrola existence zadaného ID.
virtual void	serviceOK (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data=QVariant())
	Pošle odpověď 200 OK.
virtual void	serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString &error, const QVariantMap &data)
	Pošle chybovou odpověď
virtual void	serviceEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Pošle v odpovědi kompletní seznam všech objektů ve třídě a následně
virtual void	serviceIdEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle v odpovědi proud událostí spojených se všemi objekty ve třídě
virtual void	serviceEvent (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data)
	Pošle do otevřeného proudu událostí jednu událost.
virtual bool	isAuthorized (Security::Permissions::Permission)
HobrasoftHttpd::HttpRequest *	request () const
	Vrací ukazatel na aktuální request.
HobrasoftHttpd::HttpConnection *	connection () const
	Vrací ukazatel na aktuální connection.

Další zděděné členy
Statické chráněné metody dědí se z Httpd::AbstractController
static QVariantMap	putKey (const QVariant &key)

Detailní popis

Manipulace se stavy ticketů

Primární klíč (položka status) negeneruje databáze, identifikátor musí být nastavený. Jako identifikátor může být použitý libovolný řetězec, vhodné je například NEW, CLOSED atd.

Implementuje metody:

• get
• post, put
• delete

Struktura jednoho záznamu

{
"abbreviation": "NEW",      // Zkratka
"color": "transparent",     // Barva, kterou se má zobrazovat v GUI
"description": "Nový",      // Popis stavu
"status": "NEW"             // Primární klíč, identifikátor stavu
}

Definice je uvedena na řádku 50 v souboru controllerstatuses.h.

Dokumentace konstruktoru a destruktoru

ControllerStatuses()

ControllerStatuses::ControllerStatuses

(

HobrasoftHttpd::HttpConnection *

parent

)

Definice je uvedena na řádku 14 v souboru controllerstatuses.cpp.

                                                                           : AbstractController(parent) {
}

Dokumentace členských funkcí

serviceIdDelete()

void ControllerStatuses::serviceIdDelete ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 62 v souboru controllerstatuses.cpp.

                                                                                                                                    {
    db()->remove(Dbt::Statuses(id));
    serviceOK(request, response);
}

serviceIdGet()

void ControllerStatuses::serviceIdGet ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou GET.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 43 v souboru controllerstatuses.cpp.

                                                                                                                                 {
    auto list = db()->statuses(id);
    if (list.isEmpty()) {
        serviceError(request, response, 404, "not-found", "NotFound");
        return;
        }
    serviceOK(request, response, list[0].toMap());
}

serviceIdPost()

void ControllerStatuses::serviceIdPost ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 57 v souboru controllerstatuses.cpp.

                                                                                                                                        {
    serviceIdPut(request, response, data);
}

serviceIdPut()

void ControllerStatuses::serviceIdPut ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 52 v souboru controllerstatuses.cpp.

                                                                                                                                       {
    serviceOK(request, response, putKey(db()->save(Dbt::Statuses::fromMap(data))));
}

serviceList()

void ControllerStatuses::serviceList ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response )

protectedvirtual

Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 18 v souboru controllerstatuses.cpp.

                                                                                                              {
    QString category = request->parameter("category");
    QString status   = request->parameter("previousStatus");
    QString statuses = request->parameter("previousStatuses"); 
    if (status == "" && statuses == "") {
        serviceOK(request, response, toList(db()->statuses(category, status)));
        return;
        }
    if (status != "" && statuses == "") {
        serviceOK(request, response, toList(db()->statuses(category, status)));
        return;
        }
    if (status == "" && statuses != "") {
        QStringList statusesList;
        QVariantList list1 = JSON::data(statuses.toUtf8()).toList();
        for (int i=0; i<list1.size(); i++) {
            statusesList << list1[i].toString();
            }
        serviceOK(request, response, toList(db()->statuses(category, statusesList)));
        return;
        }
    serviceError(request, response, 400, "bad-parameterers", "Bad parameters: previousStatus=<int> or previousStatuses=<JSON array> must be sent");
}

---

Dokumentace pro tuto třídu byla vygenerována z následujících souborů:

• httpd/controllerstatuses.h
• httpd/controllerstatuses.cpp