mtpfws/mtpfw/dataproviders/dataproviderapi/interface/mtpobjectmgrquerytypes.h
changeset 0 d0791faffa3f
equal deleted inserted replaced
-1:000000000000 0:d0791faffa3f
       
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @publishedPartner
       
    19  @released
       
    20 */
       
    21 
       
    22 #ifndef MTPOBJECTMGRQUERYTYPES_H
       
    23 #define MTPOBJECTMGRQUERYTYPES_H
       
    24 
       
    25 #include <e32def.h>
       
    26 #include <mtp/mtpprotocolconstants.h> 
       
    27 
       
    28 class RDbView;
       
    29 
       
    30 /**
       
    31 Defines the MTP data provider framework object store enumeration manager object
       
    32 query parameters.
       
    33 */
       
    34 class TMTPObjectMgrQueryParams
       
    35     {
       
    36 public:
       
    37 
       
    38     IMPORT_C TMTPObjectMgrQueryParams(TUint32 aStorageId, TUint32 aFormatCode, TUint32 aParentHandle, TUint32 aDpId = KMTPDataProviderAll);
       
    39 
       
    40 public:
       
    41 
       
    42     /**
       
    43     The identifier of the storage on which the objects being queried 
       
    44     reside. A value of @see KMTPStorageAll requests indicates that an 
       
    45     aggregated set of objects residing on all storages is required.
       
    46     */
       
    47     TUint32 iStorageId;
       
    48     
       
    49     /**
       
    50     The MTP object format code of the objects being queried. A value of 
       
    51     @see KMTPFormatsAll indicates that an aggregated set of all object 
       
    52     formats is required.
       
    53     */
       
    54     TUint32 iFormatCode;
       
    55     
       
    56     /**
       
    57     The MTP object handle of the parent of the objects being queried. A 
       
    58     value of @see KMTPHandleNoParent indicates that the set of objects 
       
    59     residing in the root folder of their storage is required. 
       
    60     */
       
    61     TUint32 iParentHandle;
       
    62 	
       
    63     /**
       
    64     The data provider which owns the MTP objects @see KMTPDataProviderAll 
       
    65     indicates objects owned by any data providres
       
    66     */
       
    67 	TUint32  iDpId;
       
    68     };
       
    69   
       
    70 /**
       
    71 Defines the MTP data provider framework object store enumeration manager 
       
    72 object query context data. This data indicates if there is additional 
       
    73 object data to be retrieved which matches the query.
       
    74 */
       
    75 class RMTPObjectMgrQueryContext
       
    76     {
       
    77 public:
       
    78 
       
    79     IMPORT_C RMTPObjectMgrQueryContext();
       
    80     
       
    81     IMPORT_C void Close();
       
    82     
       
    83     IMPORT_C TBool QueryComplete() const;
       
    84     
       
    85 private:
       
    86 
       
    87     friend class CMTPObjectStore;
       
    88     IMPORT_C RDbView& DbView();
       
    89     IMPORT_C void OpenL();
       
    90     IMPORT_C TBool IsOpen() const;
       
    91     
       
    92 private:
       
    93 
       
    94     TAny* iContext;
       
    95     };
       
    96     
       
    97 #endif // MTPOBJECTMGRQUERYTYPES_H