appinstall_plat/sifui_api/inc/sifuierrorinfo.h
author hgs
Fri, 06 Aug 2010 10:59:22 +0300
changeset 58 67f2119dc623
permissions -rw-r--r--
201031_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58
67f2119dc623 201031_01
hgs
parents:
diff changeset
     1
/*
67f2119dc623 201031_01
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
67f2119dc623 201031_01
hgs
parents:
diff changeset
     3
* All rights reserved.
67f2119dc623 201031_01
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
67f2119dc623 201031_01
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
67f2119dc623 201031_01
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
67f2119dc623 201031_01
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
67f2119dc623 201031_01
hgs
parents:
diff changeset
     8
*
67f2119dc623 201031_01
hgs
parents:
diff changeset
     9
* Initial Contributors:
67f2119dc623 201031_01
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    11
*
67f2119dc623 201031_01
hgs
parents:
diff changeset
    12
* Contributors:
67f2119dc623 201031_01
hgs
parents:
diff changeset
    13
*
67f2119dc623 201031_01
hgs
parents:
diff changeset
    14
* Description:  CSifUiErrorInfo for installation error details
67f2119dc623 201031_01
hgs
parents:
diff changeset
    15
*
67f2119dc623 201031_01
hgs
parents:
diff changeset
    16
*/
67f2119dc623 201031_01
hgs
parents:
diff changeset
    17
67f2119dc623 201031_01
hgs
parents:
diff changeset
    18
#ifndef C_SIFUIERRORINFO_H
67f2119dc623 201031_01
hgs
parents:
diff changeset
    19
#define C_SIFUIERRORINFO_H
67f2119dc623 201031_01
hgs
parents:
diff changeset
    20
67f2119dc623 201031_01
hgs
parents:
diff changeset
    21
#include <e32base.h>                            // CBase
67f2119dc623 201031_01
hgs
parents:
diff changeset
    22
#include <usif/usiferror.h>                     // Usif::TErrorCategory
67f2119dc623 201031_01
hgs
parents:
diff changeset
    23
67f2119dc623 201031_01
hgs
parents:
diff changeset
    24
67f2119dc623 201031_01
hgs
parents:
diff changeset
    25
/**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    26
 * CSifUiErrorInfo is a container class for installation error details.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    27
 *
67f2119dc623 201031_01
hgs
parents:
diff changeset
    28
 * @lib sifui.lib
67f2119dc623 201031_01
hgs
parents:
diff changeset
    29
 * @since 10.1
67f2119dc623 201031_01
hgs
parents:
diff changeset
    30
 */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    31
