inc/mmsdeleteresultarray.h
changeset 23 238255e8b033
equal deleted inserted replaced
5:4697dfb2d7ad 23:238255e8b033
       
     1 /*
       
     2 * Copyright (c) 2003-2007 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:   Structure to hold MMS encapsulation 1.1 version
       
    15 *                previoulsy-sent-by and previously-sent-date information  
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 #ifndef MMSDELETERESULTARRAY_H
       
    23 #define MMSDELETERESULTARRAY_H
       
    24 
       
    25 //  INCLUDES
       
    26 #include <e32base.h>
       
    27 #include <mtclbase.h>
       
    28 
       
    29 // CONSTANTS
       
    30 
       
    31 // MACROS
       
    32 
       
    33 // DATA TYPES
       
    34 
       
    35 // FUNCTION PROTOTYPES
       
    36 
       
    37 // FORWARD DECLARATIONS
       
    38 
       
    39 // CLASS DECLARATION
       
    40 
       
    41 /**
       
    42 *  Object for storing individual results from MMbox delete confirmation.
       
    43 *
       
    44 *  @lib mmsutil.lib
       
    45 *  @since 2.6
       
    46 */
       
    47 class CMmsDeleteResultArray : public CBase
       
    48     {
       
    49     public:  // Constructors and destructor
       
    50         
       
    51         /**
       
    52         * C++ default constructor.
       
    53         */
       
    54         CMmsDeleteResultArray();
       
    55 
       
    56         /**
       
    57         * Destructor.
       
    58         */
       
    59         virtual ~CMmsDeleteResultArray();
       
    60 
       
    61     public: // New functions
       
    62         
       
    63         /**
       
    64         * Ordering function.
       
    65         * @since 2.6
       
    66         * @param aFirst first item to be compared
       
    67         * @param aSecond second item to be compared
       
    68         * @return 1 if aFirst > aSecond, -1 if aFirst < aSecond, 0 if aFirst == aSecond
       
    69         */
       
    70         static TInt Compare( const CMmsDeleteResultArray& aFirst, const CMmsDeleteResultArray& aSecond );
       
    71 
       
    72         /**
       
    73         * Order accessor.
       
    74         * @since 2.6
       
    75         * @return iOrder
       
    76         */
       
    77         inline TUint Order() const;
       
    78 
       
    79         /**
       
    80         * Order mutator.
       
    81         * @since 2.6
       
    82         * @param sets iOrder
       
    83         */
       
    84         inline void SetOrder( TUint aOrder );
       
    85 
       
    86         /**
       
    87         * Response status accessor.
       
    88         * @since 2.6
       
    89         * @return response status.
       
    90         */
       
    91         inline TInt32 ResponseStatus() const;
       
    92 
       
    93         /**
       
    94         * Response status mutator. 
       
    95         * @since 2.1
       
    96         * @param aResponseStatus response status.
       
    97         */
       
    98         inline void SetResponseStatus( const TInt32 aResponseStatus );
       
    99 
       
   100         /**
       
   101         * Content Location accessor.
       
   102         * @since 2.6
       
   103         * @return Content Location of a message whose deletion failed.
       
   104         */
       
   105         IMPORT_C TPtrC8 ContentLocation() const;
       
   106 
       
   107         /**
       
   108         * ContentLocation mutator.
       
   109         * @since 2.6
       
   110         * @param aContentLocation content location of a message whose deletion failed
       
   111         */
       
   112         IMPORT_C void SetContentLocationL( const TDesC8& aContentLocation );
       
   113 
       
   114         /**
       
   115         * Response text accessor.
       
   116         * @since 2.6
       
   117         * @return Response text string.
       
   118         */
       
   119         IMPORT_C TPtrC ResponseText() const;
       
   120 
       
   121         /**
       
   122         * Response text mutator.
       
   123         * @since 2.6
       
   124         * @param aText Response text string,
       
   125         */
       
   126         IMPORT_C void SetResponseTextL( const TDesC& aText );
       
   127 
       
   128 
       
   129     public: // Functions from base classes
       
   130 
       
   131     protected:  // New functions
       
   132         
       
   133     protected:  // Functions from base classes
       
   134         
       
   135     private:
       
   136 
       
   137     public:     // Data
       
   138     
       
   139     protected:  // Data
       
   140 
       
   141     private:    // Data
       
   142         
       
   143         // order number (ties fields together)
       
   144         TUint32 iOrder;
       
   145         // error code
       
   146         TInt32  iResponseStatus;
       
   147         // content location for message whose deleteion failed
       
   148         HBufC8* iContentLocation;
       
   149         // error text
       
   150         HBufC*  iResponseText;
       
   151 
       
   152 
       
   153     public:     // Friend classes
       
   154 
       
   155     protected:  // Friend classes
       
   156 
       
   157     private:    // Friend classes
       
   158 
       
   159     };
       
   160 
       
   161 #include "mmsdeleteresultarray.inl"
       
   162 
       
   163 #endif      // MMSDELETERESULTARRAY_H   
       
   164             
       
   165 // End of File