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:   Contains MNcdNodeSearch interface

    15 *

    16 */

    17 

    18 

    19 #ifndef M_NCD_NODE_SEARCH_H

    20 #define M_NCD_NODE_SEARCH_H

    21 

    22 

    23 #include "catalogsbase.h"

    24 #include "ncdinterfaceids.h"

    25 

    26 

    27 class MNcdSearchOperation;

    28 class MNcdLoadNodeOperationObserver;

    29 class MNcdSearchFilter;

    30 

    31 /**

    32  *  Provides methods to start search operation for searching contents within

    33  *  containers. A container node offers this interface to enable searching within it.

    34  *

    35  *  

    36  */

    37 class MNcdNodeSearch : public virtual MCatalogsBase

    38     {

    39 

    40 public:

    41 

    42     /**

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

    44      *

    45      * 

    46      */

    47     enum { KInterfaceUid = ENcdNodeSearchUid };

    48 

    49 

    50     /**

    51      * Creates a search operation.

    52      *

    53      * @param aObserver Observer for the search operation.

    54      * @param aSearchFilter A filter object defining the data to search for.

    55      * @return Pointer to the search operation, used for starting and following

    56      *  the progress of the search, and receiving the results. Counted, Release()

    57      *  must be called after use.

    58      * @exception Leave System wide error codes.

    59      *  KNcdErrorParallelOperationNotAllowed if a parallel client is running

    60      *  an operation for the same metadata. See MNcdOperation for full explanation.

    61      */

    62     virtual MNcdSearchOperation* SearchL( MNcdLoadNodeOperationObserver& aObserver,

    63         MNcdSearchFilter& aSearchFilter ) = 0;

    64 

    65 protected:

    66 

    67     /**

    68      * Destructor

    69      * 

    70      * @see MCatalogsBase::~MCatalogsBase()

    71      */

    72     virtual ~MNcdNodeSearch() {}

    73 

    74     };

    75 

    76 

    77 #endif // M_NCD_NODE_SEARCH_H