epoc32/include/mw/sensoapfault.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:        This utility class represents SOAP fault element according to
williamr@2
    15
*                SOAP fault specification. 
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
williamr@2
    26
#ifndef SEN_SOAP_FAULT_H
williamr@2
    27
#define SEN_SOAP_FAULT_H
williamr@2
    28
williamr@2
    29
//  INCLUDES
williamr@2
    30
#include <SenBaseElement.h>
williamr@2
    31
#include <SenSoapConstants.h>
williamr@2
    32
williamr@2
    33
williamr@2
    34
// CLASS DECLARATION
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
* This utility class represents SOAP fault element according to SOAP fault 
williamr@2
    38
* specification. 
williamr@2
    39
* SOAP fault element has following child elements: 
williamr@2
    40
*  faultcode, 
williamr@2
    41
*  faultstring, 
williamr@2
    42
*  faultactor 
williamr@2
    43
*  detail
williamr@2
    44
*
williamr@2
    45
*  @lib SenUtils.lib
williamr@2
    46
*  @since Series60 3.0
williamr@2
    47
*/
williamr@2
    48
class CSenSoapFault : public CSenBaseElement
williamr@2
    49
    {
williamr@2
    50
    public:  // Constructors and destructor
williamr@2
    51
        
williamr@2
    52
        /**
williamr@2
    53
        * Copy constructor, making a copy of the original source element.
williamr@2
    54
        * @since Series60 3.0
williamr@2
    55
        * @param aCopiedSource  Element where source will be copied.
williamr@2
    56
        */
williamr@2
    57
        IMPORT_C static CSenSoapFault* NewL(CSenElement& aCopiedSource);
williamr@2
    58
williamr@2
    59
        /**
williamr@2
    60
        * Basic constructor.
williamr@2
    61
        * @since Series60 3.0
williamr@2
    62
        * @param aNsUri is the XML namespace of this SOAP fault
williamr@2
    63
        * @param aLocalName is the localname for this SOAP fault
williamr@2
    64
        * @param aQName is the qualifiedname for this SOAP fault
williamr@2
    65
        * @param aAttributes are the XML attributes for this SOAP fault
williamr@2
    66
        * Parameters are used to construct the soap fault.
williamr@2
    67
        */
williamr@2
    68
        IMPORT_C static CSenSoapFault* NewL(const TDesC8& aNsUri,
williamr@2
    69
                                            const TDesC8& aLocalName,
williamr@2
    70
                                            const TDesC8& aQName,
williamr@2
    71
                                            const RAttributeArray& aAttributes);
williamr@2
    72
            
williamr@2
    73
        /**
williamr@2
    74
        * Destructor.
williamr@2
    75
        */
williamr@2
    76
        IMPORT_C virtual ~CSenSoapFault();
williamr@2
    77
williamr@2
    78
        // New functions
williamr@2
    79
        
williamr@2
    80
        /**
williamr@2
    81
        * @since Series60 3.0
williamr@2
    82
        * @return the content of <faultcode> element as UTF-8 form string
williamr@2
    83
        * or KNullDesC8, if element is not available
williamr@2
    84
        */
williamr@2
    85
        IMPORT_C TPtrC8 FaultCode();
williamr@2
    86
williamr@2
    87
		/**
williamr@2
    88
		* @since Series60 4.0
williamr@2
    89
		* @return the content of <Subcode> element as UTF-8 form string
williamr@2
    90
		* or KNullDesC8, if element is not available
williamr@2
    91
		*/
williamr@2
    92
		IMPORT_C TPtrC8 FaultSubcode();
williamr@2
    93
williamr@2
    94
		/**
williamr@2
    95
        * @since Series60 3.0
williamr@2
    96
        * @return the content of <faultstring> element as UTF-8 form string
williamr@2
    97
        * or KNullDesC8, if element is not available
williamr@2
    98
        */
williamr@2
    99
        IMPORT_C TPtrC8 FaultString();
williamr@2
   100
williamr@2
   101
        /**
williamr@2
   102
        * @since Series60 3.0
williamr@2
   103
        * @return the content of <faultactor> element as UTF-8 form string
williamr@2
   104
        * or KNullDesC8, if element is not available
williamr@2
   105
        */
williamr@2
   106
        IMPORT_C TPtrC8 FaultActor();
williamr@2
   107
williamr@2
   108
        /**
williamr@2
   109
        * @since Series60 3.0
williamr@2
   110
        * @return the content of <detail> element as UTF-8 form string
williamr@2
   111
        * or KNullDesC8, if element is not available
williamr@2
   112
        */
williamr@2
   113
        IMPORT_C TPtrC8 Detail();
williamr@2
   114
        
williamr@2
   115
    protected:  
williamr@2
   116
        
williamr@2
   117
        /**
williamr@2
   118
        * C++ default constructor
williamr@2
   119
        */
williamr@2
   120
        IMPORT_C CSenSoapFault();
williamr@2
   121
        
williamr@2
   122
        /**
williamr@2
   123
        * Basic ConstructL function
williamr@2
   124
        * @since Series60 3.0
williamr@2
   125
        * @param aCopiedSource is the CSenElement from which data to this
williamr@2
   126
        *        SOAP fault object is to be copied.
williamr@2
   127
        */
williamr@2
   128
        IMPORT_C void ConstructL(CSenElement& aCopiedSource);
williamr@2
   129
williamr@2
   130
        /**
williamr@2
   131
        * Basic ConstructL function
williamr@2
   132
        * @since Series60 3.0
williamr@2
   133
        * @param aNsUri is the XML namespace URI of this SOAP fault
williamr@2
   134
        * @param aLocalName is the XML localname URI of this SOAP fault
williamr@2
   135
        * @param aQName is the XML qualifiedname URI of this SOAP fault
williamr@2
   136
        * @param aAttributes are the XML attributes for this SOAP fault
williamr@2
   137
        */
williamr@2
   138
        IMPORT_C void ConstructL(const TDesC8& aNsUri,
williamr@2
   139
                                 const TDesC8& aLocalName,
williamr@2
   140
                                 const TDesC8& aQName,
williamr@2
   141
                                 const RAttributeArray& aAttributes);
williamr@2
   142
    };
williamr@2
   143
williamr@2
   144
#endif // SEN_SOAP_ENVELOPE_H
williamr@2
   145
williamr@2
   146
// End of File