imservices/searchfeatureplugin/srcsearchdatamodel/search/searcheventimp.h
author hgs
Wed, 03 Nov 2010 09:32:20 +0530
changeset 51 61fad867f68e
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  MSearchEvent API object implementation.
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef CSEARCHEVENTIMP_H
hgs
parents:
diff changeset
    19
#define CSEARCHEVENTIMP_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include  <s32strm.h>
hgs
parents:
diff changeset
    22
#include "ximpapieventbase.h"
hgs
parents:
diff changeset
    23
#include <searchevent.h>
hgs
parents:
diff changeset
    24
#include "searchapiobjbase.h"
hgs
parents:
diff changeset
    25
#include "searchtypehelpers.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
class RReadStream;
hgs
parents:
diff changeset
    28
class CXIMPIdentityImp;
hgs
parents:
diff changeset
    29
class CSearchInfoImp;
hgs
parents:
diff changeset
    30
class MXIMPIdentity;
hgs
parents:
diff changeset
    31
/**
hgs
parents:
diff changeset
    32
 * MSearchEvent API object implementation.
hgs
parents:
diff changeset
    33
 *
hgs
parents:
diff changeset
    34
 * @lib searchdatamodel.dll
hgs
parents:
diff changeset
    35
 */
hgs
parents:
diff changeset
    36
NONSHARABLE_CLASS( CSearchEventImp ): public CXIMPApiEventBase,public MSearchEvent
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
	public:
hgs
parents:
diff changeset
    39
	    /** The class ID. */
hgs
parents:
diff changeset
    40
	    enum { KClassId = IMP_CLSID_CSEARCHEVENTIMP  };
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
	public:
hgs
parents:
diff changeset
    43
	    /**
hgs
parents:
diff changeset
    44
	     * Exported instantiation method for initializing
hgs
parents:
diff changeset
    45
	     * new event object.
hgs
parents:
diff changeset
    46
	     */
hgs
parents:
diff changeset
    47
	    IMPORT_C static CSearchEventImp* NewLC( CXIMPIdentityImp& aSearchId,
hgs
parents:
diff changeset
    48
                                	            RSearchInfoImpArray* aSearchResults );
hgs
parents:
diff changeset
    49
     
hgs
parents:
diff changeset
    50
	    /**
hgs
parents:
diff changeset
    51
	     * Instantiation method for event automation.
hgs
parents:
diff changeset
    52
	     * Method signature must be exactly this to work
hgs
parents:
diff changeset
    53
	     * with event delivery automation system.
hgs
parents:
diff changeset
    54
	     *
hgs
parents:
diff changeset
    55
	     * Event implementation must be registered to
hgs
parents:
diff changeset
    56
	     * SearchEventCodec KApiEventConstructorTable.
hgs
parents:
diff changeset
    57
	     */
hgs
parents:
diff changeset
    58
	    static CXIMPApiEventBase* NewFromStreamLC( RReadStream& aStream );
hgs
parents:
diff changeset
    59
	    
hgs
parents:
diff changeset
    60
		/**
hgs
parents:
diff changeset
    61
         * Destructor
hgs
parents:
diff changeset
    62
         */
hgs
parents:
diff changeset
    63
	    virtual ~CSearchEventImp();
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
	private:
hgs
parents:
diff changeset
    66
		/**
hgs
parents:
diff changeset
    67
	     * constructor
hgs
parents:
diff changeset
    68
	     */
hgs
parents:
diff changeset
    69
	    CSearchEventImp();
hgs
parents:
diff changeset
    70
	    
hgs
parents:
diff changeset
    71
	    /**
hgs
parents:
diff changeset
    72
	     * 2nd phase constructor
hgs
parents:
diff changeset
    73
	     */
hgs
parents:
diff changeset
    74
	    void ConstructL( CXIMPIdentityImp& aSearchId,
hgs
parents:
diff changeset
    75
	            		RSearchInfoImpArray* aSearchResults );
hgs
parents:
diff changeset
    76
	            
hgs
parents:
diff changeset
    77
		/**
hgs
parents:
diff changeset
    78
	     * 2nd phase constructor
hgs
parents:
diff changeset
    79
	     */
hgs
parents:
diff changeset
    80
	    void ConstructL( RReadStream& aStream );
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
	    
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
	    /**
hgs
parents:
diff changeset
    85
	     * Helper for internalize
hgs
parents:
diff changeset
    86
	     */
