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