class CSifUiErrorInfo : public CBase
67f2119dc623 201031_01
hgs
parents:
diff changeset
    32
    {
67f2119dc623 201031_01
hgs
parents:
diff changeset
    33
    public:     // constructors and destructor
67f2119dc623 201031_01
hgs
parents:
diff changeset
    34
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    35
         * Creates new CSifUiErrorInfo object and pushes it to cleanup stack.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    36
         * @param aErrorCategory - error category
67f2119dc623 201031_01
hgs
parents:
diff changeset
    37
         * @param aErrorCode - error code
67f2119dc623 201031_01
hgs
parents:
diff changeset
    38
         * @param aExtendedErrorCode - extended error code
67f2119dc623 201031_01
hgs
parents:
diff changeset
    39
         * @param aErrorMessage - error message
67f2119dc623 201031_01
hgs
parents:
diff changeset
    40
         * @param aErrorMessageDetails - detailed error message
67f2119dc623 201031_01
hgs
parents:
diff changeset
    41
         * @returns CSifUiErrorInfo* -- new CSifUiErrorInfo object
67f2119dc623 201031_01
hgs
parents:
diff changeset
    42
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    43
        IMPORT_C static CSifUiErrorInfo* NewLC( Usif::TErrorCategory aErrorCategory,
67f2119dc623 201031_01
hgs
parents:
diff changeset
    44
                TInt aErrorCode, TInt aExtendedErrorCode,
67f2119dc623 201031_01
hgs
parents:
diff changeset
    45
                const TDesC& aErrorMessage, const TDesC& aErrorMessageDetails );
67f2119dc623 201031_01
hgs
parents:
diff changeset
    46
67f2119dc623 201031_01
hgs
parents:
diff changeset
    47
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    48
         * Creates new CSifUiErrorInfo object.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    49
         * @param aErrorCategory - error category
67f2119dc623 201031_01
hgs
parents:
diff changeset
    50
         * @param aErrorCode - error code
67f2119dc623 201031_01
hgs
parents:
diff changeset
    51
         * @param aExtendedErrorCode - extended error code
67f2119dc623 201031_01
hgs
parents:
diff changeset
    52
         * @param aErrorMessage - error message
67f2119dc623 201031_01
hgs
parents:
diff changeset
    53
         * @param aErrorMessageDetails - detailed error message
67f2119dc623 201031_01
hgs
parents:
diff changeset
    54
         * @returns CSifUiErrorInfo* -- new CSifUiErrorInfo object
67f2119dc623 201031_01
hgs
parents:
diff changeset
    55
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    56
        IMPORT_C static CSifUiErrorInfo* NewL( Usif::TErrorCategory aErrorCategory,
67f2119dc623 201031_01
hgs
parents:
diff changeset
    57
                TInt aErrorCode, TInt aExtendedErrorCode,
67f2119dc623 201031_01
hgs
parents:
diff changeset
    58
                const TDesC& aErrorMessage, const TDesC& aErrorMessageDetails );
67f2119dc623 201031_01
hgs
parents:
diff changeset
    59
67f2119dc623 201031_01
hgs
parents:
diff changeset
    60
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    61
         * Destructor.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    62
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    63
        ~CSifUiErrorInfo();
67f2119dc623 201031_01
hgs
parents:
diff changeset
    64
67f2119dc623 201031_01
hgs
parents:
diff changeset
    65
    public:     // new functions
67f2119dc623 201031_01
hgs
parents:
diff changeset
    66
67f2119dc623 201031_01
hgs
parents:
diff changeset
    67
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    68
         * Error category.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    69
         * @returns Usif::TErrorCategory - error category
67f2119dc623 201031_01
hgs
parents:
diff changeset
    70
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    71
        inline Usif::TErrorCategory ErrorCategory() const;
67f2119dc623 201031_01
hgs
parents:
diff changeset
    72
67f2119dc623 201031_01
hgs
parents:
diff changeset
    73
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    74
         * Error code.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    75
         * @returns TInt - error code
67f2119dc623 201031_01
hgs
parents:
diff changeset
    76
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    77
        inline TInt ErrorCode() const;
67f2119dc623 201031_01
hgs
parents:
diff changeset
    78
67f2119dc623 201031_01
hgs
parents:
diff changeset
    79
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    80
         * Extended error code.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    81
         * @returns TInt - extended error code
67f2119dc623 201031_01
hgs
parents:
diff changeset
    82
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    83
        inline TInt ExtendedErrorCode() const;
67f2119dc623 201031_01
hgs
parents:
diff changeset
    84
67f2119dc623 201031_01
hgs
parents:
diff changeset
    85
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    86
         * Error message.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    87
         * @returns const TDesC& - error message
67f2119dc623 201031_01
hgs
parents:
diff changeset
    88
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    89
        inline const TDesC& ErrorMessage() const;
67f2119dc623 201031_01
hgs
parents:
diff changeset
    90
67f2119dc623 201031_01
hgs
parents:
diff changeset
    91
        /**
67f2119dc623 201031_01
hgs
parents:
diff changeset
    92
         * Error message details.
67f2119dc623 201031_01
hgs
parents:
diff changeset
    93
         * @returns const TDesC& - additional error message details
67f2119dc623 201031_01
hgs
parents:
diff changeset
    94
         */
67f2119dc623 201031_01
hgs
parents:
diff changeset
    95
        inline const TDesC& ErrorMessageDetails() const;
67f2119dc623 201031_01
hgs
parents:
diff changeset
    96
67f2119dc623 201031_01
hgs
parents:
diff changeset
    97
    private:    // new functions
67f2119dc623 201031_01
hgs
parents:
diff changeset
    98
        CSifUiErrorInfo();
67f2119dc623 201031_01
hgs
parents:
diff changeset
    99
        void ConstructL( Usif::TErrorCategory aErrorCategory,
67f2119dc623 201031_01
hgs
parents:
diff changeset
   100
                TInt aErrorCode, TInt aExtendedErrorCode,
67f2119dc623 201031_01
hgs
parents:
diff changeset
   101
                const TDesC& aErrorMessage, const TDesC& aErrorMessageDetails );
67f2119dc623 201031_01
hgs
parents:
diff changeset
   102
67f2119dc623 201031_01
hgs
parents:
diff changeset
   103
    private:    // data
67f2119dc623 201031_01
hgs
parents:
diff changeset
   104
        Usif::TErrorCategory iErrorCategory;
67f2119dc623 201031_01
hgs
parents:
diff changeset
   105
        TInt iErrorCode;
67f2119dc623 201031_01
hgs
parents:
diff changeset
   106
        TInt iExtendedErrorCode;
67f2119dc623 201031_01
hgs
parents:
diff changeset
   107
        HBufC* iErrorMessage;
67f2119dc623 201031_01
hgs
parents:
diff changeset
   108
        HBufC* iErrorMessageDetails;
67f2119dc623 201031_01
hgs
parents:
diff changeset
   109
    };
67f2119dc623 201031_01
hgs
parents:
diff changeset
   110
67f2119dc623 201031_01
hgs
parents:
diff changeset
   111
67f2119dc623 201031_01
hgs
parents:
diff changeset
   112
#include "sifuierrorinfo.inl"
67f2119dc623 201031_01
hgs
parents:
diff changeset
   113
67f2119dc623 201031_01
hgs
parents:
diff changeset
   114
#endif  // C_SIFUIERRORINFO_H
67f2119dc623 201031_01
hgs
parents:
diff changeset
   115