1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactOperationFactory2.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,80 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Virtual Phonebook factory interface for asynchronous 
    1.18 +*                contact operations.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef MVPBKCONTACTOPERATIONFACTORY2_H
    1.24 +#define MVPBKCONTACTOPERATIONFACTORY2_H
    1.25 +
    1.26 +// INCLUDES
    1.27 +#include <e32cmn.h>
    1.28 +#include <bamdesca.h>
    1.29 +#include <BADESCA.H> 
    1.30 +// FORWARD DECLARATIONS
    1.31 +class MVPbkContactOperation;
    1.32 +class MVPbkContactLink;
    1.33 +class MVPbkContactLinkArray;
    1.34 +class MVPbkStoreContact;
    1.35 +class MVPbkSingleContactOperationObserver;
    1.36 +class MVPbkBatchOperationObserver;
    1.37 +class MVPbkContactFindObserver;
    1.38 +class MVPbkFieldTypeList;
    1.39 +class MVPbkContactFindFromStoresObserver;
    1.40 +const TUid KMVPbkContactOperationFactory2Uid = { 2 };
    1.41 +
    1.42 +// CLASS DECLARATIONS
    1.43 +
    1.44 +/**
    1.45 + * A factory interface for asynchronous contact operations.
    1.46 + * This interface is used to create contact operations.
    1.47 + * This interface allows specific store operations.
    1.48 + */
    1.49 +class MVPbkContactOperationFactory2
    1.50 +    {
    1.51 +    public:  // Factories
    1.52 +        /**
    1.53 +         * Creates an operation for asynchronous contact finding.
    1.54 +         * Finds a string containing text that is stored in one or more fields.
    1.55 +         * Client can give multiple find words. All the words must match to separated
    1.56 +         * data. E.g if there are two find words: "Jo" and "Jo" then field data
    1.57 +         * "John Johnson" matches but "John Doe" doesn't if the word parser uses
    1.58 +         * white space as a word separator.
    1.59 +         *
    1.60 +         * NOTE: The accuracy of the results depends on the ability of the store
    1.61 +         *       implementation to implement the find. The performance can vary
    1.62 +         *       too depending on the store. 
    1.63 +         *
    1.64 +         * @param aSearchStrings    Words that are compared to field data.
    1.65 +         * @param aFieldTypes   Types of the fields that are used.
    1.66 +         * @param aObserver An observer for asynchronous operation.
    1.67 +         * @param aWordParserCallBack a client implementation of word parser 
    1.68 +         *                            function that separates the field data 
    1.69 +         *                            into words. Parameter to function is 
    1.70 +         *                            TVPbkWordParserParam.
    1.71 +         * @param aStoreEntriesArray an array that lists the store entries.
    1.72 +         * @return A handle to the operation or NULL
    1.73 +         */
    1.74 +             virtual MVPbkContactOperation* CreateFindOperationL(
    1.75 +                const MDesC16Array& aSearchStrings, 
    1.76 +                const MVPbkFieldTypeList& aFieldTypes, 
    1.77 +                MVPbkContactFindFromStoresObserver& aObserver, 
    1.78 +                const TCallBack& aWordParserCallBack,
    1.79 +                const CDesC16ArrayFlat& aStoreEntriesArray ) = 0;    
    1.80 +  	};
    1.81 +#endif // MVPBKCONTACTOPERATIONFACTORY2_H
    1.82 +
    1.83 +// End of File