1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // This file contains all the interfaces classes that can be implemented by

    15 // the Licensee LTSY relating to PhonebookEn related features.

    16 //

    17 

    18 

    19 

    20 

    21 /**

    22  @file

    23  @internalAll 

    24 */

    25 

    26 

    27 #ifndef MLTSYDISPATCHPHONEBOOKENINTERFACE_H_

    28 #define MLTSYDISPATCHPHONEBOOKENINTERFACE_H_

    29 

    30 #include <ctsy/ltsy/mltsydispatchinterface.h>

    31 

    32 

    33 class MLtsyDispatchPhonebookEnStoreGetInfo : public MLtsyDispatchInterface

    34 	{

    35 public:

    36 

    37 	static const TInt KLtsyDispatchPhonebookEnStoreGetInfoApiId = KDispatchPhonebookEnFuncUnitId + 1;

    38 

    39 	/**

    40 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyENStoreGetInfoIPC

    41 	 * request from the CTSY.

    42 	 *

    43 	 * It is a request call that is completed by invoking

    44 	 * CCtsyDispatcherCallback::CallbackPhonebookEnStoreGetInfoComp()

    45 	 *

    46 	 * Implementation of this interface should handle retrieving of the information of the EN storage.

    47 	 *

    48 	 *

    49 	 * @return KErrNone on success, otherwise another error code indicating the

    50 	 * failure.

    51 	 */

    52 	virtual TInt HandleStoreGetInfoReqL() = 0;

    53 

    54 	}; // class MLtsyDispatchPhonebookEnStoreGetInfo

    55 

    56 

    57 

    58 class MLtsyDispatchPhonebookEnStoreReadAll : public MLtsyDispatchInterface

    59 	{

    60 public:

    61 

    62 	static const TInt KLtsyDispatchPhonebookEnStoreReadAllApiId = KDispatchPhonebookEnFuncUnitId + 2;

    63 

    64 	/**

    65 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyENStoreReadAllPhase1IPC

    66 	 * request from the CTSY.

    67 	 *

    68 	 * It is a request call that is completed by invoking

    69 	 * CCtsyDispatcherCallback::CallbackPhonebookEnStoreReadAllComp()

    70 	 *

    71 	 * Implementation of this interface should handle reading all the entries from the EN storage.

    72 	 *

    73 	 *

    74 	 * @return KErrNone on success, otherwise another error code indicating the

    75 	 * failure.

    76 	 */

    77 	virtual TInt HandleStoreReadAllReqL() = 0;

    78 

    79 	}; // class MLtsyDispatchPhonebookEnStoreReadAll

    80 

    81 

    82 

    83 class MLtsyDispatchPhonebookEnStoreReadEntry : public MLtsyDispatchInterface

    84 	{

    85 public:

    86 

    87 	static const TInt KLtsyDispatchPhonebookEnStoreReadEntryApiId = KDispatchPhonebookEnFuncUnitId + 3;

    88 

    89 	/**

    90 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyENStoreReadIPC

    91 	 * request from the CTSY.

    92 	 *

    93 	 * It is a request call that is completed by invoking

    94 	 * CCtsyDispatcherCallback::CallbackPhonebookEnStoreReadEntryComp()

    95 	 *

    96 	 * Implementation of this interface should handle reading of an entry from the EN storage with a given index.

    97 	 *

    98 	 *

    99 	 * @param aIndex The index of the EN entry.

   100 	 *

   101 	 *

   102 	 * @return KErrNone on success, otherwise another error code indicating the

   103 	 * failure.

   104 	 */

   105 	virtual TInt HandleStoreReadEntryReqL(TInt aIndex) = 0;

   106 

   107 	}; // class MLtsyDispatchPhonebookEnStoreReadEntry

   108 

   109 

   110 #endif /*MLTSYDISPATCHPHONEBOOKENINTERFACE_H_*/