Attica::Metadata

Attica::Metadata Class Reference

#include <metadata.h>

Public Types

enum  Error { NoError = 0, NetworkError, OcsError }
 

Public Member Functions

 Metadata (const Metadata &other)
 
Error error () const
 
int itemsPerPage ()
 
QString message ()
 
Metadataoperator= (const Metadata &other)
 
QString resultingId ()
 
void setError (Error error)
 
void setItemsPerPage (int itemsPerPage)
 
void setMessage (const QString &message)
 
void setResultingId (const QString &id)
 
void setStatusCode (int code)
 
void setStatusString (const QString &status)
 
void setTotalItems (int items)
 
int statusCode () const
 
QString statusString () const
 
int totalItems ()
 

Detailed Description

Status messages from the server.

Definition at line 25 of file metadata.h.

Member Function Documentation

Metadata::Error Metadata::error ( ) const

Check if the job was successful.

Returns
the error state enum returns the type of error (network or ocs)

Definition at line 66 of file metadata.cpp.

int Metadata::itemsPerPage ( )

The number of items per page the server was asked for.

Definition at line 126 of file metadata.cpp.

QString Metadata::message ( )

An optional additional message from the server.

Definition at line 76 of file metadata.cpp.

QString Metadata::resultingId ( )

The resulting ID when a PostJob created a new item.

Definition at line 86 of file metadata.cpp.

int Metadata::statusCode ( ) const

The status as integer.

If the error is an OCS error, refer to http://www.freedesktop.org/wiki/Specifications/open-collaboration-services in any other case it is the network return code.

Definition at line 96 of file metadata.cpp.

QString Metadata::statusString ( ) const

The status of the job, for example "Ok".

Definition at line 106 of file metadata.cpp.

int Metadata::totalItems ( )

The number of items returned by this job (only relevant for list jobs)

Definition at line 116 of file metadata.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jul 6 2020 23:00:35 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.