QxOrm  1.4.5
C++ Object Relational Mapping library

qx::service::IxService : common interface for all services defined with QxService module of QxOrm library More...

#include <IxService.h>

Inheritance diagram for qx::service::IxService:
qx::service::QxService< INPUT, OUTPUT >

List of all members.

Public Member Functions

 IxService ()
 IxService (const QString &sServiceName)
virtual ~IxService ()
QString getServiceName () const
QString getServiceMethodName () const
IxParameter_ptr getInputParameter_BaseClass () const
IxParameter_ptr getOutputParameter_BaseClass () const
qx_bool getMessageReturn () const
std::shared_ptr< QxTransactiongetTransaction () const
void setServiceName (const QString &s)
void setServiceMethodName (const QString &s)
void setInputParameter (IxParameter_ptr p)
void setOutputParameter (IxParameter_ptr p)
void setMessageReturn (const qx_bool &b)
void setMessageReturn (long l, const QString &s)
void setTransaction (const std::shared_ptr< QxTransaction > &p)
bool isValid () const
bool isValidWithOutput () const
virtual void registerClass () const
virtual void onBeforeProcess ()
virtual void onAfterProcess ()

Protected Attributes

QString m_sServiceName
 Service name <=> class name.
QString m_sServiceMethodName
 Service method name to call.
IxParameter_ptr m_pInputParameter
 List of input parameters (request)
IxParameter_ptr m_pOutputParameter
 List of output parameters (reply)
qx_bool m_bMessageReturn
 Message return to indicate if an error occured.
std::shared_ptr< QxTransactionm_pTransaction
 Current transaction after executing service method.

Friends

struct qx::cvt::detail::QxConvert_ToJson< qx::service::IxService >
struct qx::cvt::detail::QxConvert_FromJson< qx::service::IxService >
QX_DLL_EXPORT QDataStream & operator<< (QDataStream &stream, const qx::service::IxService &t)
QX_DLL_EXPORT QDataStream & operator>> (QDataStream &stream, qx::service::IxService &t)
QX_DLL_EXPORT QJsonValue qx::cvt::detail::QxConvert_ToJson_Helper (const qx::service::IxService &t, const QString &format)
QX_DLL_EXPORT qx_bool qx::cvt::detail::QxConvert_FromJson_Helper (const QJsonValue &j, qx::service::IxService &t, const QString &format)

Detailed Description

qx::service::IxService : common interface for all services defined with QxService module of QxOrm library

Click here to access to a tutorial to explain how to work with QxService module.

Definition at line 93 of file IxService.h.


Constructor & Destructor Documentation

qx::service::IxService::IxService ( )
qx::service::IxService::IxService ( const QString &  sServiceName)
virtual qx::service::IxService::~IxService ( ) [virtual]

Member Function Documentation

IxParameter_ptr qx::service::IxService::getInputParameter_BaseClass ( ) const [inline]

Definition at line 123 of file IxService.h.

qx_bool qx::service::IxService::getMessageReturn ( ) const [inline]

Definition at line 125 of file IxService.h.

IxParameter_ptr qx::service::IxService::getOutputParameter_BaseClass ( ) const [inline]

Definition at line 124 of file IxService.h.

QString qx::service::IxService::getServiceMethodName ( ) const [inline]

Definition at line 122 of file IxService.h.

QString qx::service::IxService::getServiceName ( ) const [inline]

Definition at line 121 of file IxService.h.

std::shared_ptr<QxTransaction> qx::service::IxService::getTransaction ( ) const
bool qx::service::IxService::isValid ( ) const [inline]

Definition at line 136 of file IxService.h.

bool qx::service::IxService::isValidWithOutput ( ) const [inline]

Definition at line 137 of file IxService.h.

virtual void qx::service::IxService::onAfterProcess ( ) [inline, virtual]

Definition at line 141 of file IxService.h.

virtual void qx::service::IxService::onBeforeProcess ( ) [inline, virtual]

Definition at line 140 of file IxService.h.

virtual void qx::service::IxService::registerClass ( ) const [inline, virtual]

Reimplemented in qx::service::QxService< INPUT, OUTPUT >.

Definition at line 139 of file IxService.h.

void qx::service::IxService::setInputParameter ( IxParameter_ptr  p) [inline]

Definition at line 130 of file IxService.h.

void qx::service::IxService::setMessageReturn ( const qx_bool b) [inline]

Definition at line 132 of file IxService.h.

void qx::service::IxService::setMessageReturn ( long  l,
const QString &  s 
) [inline]

Definition at line 133 of file IxService.h.

void qx::service::IxService::setOutputParameter ( IxParameter_ptr  p) [inline]

Definition at line 131 of file IxService.h.

void qx::service::IxService::setServiceMethodName ( const QString &  s) [inline]

Definition at line 129 of file IxService.h.

void qx::service::IxService::setServiceName ( const QString &  s) [inline]

Definition at line 128 of file IxService.h.

void qx::service::IxService::setTransaction ( const std::shared_ptr< QxTransaction > &  p)

Friends And Related Function Documentation

QX_DLL_EXPORT QDataStream& operator<< ( QDataStream &  stream,
const qx::service::IxService t 
) [friend]
QX_DLL_EXPORT QDataStream& operator>> ( QDataStream &  stream,
qx::service::IxService t 
) [friend]

Definition at line 101 of file IxService.h.

QX_DLL_EXPORT qx_bool qx::cvt::detail::QxConvert_FromJson_Helper ( const QJsonValue &  j,
qx::service::IxService t,
const QString &  format 
) [friend]

Definition at line 100 of file IxService.h.

QX_DLL_EXPORT QJsonValue qx::cvt::detail::QxConvert_ToJson_Helper ( const qx::service::IxService t,
const QString &  format 
) [friend]

Member Data Documentation

Message return to indicate if an error occured.

Definition at line 112 of file IxService.h.

List of input parameters (request)

Definition at line 110 of file IxService.h.

List of output parameters (reply)

Definition at line 111 of file IxService.h.

Current transaction after executing service method.

Definition at line 113 of file IxService.h.

Service method name to call.

Definition at line 109 of file IxService.h.

Service name <=> class name.

Definition at line 108 of file IxService.h.


The documentation for this class was generated from the following file: