ipsservices/ipssosplugin/inc/ipsplgbaseoperation.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Tue, 31 Aug 2010 15:04:17 +0300
branchRCL_3
changeset 24 d189ee25cf9d
parent 8 e1b6206813b4
child 25 3533d4323edc
permissions -rw-r--r--
Revision: 201033 Kit: 201035

/*
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Base operation class
*
*/

#ifndef IPSPLGBASEOPERATION_H
#define IPSPLGBASEOPERATION_H

// <qmail> CFSMailCommon include not needed

class CMsvOperation;

/**
* class CIpsPlgBaseOperation
*
* Common base class for email online operations.
*/
NONSHARABLE_CLASS ( CIpsPlgBaseOperation ) : public CMsvOperation
    {
public:
    virtual ~CIpsPlgBaseOperation();

	// <qmail> ProgressL function has been removed

    /**
    * For reporting if DoRunL leaves
    * All operations must implement this
    */
    virtual const TDesC8& GetErrorProgressL(TInt aError) = 0;

    /**
    * Returns pending asynchronous request status to caller
    * All operations must implement this
    */
    virtual TFSProgress GetFSProgressL() const = 0;

    /**
    * returns request id
    * (given by caller during instantiation)
    * @return request id
    */
	TInt FSRequestId() const;
	
	/**
	* returns mailbox id that this operation is related to
	* (given by caller during instantiation)
	*/
	TFSMailMsgId FSMailboxId() const;

// <qmail>    
    /**
    * All concrete derived classes must have a type identifier
    * @return operation type
    */
    virtual TIpsOpType IpsOpType() const = 0;
// </qmail>
	
protected:

	/**
    * C++ constructor
    */
    // <qmail> priority parameter has been removed
    CIpsPlgBaseOperation(
        CMsvSession& aMsvSession,
        TRequestStatus& aObserverRequestStatus,
        TInt aFSRequestId,
        TFSMailMsgId aFSMailboxId );

//<qmail> DoCancel, RunL, RunError functions have been removed

protected:
    TInt            iFSRequestId;
    TFSMailMsgId    iFSMailboxId;
    };

#endif // IPSPLGBASEOPERATION_H