1 /*

     2 * Copyright (c) 2007 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 Search info object.

    15 *

    16 */

    17 

    18 #ifndef MSEARCHINFO_H

    19 #define MSEARCHINFO_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <searchdatamodelifids.hrh>

    24 #include <badesca.h> 

    25 

    26 class MXIMPIdentity;

    27 

    28 /**

    29  * Defines Enums for information type.

    30  *

    31  * Information of following type  can be

    32  * stored and retrieve. 

    33  * 

    34  *

    35  */

    36 

    37 enum TInfoType

    38 	    {

    39 	    

    40 	    EEmailAddress,

    41 	    EFirstName,

    42 	    ELastName

    43 	    

    44 	    };	

    45 	

    46 

    47 /**

    48  * Interface for Search info object.

    49  *

    50  * Search info holds details of a single  search result.

    51  * Search results contains collection of searchinfo.

    52  *

    53  * @ingroup Searchdatamodelapi

    54  *

    55  */

    56 class MSearchInfo : public MXIMPBase

    57     {

    58     

    59 	    

    60 	public:

    61 

    62 	    /** Interface ID for the MImSearchInfo. */

    63 	    enum { KInterfaceId = SEARCH_IF_ID_SEARCH_INFO };

    64 

    65 

    66 	public:

    67 

    68 	    /**

    69 	     * Public destructor.

    70 	     * Objects can be deleted through this interface.

    71 	     */

    72 	    virtual ~MSearchInfo() {}

    73 

    74 

    75 	public:

    76 	 	/**

    77 	     * Returns the  information of particular information type.

    78 	     *

    79 	     * @param aType

    80 	     *        TInfoType which information type (e.g. EFirstname, Elastname etc)

    81 	     * 

    82 	     * @return TDesc16&  information of the type  passed. 

    83 	     */

    84 	    virtual const TDesC16& GetFieldInfo(TInfoType aType ) const =0 ;

    85 	    

    86 	    

    87       	/**

    88 	     * Sets the information of a particular type.

    89 	     *

    90 	     * @param aFieldInfo

    91 	     *        information to be set.

    92 	     *

    93 	     * @param aType

    94 	     *        type of the information.(e.g. EFirstname, Elastname etc)

    95 	     *

    96 	     */

    97 	    virtual void SetFieldInfoL(const TDesC16& aFieldInfo, TInfoType aType)  = 0 ;

    98     };

    99 

   100 

   101 #endif // MSEARCHINFO_H

   102 

   103 

   104