hgs
parents:
diff changeset
    87
	    void InternalizeL( RReadStream& aStream ) ;
hgs
parents:
diff changeset
    88
	     /**
hgs
parents:
diff changeset
    89
	     * Helper for externalize
hgs
parents:
diff changeset
    90
	     */        
hgs
parents:
diff changeset
    91
		void WriteArrayToStreamL(RSearchInfoImpArray& aArray, RWriteStream& aStream ) const;
hgs
parents:
diff changeset
    92
		
hgs
parents:
diff changeset
    93
	    /**
hgs
parents:
diff changeset
    94
	     * Helper for internalize
hgs
parents:
diff changeset
    95
	     */
hgs
parents:
diff changeset
    96
	    void FillArrayFromStreamL( RSearchInfoImpArray& aArray,
hgs
parents:
diff changeset
    97
	            RReadStream& aStream );
hgs
parents:
diff changeset
    98
	    
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
	public: // From API base interfaces
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
	    /**
hgs
parents:
diff changeset
   103
	     * Implementation of MXIMPBase interface methods
hgs
parents:
diff changeset
   104
	     * @see MXIMPBase
hgs
parents:
diff changeset
   105
	     */
hgs
parents:
diff changeset
   106
	      XIMPIMP_DECLARE_IF_BASE_METHODS
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
	    /**
hgs
parents:
diff changeset
   109
	     * Implementation of MSearchEventBase interface and
hgs
parents:
diff changeset
   110
	     * CSearchApiEventBase methods
hgs
parents:
diff changeset
   111
	     *
hgs
parents:
diff changeset
   112
	     */
hgs
parents:
diff changeset
   113
	   	XIMPIMP_DECLARE_EVENT_BASE_METHODS
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
	public: // From MSearchEvent
hgs
parents:
diff changeset
   117
		/**
hgs
parents:
diff changeset
   118
	     * 
hgs
parents:
diff changeset
   119
	     * @see MSearchEvent
hgs
parents:
diff changeset
   120
	     */
hgs
parents:
diff changeset
   121
	 	virtual TInt SearchResultCount() const ;
hgs
parents:
diff changeset
   122
	    
hgs
parents:
diff changeset
   123
	    
hgs
parents:
diff changeset
   124
	    /**
hgs
parents:
diff changeset
   125
	     * Gets the searched result by index.
hgs
parents:
diff changeset
   126
	     *
hgs
parents:
diff changeset
   127
	     * @param [in] aIndex
hgs
parents:
diff changeset
   128
	     *        The index of the search.
hgs
parents:
diff changeset
   129
	     *
hgs
parents:
diff changeset
   130
	     * @return The searched result from given index.
hgs
parents:
diff changeset
   131
	     */
hgs
parents:
diff changeset
   132
	    virtual const MSearchInfo& SearchResult( TInt aIndex ) const ;
hgs
parents:
diff changeset
   133
	    /**
hgs
parents:
diff changeset
   134
	     * 
hgs
parents:
diff changeset
   135
	     * @see MSearchEvent
hgs
parents:
diff changeset
   136
	     */
hgs
parents:
diff changeset
   137
	    virtual const MXIMPIdentity& SearchId() const;
hgs
parents:
diff changeset
   138
	    
hgs
parents:
diff changeset
   139
	private: // data
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
		/**
hgs
parents:
diff changeset
   142
	     * Search Info array 
hgs
parents:
diff changeset
   143
	     * Own.
hgs
parents:
diff changeset
   144
	     */
hgs
parents:
diff changeset
   145
	     RSearchInfoImpArray* iSearchResults;
hgs
parents:
diff changeset
   146
	     
hgs
parents:
diff changeset
   147
	     /**
hgs
parents:
diff changeset
   148
         * CXIMPIdentityImp :  owned
hgs
parents:
diff changeset
   149
         */
hgs
parents:
diff changeset
   150
		 CXIMPIdentityImp*    iSearchId ;
hgs
parents:
diff changeset
   151
		 
hgs
parents:
diff changeset
   152
		 TBool iConstructedFromStream;
hgs
parents:
diff changeset
   153
    };
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
hgs
parents:
diff changeset
   156
#endif // CSEARCHEVENTIMP_H