1 /*

     2 * Copyright (c) 2002 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 *    Declares functions needed to save message.

    16 *

    17 *

    18 */

    19 

    20 

    21 #ifndef __MSaveMessageController_h

    22 #define __MSaveMessageController_h

    23 

    24 //  INCLUDES

    25 #include    <CbsCommon.h>

    26 

    27 

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32 * Helper class for saving message.

    33 */

    34 class MSaveMessageController

    35     {

    36     public: // New functions

    37 

    38         /**

    39         *   Saves a message (the saved message won't be deleted to make 

    40         *   room for new messages).

    41         *

    42         *   Return codes:

    43         *   KErrNone            Message is saved.

    44         *   KErrGeneral         Message not saved -- total maximum of saved 

    45         *                       messages reached.

    46         *   KErrNotFound        Message not saved -- no message associated

    47         *                       with the given handle.

    48         *   KErrDiskFull        Message not saved -- FFS out of space.

    49         *

    50         *   @param  aHandle     Handle to the message to be saved.

    51         *   @return             Return code.

    52         */

    53         virtual TInt SaveMessage( const TCbsMessageHandle& aHandle ) = 0;

    54     };

    55 

    56 #endif // __MSaveMessageController_h

    57 

    58 // END OF FILE