1 /*

     2 * Copyright (c) 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:  Interface for reporting errors during the import of Agenda data from an

    15 *  external source

    16 *

    17 *

    18 */

    19 

    20 

    21 #ifndef MESMRAGNIMPORTOBSERVER_H

    22 #define MESMRAGNIMPORTOBSERVER_H

    23 

    24 

    25 /**

    26 Interface for reporting errors during the import of Agenda data from an

    27 external source.

    28 @publishedAll

    29 */

    30 class MESMRAgnImportObserver

    31 	{

    32 public:	// Enumerations.

    33 

    34 	enum TImpResponse

    35 		{

    36 		/** Import as much as possible.*/

    37 		EImpResponseContinue,

    38 		/** Skip the broken component and continue with the next.*/

    39 		EImpResponseSkip,

    40 		/** Stop parsing and return.*/

    41 		EImpResponseStop,

    42 		/** Stop parsing and leave with KErrAbort.*/

    43 		EImpResponseLeave

    44 		};

    45 

    46 	enum TImpError

    47 		{

    48 		/** No error to report.*/

    49 		EImpErrorNoError,

    50 		/** The data being imported is corrupt and cannot be interpreted.*/

    51 		EImpErrorBadSyntax,

    52 		/** The data being imported can be parsed, but has invalid values.*/

    53 		EImpErrorInvalidData,

    54 		/** The data being imported is missing values which must be present.*/

    55 		EImpErrorMissingData,

    56 		/** The data being imported is correct, but the Agenda model cannot store it.*/

    57 		EImpErrorNotSupported

    58 		};

    59 

    60 public:		// Interface.

    61 	/**

    62 	This function will be called by AgendaExternalInterface plugins when they

    63 	encounter an error for which they feel the controlling application should

    64 	determine the appropriate course of action.

    65 	@param aType The type of the error

    66 	@param aUid The UID of the entry in which the error occurred (if known)

    67 	@param aContext A textual indication of the actual error

    68 	@return a TImpResponse indication the action to take

    69 	@see CAgnExternalInterface::ImportL

    70 	@publishedAll

    71 	*/

    72 	virtual TImpResponse AgnImportErrorL(TImpError aType, const TDesC8& aUid, const TDesC& aContext) = 0;

    73 	};

    74 

    75 #endif // MESMRAGNIMPORTOBSERVER_H

    76 

    77 // End of file.