inc/CPEngSearchCriteria2.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2004 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 criteria.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __CPENGSEARCHCRITERIA2_H
       
    19 #define __CPENGSEARCHCRITERIA2_H
       
    20 
       
    21 //  INCLUDES
       
    22 #include <E32Base.h>
       
    23 
       
    24 
       
    25 
       
    26 /**
       
    27  * Container for one search criteria.
       
    28  *
       
    29  * @lib PEngManager2.lib
       
    30  * @since 3.0
       
    31  */
       
    32 class CPEngSearchCriteria2 : public CBase
       
    33     {
       
    34         //-----------------------------------------------------------------------
       
    35     public: /* Construction */
       
    36 
       
    37         /**
       
    38          * Two-phased constructor.
       
    39          *
       
    40          * Initializes the search criteria with:
       
    41          *  - KPEngNullSearchElement (from PEngPresenceEngineConsts2.h)
       
    42          *  - Empty search string
       
    43          *
       
    44          * @return New CPEngSearchCriteria2 instance.
       
    45          */
       
    46         IMPORT_C static CPEngSearchCriteria2* NewL();
       
    47         IMPORT_C static CPEngSearchCriteria2* NewLC();
       
    48 
       
    49 
       
    50         /**
       
    51          * Destructor.
       
    52          * Virtual by CBase.
       
    53          */
       
    54         ~CPEngSearchCriteria2();
       
    55 
       
    56 
       
    57 
       
    58     private:
       
    59 
       
    60         CPEngSearchCriteria2();
       
    61         void ConstructL();
       
    62 
       
    63 
       
    64 
       
    65         //-----------------------------------------------------------------------
       
    66     public: /* Criterias */
       
    67 
       
    68         /**
       
    69          * Set the search request.
       
    70          *
       
    71          * @since 3.0
       
    72          * @param aElement What is searched. Supported search elements
       
    73          * are listed in PEngWVPresenceSearch2.h, TPEngWVSearchElement2
       
    74          * enumeration.
       
    75          * @param aSearchValue The string value that is searched
       
    76          * from network. String value meaning depends from given
       
    77          * search element value.
       
    78          */
       
    79         IMPORT_C void SetSearchL( TInt aElement,
       
    80                                   const TDesC& aSearchValue );
       
    81 
       
    82         /**
       
    83          * Gets the search request details
       
    84          * as set previously.
       
    85          *
       
    86          * @since 3.0
       
    87          */
       
    88         IMPORT_C TInt Element() const;
       
    89         IMPORT_C const TDesC& SearchValue() const;
       
    90 
       
    91 
       
    92 
       
    93 
       
    94         //-----------------------------------------------------------------------
       
    95     private: /* Data */
       
    96 
       
    97         //OWN: Search element
       
    98         TInt    iElement;
       
    99 
       
   100         //OWN: Search value
       
   101         HBufC*  iSearchValue;
       
   102 
       
   103     };
       
   104 
       
   105 #endif      // __CPENGSEARCHCRITERIA2_H
       
   106 
       
   107 //End of file