1 /*

     2 * Copyright (c) 2006 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:   Search operation interface definition

    15 *

    16 */

    17 	

    18 

    19 #ifndef M_NCDSEARCHOPERATION_H

    20 #define M_NCDSEARCHOPERATION_H

    21 

    22 #include "ncdloadnodeoperation.h"

    23 #include "ncdinterfaceids.h"

    24 #include "ncdnodecontainer.h"

    25 

    26 class MNcdSearchFilter;

    27 

    28 /**

    29  *  Search operation interface.

    30  *

    31  *  Search operation searches for nodes according to a set search filter. The search

    32  *  is done starting from the folder from which the MNcdNodeSearch interface was

    33  *  queried. All items and folders below the start folder are searched for recursively, 

    34  *  the results are returned as a flat list under the virtual search result folder that

    35  *  can be queried with MNcdSearchOperation::SearchRootNodeL()

    36  * 

    37  *  The search is conducted on the node hierarchy below the node that the

    38  *  operation is started from. The search results are represented as a separate

    39  *  temporary node hierarchy under the provider.

    40  *

    41  *  

    42  *  @see MNcdNodeSearch

    43  *  @see MNcdSearchFilter

    44  */

    45 class MNcdSearchOperation : public MNcdLoadNodeOperation

    46 

    47     {

    48 

    49 public: // New functions

    50 

    51     

    52     /**

    53      * Unique identifier for the interface, required for all MCatalogsBase interfaces.

    54      *

    55      * 

    56      */

    57     enum { KInterfaceUid = ENcdSearchOperationUid };

    58 

    59 

    60     /**

    61      * Gets the search result hierarchy root node.

    62      *

    63      * 

    64      * @return Search result root node. The search results will be loaded here.

    65      *  Counted, Release() must be called after use.

    66      * @exception Leave System wide error code

    67      */

    68     virtual MNcdNodeContainer* SearchRootNodeL() = 0;

    69 

    70 

    71 protected:

    72 

    73 

    74     /**

    75     * Destructor.

    76     *

    77     * @see MCatalogsBase::~MCatalogsBase

    78     */

    79     virtual ~MNcdSearchOperation() {}

    80 

    81     };

    82 

    83 #endif //  M_NCDSEARCHOPERATION_H