upnpmediaserver/contentdirectoryservice/inc/upnpcontentdirectorydatafinder.h
changeset 0 7f85d04be362
equal deleted inserted replaced
-1:000000000000 0:7f85d04be362
       
     1 /** @file
       
     2 * Copyright (c) 2005-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:  This is a interface, which allows to comunicate with 
       
    15 *				 ContentDirectory service to obtain informations related to 
       
    16 *				 reqested Uri such as path on physical drive to requested Uri 
       
    17 *				 or DLNA specyfic informations and flag for this Uri.
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 #ifndef C_MUPNPCONTENTDIRECTORYDATAFINDER_H
       
    24 #define C_MUPNPCONTENTDIRECTORYDATAFINDER_H
       
    25 
       
    26 //  INCLUDES
       
    27 #include <e32std.h>
       
    28 #include "upnpprotocolinfo.h"
       
    29 #include "upnpdlnaprotocolinfo.h"
       
    30 
       
    31 // FORWARD DECLARATIONS
       
    32 class CUpnpContentDirectory;
       
    33 
       
    34 /**
       
    35 * This is a interface, which allows to comunicate with ContentDirectory service
       
    36 * to obtain informations related to reqested Uri such as path on physical drive
       
    37 * to requested Uri or DLNA specyfic informations and flag for this Uri.
       
    38 * @lib DLNAwebserver.lib
       
    39 * @since Series 60 2.6
       
    40 **/
       
    41 class MUpnpContentDirectoryDataFinder 
       
    42     {
       
    43 public: 
       
    44 
       
    45     /**
       
    46     * Checks if specified importUri is in database still active.
       
    47     * @since Series60 2.6
       
    48     * @param aImportUri uri to be searched in databse. 
       
    49     * @return objId if successful or KErrnone if object wasn't found.
       
    50     **/
       
    51     virtual TInt CheckImportUriL( const TDesC8& aImportUri ) = 0;
       
    52   
       
    53     /**
       
    54     * Gets title of the object with given id from ContentDirectory service. 
       
    55     * @since Series60 2.6
       
    56     * @param aObjectId id of the object.
       
    57     * @param aValue pointer to buffer in which the tilte of the object will be returned.
       
    58     *       Buffer for aValue has to allocated first.
       
    59     **/
       
    60     virtual void GetTitleForUriL( TInt aObjectId, TPtr& aValue ) = 0;
       
    61     
       
    62     /**
       
    63     * Finds protocolInfo by contentUri (Not by importUri).
       
    64     * @since Series60 2.6
       
    65     * @param aContentUri uri to be searched in database (Value of resource).
       
    66     * @param aProtocolInfo ProtocolInfo related to resorce which has been founded. 
       
    67     *       Ownership is transfered to the caller.
       
    68     * @return KErrNone if successful, otherwise another of the system error codes 
       
    69     **/
       
    70     virtual TInt GetProtocolInfoL( const TDesC8& aContentUri, 
       
    71                                    CUpnpDlnaProtocolInfo*& aProtocolInfo ) = 0;
       
    72    
       
    73     /**
       
    74     * Find shared folder for urlpath
       
    75     * @since Series60 2.6
       
    76     * @param aUrlPath Name of URL path connected to shared folder.
       
    77     * @param aFileName Name of file.Can be empty.
       
    78     * @param aFolderPath Name of shared folder.
       
    79     * @return KErrNone or another of the system error codes.
       
    80     **/ 
       
    81     virtual TInt FindSharedFolderL( const TDesC& aUrlPath, 
       
    82                                     const TDesC& aFileName, 
       
    83                                     HBufC*& aFolderPath ) = 0;
       
    84                                     
       
    85     /**
       
    86     * Find protocolInfo by importUri.
       
    87     * @param aImportUritUri uri to be searched in database (Value of resource).
       
    88     * @return ProtocolInfo related to resorce which has been founded. Ownership 
       
    89     *       is transfered to the caller.
       
    90     */
       
    91     virtual CUpnpDlnaProtocolInfo* GetProtocolInfoByImportUriL( 
       
    92                                   const TDesC8& aImportUri) = 0;
       
    93 
       
    94 
       
    95     };
       
    96 
       
    97 #endif      // C_MUPNPCONTENTDIRECTORYDATAFINDER_H
       
    98      
       
    99 // End of File