harvester/harvesterserver/inc/ccontentinfo.h
changeset 1 6f2c1c46032b
equal deleted inserted replaced
0:671dee74050a 1:6f2c1c46032b
       
     1 /*
       
     2 * Copyright (c) 2010 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 component is to store the details of harvester plugins
       
    15 *
       
    16 */
       
    17 #ifndef CCONTENTINFO_H_
       
    18 #define CCONTENTINFO_H_
       
    19 
       
    20 #include <e32base.h>
       
    21 
       
    22 class CContentInfo : public CBase
       
    23     {
       
    24 public :
       
    25     /*
       
    26     * Construction
       
    27     * @return instance of CContentInfo
       
    28     */
       
    29     static CContentInfo* NewL();
       
    30     
       
    31     /*
       
    32     * Construction
       
    33     * @return instance of CContentInfo
       
    34     */
       
    35     static CContentInfo* NewLC();
       
    36     //Destructor
       
    37     ~CContentInfo();
       
    38     
       
    39 private :
       
    40     /*
       
    41     * Default constructor
       
    42     */
       
    43     CContentInfo();  
       
    44     
       
    45 public:
       
    46     /*
       
    47     * @description Returns the name of the content( This is the display
       
    48     * name given in the corresponding plugin RSS file).
       
    49     * @return the descriptor containing the name of the content and it
       
    50     * is the responsibility of the caller to free the allocated memory
       
    51     * Leaves in case of errors.
       
    52     */
       
    53     HBufC* GetNameL();
       
    54     
       
    55     /*
       
    56      * @description Returns the Indexing status of the content.
       
    57      * @return the Indexing status of the content
       
    58      */
       
    59     TInt GetIndexStatus();
       
    60     
       
    61     /*
       
    62      * @description Returns the Blacklist status of the content.
       
    63      * @return ETrue if the plugin is blacklisted else returns EFalse
       
    64      */
       
    65     TBool GetBlacklistStatus();
       
    66     
       
    67     /*
       
    68      * @description Sets the name of the content.
       
    69      * @Param aName is the name of the content
       
    70      * Leaves in case of errors.
       
    71      */
       
    72     void SetNameL( const TDesC& aName );
       
    73     
       
    74     /*
       
    75      * @description Sets the Indexing status of the content.
       
    76      * @Param aIndexStatus is the Indexing status of the content
       
    77      */
       
    78     void SetIndexStatus( const TInt aIndexStatus );
       
    79     
       
    80     /*
       
    81      * @description Sets the Blacklisting status of the content.
       
    82      * @Param aBlacklistStatus is the Blacklisting status of the content
       
    83      */
       
    84     void SetBlacklistStatus( const TBool aBlacklistStatus );
       
    85        
       
    86 private:    
       
    87     /*
       
    88      * Name of the content.owned
       
    89      */
       
    90     HBufC* iContentName;
       
    91     /*
       
    92      * Indexing status
       
    93      */
       
    94     TInt iIndexStatus;
       
    95     /**
       
    96      * Blacklist status
       
    97      */
       
    98     TBool iBlacklistStatus;
       
    99     };
       
   100 
       
   101 #endif /* CCONTENTINFO_H_ */