SOAPMethod.h

Go to the documentation of this file.

// SOAPMethod.h: interface for the SOAPMethod class.
//

/*
#if !defined(SOAPMETHOD_H)
    #include "SOAPMethod.h"
#endif // SOAPMETHOD_H
*/

#if !defined(SOAPMETHOD_H)
#define SOAPMETHOD_H

#ifndef _STRING_
    #include <string>
#endif // _STRING_
#if !defined(SOAPELEMENT_H)
    #include "SOAPElement.h"
#endif // !defined(SOAPELEMENT_H)
#if !defined(SOAPFAULT_H)
    #include "SOAPFault.h"
#endif // !defined(SOAPFAULT_H)

// Forward declaration.
class SOAPEncoder;

class SOAPMethod  
{
public:
    // Constructor/ Destructor
    SOAPMethod();
    virtual ~SOAPMethod();
    
    
    // methodName
    // Description:
    // Arugments:
    //  N/A
    virtual std::string methodName() = 0;

        // extractMethod
        // Description:
        virtual bool extractMethod( SOAPElement& theCall, SOAPElement& theMethod );
    
        // methodNameAttributes
        // Description:
    virtual std::string methodNameAttributes();

    // encode
    // Description:
    // Arugments:
    virtual bool encode( SOAPEncoder& soapEncoder ) = 0;
    
    // execute
    // Description:
    virtual bool execute( SOAPElement& theCall );
    
    // getFault
    // Description:
    // Arugments:
    //  N/A
    virtual SOAPFault* getFault();
    
    // setFailed
    // Description:
    // Arugments:
    //  N/A
    // Return Value:
    //  N/A
    void setFailed();
    
    // succeeded
    // Description:
    //  N/A
    // Return Value:
    //  true: Call to execute worked.
    //  false: Call to execute failed.
    bool succeeded();

        // isGenric
        virtual bool isGeneric() { return false; };
    
        // mustIUnderstand
        virtual bool mustIUnderstand(SOAPElement& theCall);

protected:

    // m_bSucceeded
    // Description: Stores the success value.
    bool m_bSucceeded;
    
    // m_pFault
    // Description: 
    std::auto_ptr<SOAPFault> m_pFault;

        // unkownMethodFault
        void unkownMethodFault( SOAPElement aMethod );

        // wrongNumberArgumentsFault
        void wrongNumberArgumentsFault( SOAPElement aMethod, const char *num );

        // ImustUnderstand
        bool ImustUnderstand( SOAPElement aElement );
};

#endif // !defined(SOAPMETHOD_H)

---