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 PhonebookOn related features.

    16 //

    17 

    18 

    19 

    20 

    21 /**

    22  @file

    23  @internalAll 

    24 */

    25 

    26 

    27 #ifndef MLTSYDISPATCHPHONEBOOKONINTERFACE_H_

    28 #define MLTSYDISPATCHPHONEBOOKONINTERFACE_H_

    29 

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

    31 #include <etelmm.h>

    32 

    33 class MLtsyDispatchPhonebookOnStoreRead : public MLtsyDispatchInterface

    34 	{

    35 public:

    36 

    37 	static const TInt KLtsyDispatchPhonebookOnStoreReadApiId = KDispatchPhonebookOnFuncUnitId + 1;

    38 

    39 	/**

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

    41 	 * request from the CTSY.

    42 	 *

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

    44 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreReadComp()

    45 	 *

    46 	 * Implementation of this interface should handle reading a ON entry from the storage.

    47 	 *

    48 	 *

    49 	 * @param aIndex index of the ON entry.

    50 	 *

    51 	 *

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

    53 	 * failure.

    54 	 */

    55 	virtual TInt HandleStoreReadReqL(TInt aIndex) = 0;

    56 

    57 	}; // class MLtsyDispatchPhonebookOnStoreRead

    58 

    59 

    60 

    61 class MLtsyDispatchPhonebookOnStoreDeleteAll : public MLtsyDispatchInterface

    62 	{

    63 public:

    64 

    65 	static const TInt KLtsyDispatchPhonebookOnStoreDeleteAllApiId = KDispatchPhonebookOnFuncUnitId + 2;

    66 

    67 	/**

    68 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreDeleteAllIPC

    69 	 * request from the CTSY.

    70 	 *

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

    72 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreDeleteAllComp()

    73 	 *

    74 	 * Implementation of this interface should handle deletion of all entries of the storage.

    75 	 *

    76 	 *

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

    78 	 * failure.

    79 	 */

    80 	virtual TInt HandleStoreDeleteAllReqL() = 0;

    81 

    82 	}; // class MLtsyDispatchPhonebookOnStoreDeleteAll

    83 

    84 

    85 

    86 class MLtsyDispatchPhonebookOnStoreReadEntry : public MLtsyDispatchInterface

    87 	{

    88 public:

    89 

    90 	static const TInt KLtsyDispatchPhonebookOnStoreReadEntryApiId = KDispatchPhonebookOnFuncUnitId + 3;

    91 

    92 	/**

    93 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreReadEntryIPC

    94 	 * request from the CTSY.

    95 	 *

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

    97 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreReadEntryComp()

    98 	 *

    99 	 * Implementation of this interface should handle reading an entry from ON storage as one step of reading of all entries.

   100 	 *

   101 	 *

   102 	 * @param aIndex index of the entry,

   103 	 *

   104 	 *

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

   106 	 * failure.

   107 	 */

   108 	virtual TInt HandleStoreReadEntryReqL(TInt aIndex) = 0;

   109 

   110 	}; // class MLtsyDispatchPhonebookOnStoreReadEntry

   111 

   112 

   113 

   114 class MLtsyDispatchPhonebookOnStoreGetInfo : public MLtsyDispatchInterface

   115 	{

   116 public:

   117 

   118 	static const TInt KLtsyDispatchPhonebookOnStoreGetInfoApiId = KDispatchPhonebookOnFuncUnitId + 4;

   119 

   120 	/**

   121 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreGetInfoIPC

   122 	 * request from the CTSY.

   123 	 *

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

   125 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreGetInfoComp()

   126 	 *

   127 	 * Implementation of this interface should request to get the information of a given storage. The 

   128 	 * callback should be completed with the information.

   129 	 *

   130 	 *

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

   132 	 * failure.

   133 	 */

   134 	virtual TInt HandleStoreGetInfoReqL() = 0;

   135 

   136 	}; // class MLtsyDispatchPhonebookOnStoreGetInfo

   137 

   138 

   139 

   140 class MLtsyDispatchPhonebookOnStoreGetReadStoreSize : public MLtsyDispatchInterface

   141 	{

   142 public:

   143 

   144 	static const TInt KLtsyDispatchPhonebookOnStoreGetReadStoreSizeApiId = KDispatchPhonebookOnFuncUnitId + 5;

   145 

   146 	/**

   147 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreReadSizeIPC

   148 	 * request from the CTSY.

   149 	 *

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

   151 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreGetReadStoreSizeComp()

   152 	 *

   153 	 * Implementation of this interface should handle retrieving the size of the storage for read all operation.

   154 	 *

   155 	 *

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

   157 	 * failure.

   158 	 */

   159 	virtual TInt HandleStoreGetReadStoreSizeReqL() = 0;

   160 

   161 	}; // class MLtsyDispatchPhonebookOnStoreGetReadStoreSize

   162 

   163 

   164 

   165 class MLtsyDispatchPhonebookOnStoreDeleteEntry : public MLtsyDispatchInterface

   166 	{

   167 public:

   168 

   169 	static const TInt KLtsyDispatchPhonebookOnStoreDeleteEntryApiId = KDispatchPhonebookOnFuncUnitId + 6;

   170 

   171 	/**

   172 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreDeleteIPC

   173 	 * request from the CTSY.

   174 	 *

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

   176 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreDeleteEntryComp()

   177 	 *

   178 	 * Implementation of this interface should handle deletion of an ON entry.

   179 	 *

   180 	 *

   181 	 * @param aIndex index of the ON entry.

   182 	 *

   183 	 *

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

   185 	 * failure.

   186 	 */

   187 	virtual TInt HandleStoreDeleteEntryReqL(TInt aIndex) = 0;

   188 

   189 	}; // class MLtsyDispatchPhonebookOnStoreDeleteEntry

   190 

   191 

   192 

   193 class MLtsyDispatchPhonebookOnStoreWriteEntry : public MLtsyDispatchInterface

   194 	{

   195 public:

   196 

   197 	static const TInt KLtsyDispatchPhonebookOnStoreWriteEntryApiId = KDispatchPhonebookOnFuncUnitId + 7;

   198 

   199 	/**

   200 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreWriteEntryIPC

   201 	 * request from the CTSY.

   202 	 *

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

   204 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreWriteEntryComp()

   205 	 *

   206 	 * Implementation of this interface should handle storing of a ON entry as one step of storing of all entries in the ON storage.

   207 	 *

   208 	 *

   209 	 * @param aMobileOnEntry defines contents of a fixed-size ON entry to be stored. 

   210 	 *

   211 	 *

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

   213 	 * failure.

   214 	 */

   215 	virtual TInt HandleStoreWriteEntryReqL(const RMobileONStore::TMobileONEntryV1& aMobileOnEntry) = 0;

   216 

   217 	}; // class MLtsyDispatchPhonebookOnStoreWriteEntry

   218 

   219 

   220 

   221 class MLtsyDispatchPhonebookOnStoreWrite : public MLtsyDispatchInterface

   222 	{

   223 public:

   224 

   225 	static const TInt KLtsyDispatchPhonebookOnStoreWriteApiId = KDispatchPhonebookOnFuncUnitId + 8;

   226 

   227 	/**

   228 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreWriteIPC

   229 	 * request from the CTSY.

   230 	 *

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

   232 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreWriteComp()

   233 	 *

   234 	 * Implementation of this interface should handle storing of a ON entry.

   235 	 *

   236 	 * @param aMobileOnEntry defines contents of a fixed-size ON entry to be stored. 

   237 	 *

   238 	 *

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

   240 	 * failure.

   241 	 */

   242 	virtual TInt HandleStoreWriteReqL(const RMobileONStore::TMobileONEntryV1& aMobileOnEntry) = 0;

   243 

   244 	}; // class MLtsyDispatchPhonebookOnStoreWrite

   245 

   246 

   247 

   248 class MLtsyDispatchPhonebookOnStoreGetStoreSize : public MLtsyDispatchInterface

   249 	{

   250 public:

   251 

   252 	static const TInt KLtsyDispatchPhonebookOnStoreGetStoreSizeApiId = KDispatchPhonebookOnFuncUnitId + 9;

   253 

   254 	/**

   255 	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsyONStoreWriteSizeIPC

   256 	 * request from the CTSY.

   257 	 *

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

   259 	 * CCtsyDispatcherCallback::CallbackPhonebookOnStoreGetStoreSizeComp()

   260 	 *

   261 	 * Implementation of this interface should handle retrieving of the size of the storage.

   262 	 *

   263 	 *

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

   265 	 * failure.

   266 	 */

   267 	virtual TInt HandleStoreGetStoreSizeReqL() = 0;

   268 

   269 	}; // class MLtsyDispatchPhonebookOnStoreGetStoreSize

   270 

   271 

   272 #endif /*MLTSYDISPATCHPHONEBOOKONINTERFACE_H_*/