williamr@4: /*
williamr@4: * Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:  An interface for objects that belongs to object hierarchy
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef MVPBKOBJECTHIERARCHY_H
williamr@4: #define MVPBKOBJECTHIERARCHY_H
williamr@4: 
williamr@4: 
williamr@4: // INCLUDES
williamr@4: #include <e32cmn.h>
williamr@4: 
williamr@4: // FORWARD DECLARATIONS
williamr@4: class MVPbkContactStore;
williamr@4: 
williamr@4: 
williamr@4: // CLASS DECLARATIONS
williamr@4: 
williamr@4: /**
williamr@4:  * An interface for objects that belongs to object hierarchy.
williamr@4:  *
williamr@4:  * The interface can be used to get the store from an object that
williamr@4:  * belongs to the hierarchy.
williamr@4:  */
williamr@4: class MVPbkObjectHierarchy
williamr@4:     {
williamr@4:     public:  // Destructor
williamr@4:         virtual ~MVPbkObjectHierarchy() { }
williamr@4: 
williamr@4:     public:  // New functions
williamr@4:         /**
williamr@4:          * Returns the parent object of this object. For the root of the 
williamr@4:          * hierarchy returns self.
williamr@4:          * @return The parent object.
williamr@4:          */
williamr@4:         virtual MVPbkObjectHierarchy& ParentObject() const = 0;
williamr@4: 
williamr@4:         /**
williamr@4:          * Returns the contact store where this object originates from.
williamr@4:          * @return The Contact store.
williamr@4:          */
williamr@4:         virtual MVPbkContactStore& ContactStore() const 
williamr@4:             {
williamr@4:             return ParentObject().ContactStore();
williamr@4:             }
williamr@4: 
williamr@4:         /**
williamr@4:          * Returns an extension point for this interface or NULL.
williamr@4:          *
williamr@4:          * @param aExtensionUid no extensions defined currently.
williamr@4:          * @return An extension point for this interface or NULL.
williamr@4:          */
williamr@4:         virtual TAny* ObjectHierarchyExtension(TUid /*aExtensionUid*/) 
williamr@4:                 { return NULL; }
williamr@4:     };
williamr@4: 
williamr@4: 
williamr@4: #endif  // MVPBKOBJECTHIERARCHY_H
williamr@4: 
williamr@4: //End of file
williamr@4: 
williamr@4: