pressrv_plat/xdm_protocol_plugin_api/inc/XdmOperationFactory.h
changeset 0 c8caa15ef882
equal deleted inserted replaced
-1:000000000000 0:c8caa15ef882
       
     1 /*
       
     2 * Copyright (c) 2005 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:   XDM Protocol operation factory
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __XDMOPERATIONFACTORY__
       
    22 #define __XDMOPERATIONFACTORY__
       
    23 
       
    24 #include <ecom.h>
       
    25 #include <e32base.h>
       
    26 #include "XdmProtocol.h"
       
    27 
       
    28 //Operation factory UIDs
       
    29 const TInt KXcapOperationFactory            = 0x10207426; 
       
    30 const TInt KLocalOperationFactory           = 0x10275088;
       
    31 
       
    32 
       
    33 //FORWARD DECLARATION
       
    34 class CXdmDocument;
       
    35 class MXdmOperation;
       
    36 class CXdmDocumentNode;
       
    37 
       
    38 //CLASS DECLARATION
       
    39 class CXdmOperationFactory : public CBase
       
    40     {
       
    41     public:
       
    42         
       
    43         /**
       
    44         * Symbian OS constructor
       
    45         * @param TInt UID of the operation factory
       
    46         * @return CXdmOperationFactory*
       
    47         */
       
    48         static CXdmOperationFactory* NewL( TInt aOperationFactory );
       
    49         
       
    50         /**
       
    51         * C++ destructor.
       
    52         */
       
    53 	    virtual ~CXdmOperationFactory();
       
    54 	
       
    55 	public:
       
    56         
       
    57         /**
       
    58         * Create a fetch operation
       
    59         *
       
    60         * @param CXdmDocument& Target document
       
    61         * @param CXdmDocumentNode& Target element
       
    62         * @return MXdmOperation* The new operation
       
    63         */
       
    64         virtual MXdmOperation* FetchL( CXdmDocument& aTargetDocument,
       
    65                                        CXdmDocumentNode* aTargetNode ) const = 0;
       
    66 
       
    67         /**
       
    68         * Create an insert operation
       
    69         *
       
    70         * @param CXdmDocument& Target document
       
    71         * @param CXdmDocumentNode& Target element
       
    72         * @return MXdmOperation* The new operation
       
    73         */
       
    74         virtual MXdmOperation* InsertL( CXdmDocument& aTargetDocument,
       
    75                                         CXdmDocumentNode* aTargetNode ) const = 0;
       
    76         
       
    77         /**
       
    78         * Create a replace operation
       
    79         *
       
    80         * @param CXdmDocument& Target document
       
    81         * @param CXdmDocumentNode& New element
       
    82         * @param CXdmDocumentNode& Old element
       
    83         * @return MXdmOperation* The new operation
       
    84         */
       
    85         virtual MXdmOperation* ReplaceL( CXdmDocument& aOldDocument, 
       
    86                                          CXdmDocumentNode* aNewNode,
       
    87                                          CXdmDocumentNode* aOldNode ) const = 0;
       
    88 
       
    89         /**
       
    90         * Create an append operation
       
    91         *
       
    92         * @param CXdmDocument& Target document
       
    93         * @param CXdmDocumentNode& Target element
       
    94         * @return MXdmOperation* The new operation
       
    95         */
       
    96         virtual MXdmOperation* AppendL( CXdmDocument& aTargetDocument,
       
    97                                         CXdmDocumentNode* aTargetNode ) const = 0;
       
    98 
       
    99         /**
       
   100         * Create a delete operation
       
   101         *
       
   102         * @param CXdmDocument& Target document
       
   103         * @param CXdmDocumentNode& Target element
       
   104         * @return MXdmOperation* The new operation
       
   105         */
       
   106         virtual MXdmOperation* DeletionL( CXdmDocument& aTargetDocument,
       
   107                                           CXdmDocumentNode* aTargetNode ) const = 0;
       
   108     
       
   109     protected:
       
   110 
       
   111         /**
       
   112         * Symbian OS constructor for derived classes.
       
   113         *
       
   114         * @return CXdmOperationFactory
       
   115         */      
       
   116         CXdmOperationFactory();
       
   117 
       
   118     private:  //Data
       
   119 
       
   120         TUid                        iDestructorKey;
       
   121     };
       
   122 
       
   123 // ----------------------------------------------------
       
   124 // MXcapOperationFactory::MXcapOperationFactory
       
   125 // 
       
   126 // ----------------------------------------------------
       
   127 //
       
   128 inline CXdmOperationFactory::CXdmOperationFactory()
       
   129 	{
       
   130 	}
       
   131 
       
   132 // ----------------------------------------------------
       
   133 // CXdmProtocol::~CXcapOperationFactory
       
   134 // 
       
   135 // ----------------------------------------------------
       
   136 //
       
   137 inline CXdmOperationFactory::~CXdmOperationFactory()
       
   138 	{
       
   139 	REComSession::DestroyedImplementation( iDestructorKey );
       
   140     }
       
   141 
       
   142 // ----------------------------------------------------
       
   143 // CXdmProtocol::NewL
       
   144 // Create a new operation factory
       
   145 // ----------------------------------------------------
       
   146 //
       
   147 inline CXdmOperationFactory* CXdmOperationFactory::NewL( TInt aOperationFactory )
       
   148     {
       
   149     TAny* ptr = NULL;
       
   150     TUid KImplemantationUid = { aOperationFactory };
       
   151     ptr = REComSession::CreateImplementationL( 
       
   152           KImplemantationUid, _FOFF( CXdmOperationFactory, iDestructorKey ) ); 
       
   153     return reinterpret_cast<CXdmOperationFactory*>( ptr );
       
   154     
       
   155     
       
   156     }
       
   157     
       
   158 #endif      //__XCAPOPERATIONFACTORY__
       
   159 
       
   160