QxOrm 1.4.9
C++ Object Relational Mapping library
Loading...
Searching...
No Matches

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 >

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

◆ IxService() [1/2]

qx::service::IxService::IxService ( )

◆ IxService() [2/2]

qx::service::IxService::IxService ( const QString & sServiceName)

◆ ~IxService()

virtual qx::service::IxService::~IxService ( )
virtual

Member Function Documentation

◆ getInputParameter_BaseClass()

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

Definition at line 123 of file IxService.h.

◆ getMessageReturn()

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

Definition at line 125 of file IxService.h.

◆ getOutputParameter_BaseClass()

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

Definition at line 124 of file IxService.h.

◆ getServiceMethodName()

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

Definition at line 122 of file IxService.h.

◆ getServiceName()

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

Definition at line 121 of file IxService.h.

◆ getTransaction()

std::shared_ptr< QxTransaction > qx::service::IxService::getTransaction ( ) const

◆ isValid()

bool qx::service::IxService::isValid ( ) const
inline

Definition at line 136 of file IxService.h.

◆ isValidWithOutput()

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

Definition at line 137 of file IxService.h.

◆ onAfterProcess()

virtual void qx::service::IxService::onAfterProcess ( )
inlinevirtual

Definition at line 141 of file IxService.h.

◆ onBeforeProcess()

virtual void qx::service::IxService::onBeforeProcess ( )
inlinevirtual

Definition at line 140 of file IxService.h.

◆ registerClass()

virtual void qx::service::IxService::registerClass ( ) const
inlinevirtual

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

Definition at line 139 of file IxService.h.

◆ setInputParameter()

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

Definition at line 130 of file IxService.h.

◆ setMessageReturn() [1/2]

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

Definition at line 132 of file IxService.h.

◆ setMessageReturn() [2/2]

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

Definition at line 133 of file IxService.h.

◆ setOutputParameter()

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

Definition at line 131 of file IxService.h.

◆ setServiceMethodName()

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

Definition at line 129 of file IxService.h.

◆ setServiceName()

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

Definition at line 128 of file IxService.h.

◆ setTransaction()

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

Friends And Related Symbol Documentation

◆ operator<<

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

◆ operator>>

QX_DLL_EXPORT QDataStream & operator>> ( QDataStream & stream,
qx::service::IxService & t )
friend

◆ qx::cvt::detail::QxConvert_FromJson< qx::service::IxService >

Definition at line 97 of file IxService.h.

◆ qx::cvt::detail::QxConvert_FromJson_Helper

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

◆ qx::cvt::detail::QxConvert_ToJson< qx::service::IxService >

Definition at line 97 of file IxService.h.

◆ qx::cvt::detail::QxConvert_ToJson_Helper

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

Member Data Documentation

◆ m_bMessageReturn

qx_bool qx::service::IxService::m_bMessageReturn
protected

Message return to indicate if an error occured.

Definition at line 112 of file IxService.h.

◆ m_pInputParameter

IxParameter_ptr qx::service::IxService::m_pInputParameter
protected

List of input parameters (request)

Definition at line 110 of file IxService.h.

◆ m_pOutputParameter

IxParameter_ptr qx::service::IxService::m_pOutputParameter
protected

List of output parameters (reply)

Definition at line 111 of file IxService.h.

◆ m_pTransaction

std::shared_ptr<QxTransaction> qx::service::IxService::m_pTransaction
protected

Current transaction after executing service method.

Definition at line 113 of file IxService.h.

◆ m_sServiceMethodName

QString qx::service::IxService::m_sServiceMethodName
protected

Service method name to call.

Definition at line 109 of file IxService.h.

◆ m_sServiceName

QString qx::service::IxService::m_sServiceName
protected

Service name <=> class name.

Definition at line 108 of file IxService.h.


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