1 /*

     2 * Copyright (c) 2007-2008 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:  

    15 *

    16 */

    17 

    18 

    19 #ifndef C_NCDREPORT_H

    20 #define C_NCDREPORT_H

    21 

    22 #include <e32base.h>

    23 

    24 #include "catalogshttptypes.h"

    25 #include "ncdreportstatusinfo.h"

    26 #include "ncdattributes.h"

    27 #include "ncdstoragedataitem.h"

    28 #include "catalogsconnectionmethod.h"

    29 

    30 class MCatalogsHttpOperation;

    31 class CNcdNodeIdentifier;

    32 class CNcdReportManager;

    33 class CNcdRequestInstallation;

    34 class CCatalogsAccessPoint;

    35 

    36 class CNcdReport : public CBase, 

    37                    public MNcdStorageDataItem

    38     {

    39 public:

    40 

    41     virtual ~CNcdReport();

    42 

    43 public: // From MNcdStorageDataItem

    44 

    45     virtual void ExternalizeL( RWriteStream& aStream );

    46     virtual void InternalizeL( RReadStream& aStream );

    47 

    48 public: // Common methods

    49 

    50     /**

    51      * @return TNcdReportType Report type getter.

    52      */

    53     const TNcdReportType& ReportType() const;

    54 

    55     /**

    56      * Access point setter

    57      */

    58     virtual void SetAccessPoint( const TCatalogsConnectionMethod& aAp );

    59     

    60     /**

    61      * Access point getter

    62      *

    63      */

    64     virtual const TCatalogsConnectionMethod& ConnectionMethod() const;

    65 

    66 

    67     /**

    68      * Sets the id for the report

    69      *

    70      */

    71     virtual void SetReportId( const TNcdReportId& aReportId );

    72     

    73     

    74     /**

    75      * Report id getter

    76      */

    77     virtual const TNcdReportId& ReportId() const;

    78     

    79 

    80     /** 

    81      * Attribute getter

    82      */

    83     CNcdAttributes& Attributes();

    84     const CNcdAttributes& Attributes() const;

    85                

    86 

    87     /**

    88      * Status getter

    89      */        

    90     virtual const TNcdReportStatusInfo& Status() const;

    91     

    92     /**

    93      * @param aStatus New status

    94      * @return Symbian error code. Default implementation always returns 

    95      * KErrNone

    96      */

    97     virtual TInt SetStatus( const TNcdReportStatusInfo& aStatus );

    98 

    99 

   100     /** 

   101      * Sets a timestimp

   102      */

   103     virtual void SetTimeStamp( 

   104         const TNcdReportTimeStamps& aTimeStamp,

   105         const TTime& aTime );

   106     

   107     /**    

   108      * Timestamp getter

   109      */

   110     virtual const TInt64& TimeStamp( 

   111         const TNcdReportTimeStamps& aTimeStamp ) const;

   112 

   113     /**

   114      * Reset time stamps

   115      */

   116     virtual void ResetTimeStampsL();

   117     

   118     

   119     /**

   120      * Current report transaction getter

   121      *

   122      * @return Current transaction used for sending the report or NULL

   123      */

   124     virtual const MCatalogsHttpOperation* ReportTransaction() const;

   125     

   126     

   127     /**

   128      * Report transaction setter

   129      */

   130     virtual void SetReportTransaction(         

   131         MCatalogsHttpOperation* aTransaction );

   132     

   133     

   134     /**

   135      * Metadata id 

   136      */    

   137     virtual const CNcdNodeIdentifier& MetadataId() const; 

   138 

   139 

   140     /**

   141      * Compares this report to given parameters and returns true

   142      * if they match

   143      */

   144     virtual TBool Match( 

   145         const CNcdNodeIdentifier& aMetadataId,

   146         const TDesC& aGenericId,

   147         const TDesC& aReportUri,

   148         const TNcdReportType& aReportType ) const;

   149     

   150     /**

   151      * Compares two reports

   152      */

   153     static TInt Compare( 

   154         const CNcdReport& aFirst,

   155         const CNcdReport& aSecond );

   156     

   157 

   158     /**

   159      * Sets current time to the timestamp pointed by aTime

   160      */

   161     void SetCurrentTime( const TNcdReportTimeStamps& aTime );

   162     

   163     

   164     /**

   165      * Calculates the time between start and end timestamps. The result

   166      * is in seconds

   167      */

   168     TInt DurationInSecondsL( 

   169         const TNcdReportTimeStamps& aStart,

   170         const TNcdReportTimeStamps& aEnd ) const;

   171     

   172 

   173     /**

   174      * Reports should return ETrue if they can be bundled with other 

   175      * reports. Default implementation returns EFalse

   176      */

   177     virtual TBool CanBundle() const;    

   178     

   179     /** 

   180      * Used to add report data to a bundle

   181      * Default implementation leaves with KErrNotSupported

   182      */

   183     virtual void AddReportDataL( CNcdRequestInstallation& aRequest ) const;

   184 

   185 public: // Must be implemented by child classes

   186 

   187     virtual TBool IsSendable() const = 0;

   188     

   189     /**

   190      * Return true when the report can be removed

   191      */

   192     virtual TBool CanBeRemoved() const = 0;

   193     

   194     virtual HBufC8* CreateReportL() const = 0;

   195     

   196     virtual void UpdateTransactionConfigL( 

   197         MCatalogsHttpOperation& aTransaction ) = 0;

   198     

   199     /**

   200      * @return ETrue if the status cannot change anymore

   201      */

   202     virtual TBool StatusIsFinal() const = 0;

   203 

   204 protected:    

   205 

   206     CNcdReport( 

   207         TNcdReportType aType, 

   208         CNcdReportManager& aReportManager,

   209         const TNcdReportStatusInfo& aStatus );

   210         

   211     void BaseConstructL( const CNcdNodeIdentifier& aMetadataId );

   212 

   213     const CNcdReportManager& ReportManager() const;

   214     

   215     CNcdReportManager& ReportManager();

   216 

   217 

   218 private:

   219 

   220     CNcdReport( const CNcdReport& );

   221     CNcdReport& operator=( const CNcdReport& );    

   222     

   223 

   224 private:

   225 

   226     TNcdReportType iType;

   227     CNcdReportManager& iReportManager;    

   228     TNcdReportStatusInfo iStatus;	

   229     

   230     TCatalogsConnectionMethod iAccessPoint;

   231     RArray<TInt64> iTimeStamps;

   232     MCatalogsHttpOperation* iReportTransaction;

   233     CNcdAttributes* iAttributes; 

   234     CNcdNodeIdentifier* iMetadataId;   

   235     TNcdReportId iReportId;

   236     };

   237 

   238 #endif // C_NCDREPORT_H