wvuing/wvuieng/EngInc/MCAError.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2002 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:  Error interface for retrieving partial success data
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MCAERROR_H
       
    20 #define MCAERROR_H
       
    21 
       
    22 #include <badesca.h>
       
    23 #include <e32std.h>
       
    24 
       
    25 /**
       
    26 *  MCAError interface class provides functionality to retrieve partial
       
    27 *  success data (201 "error").
       
    28 *
       
    29 *  @lib CAEngine.lib
       
    30 *  @since 1.2
       
    31 */
       
    32 class MCAError
       
    33     {
       
    34     public:  // Interface
       
    35 
       
    36         /**
       
    37         * Returns the error code.
       
    38         * @return Error code.
       
    39         */
       
    40         virtual TInt Code() const = 0;
       
    41 
       
    42         /**
       
    43         * Textual description from the error.
       
    44         * @return Plain text explanation.
       
    45         */
       
    46         virtual const TDesC& Description() const = 0;
       
    47 
       
    48         /**
       
    49         * Return user IDs.
       
    50         * @return Array that holds the user IDs.
       
    51         */
       
    52         virtual const CDesCArray& UserIDs() const = 0;
       
    53 
       
    54         /**
       
    55         * Return group IDs.
       
    56         * @return Array that holds the group IDs.
       
    57         */
       
    58         virtual const CDesCArray& GroupIDs() const = 0;
       
    59 
       
    60         /**
       
    61         * Return message IDs.
       
    62         * @return Array that holds the message IDs.
       
    63         */
       
    64         virtual const CDesCArray& MessageIDs() const = 0;
       
    65 
       
    66         /**
       
    67         * Return screen names. The corresponding group is found from
       
    68         * corresponding array index in the ScreenNameGroup().
       
    69         * @return Array that holds the screen names.
       
    70         */
       
    71         virtual const CDesCArray& ScreenNames() const = 0;
       
    72 
       
    73         /**
       
    74         * Return group IDs.
       
    75         * @return Array that holds the group IDs.
       
    76         */
       
    77         virtual const CDesCArray& ScreenNameGroup() const = 0;
       
    78 
       
    79         /**
       
    80         * Destructor.
       
    81         */
       
    82         virtual ~MCAError() {};
       
    83 
       
    84     };
       
    85 
       
    86 #endif      // MCAERROR_H
       
    87 
       
    88 // End of File