uiservicetab/vimpststorage/tsrc/vimpststorage_ut/stubs/s_cVPbkBaseContactFieldCollection.h
changeset 0 5e5d6b214f4f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/uiservicetab/vimpststorage/tsrc/vimpststorage_ut/stubs/s_cVPbkBaseContactFieldCollection.h	Tue Feb 02 10:12:18 2010 +0200
@@ -0,0 +1,143 @@
+/*
+* Copyright (c) 2004-2007 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:  
+:                
+*
+*/
+
+
+
+#ifndef SCVPBKBASECONTACTFIELDCOLLECTION_H
+#define SCVPBKBASECONTACTFIELDCOLLECTION_H
+
+// INCLUDES
+#include <e32base.h>
+#include <MVPbkStoreContactFieldCollection.h>
+
+// FORWARD DECLARATIONS
+
+// CLASS DECLARATIONS
+
+/**
+ * Virtual Phonebook base contact field collection interface.
+ * An abstract collection of read-only Virtual Phonebook contact fields.
+ */
+class CVPbkBaseContactFieldCollectionStub : public CBase,
+					public MVPbkStoreContactFieldCollection
+    {
+    public:  // Destructor
+    	CVPbkBaseContactFieldCollectionStub();
+    	
+        /**
+         * Destructor.
+         */
+        ~CVPbkBaseContactFieldCollectionStub();
+
+    public: // From MVPbkBaseContactFieldCollection (covariant return types))
+         const MVPbkStoreContactField& FieldAt(TInt aIndex) const ;
+
+    public:  // New functions
+        /**
+         * Returns a field in this collection.
+         *
+         * @param aIndex A zero-based index of the field to return.
+         * @return A reference to the field at aIndex. Reference is valid until 
+         *         FieldAt is called again. If you need a permanent copy,
+         *         call MVPbkStoreContactField::CloneLC to the returned
+         *         field.
+         * @see MVPbkStoreContactField::CloneLC
+         * @precond aIndex >= 0 && aIndex < FieldCount()
+         *          VPbkError::Panic(VPbkError::EInvalidFieldIndex) is raised
+         *          if the precondition does not hold.
+         */
+        MVPbkStoreContactField& FieldAt( TInt aIndex ) ;
+
+        /**
+         * Returns a copy of the field in this collection.
+         *
+         * Client gets the ownership of the field.
+         *
+         * @param aIndex A zero-based index of the field to return.
+         * @return  A new instance to the field at aIndex. The field is valid
+         *          as long as the parent contact is valid
+         * @precond aIndex >= 0 && aIndex < FieldCount()
+         *          VPbkError::Panic(VPbkError::EInvalidFieldIndex) is raised
+         *          if the precondition does not hold.
+         */
+        MVPbkStoreContactField* FieldAtLC( TInt aIndex ) const ;
+
+        /**
+         * Returns the parent contact of the field collection
+         *
+         * @return the parent contact of the field collection
+         */
+        MVPbkStoreContact& ParentStoreContact() const ;
+        
+        /**
+         * Returns a field in this collection identified by a contact field 
+         * link.
+         *
+         * A contact field link can be created using the MVPbkStoreContactField
+         * interface. The same link works then as a contact link and 
+         * a field link.
+         *
+         * NOTE: implementations of stores are possibly using an index
+         *       of the field as an identifier so clients should prefer not
+         *       to save field links permanently. E.g modifying the contact
+         *       can invalidate the link in some store implementations.
+         *       A field link is practical in use cases where the link is
+         *       created and immediately given to another component.
+         *
+         * @param aContactLink A valid contact field link.
+         * @return A field in this collection identified by aContactLink or NULL
+         *          if the link does not contain field information or if the 
+         *          link does not refer to the parent contact of this field collection.
+         */
+        MVPbkStoreContactField* RetrieveField(
+            const MVPbkContactLink& aContactLink ) const ;
+        
+        
+        public:  // Interface
+        /**
+         * Returns the parent contact of this field set.
+         * @return The parent contact of this field set.
+         */
+        MVPbkBaseContact& ParentContact() const ;
+
+        /**
+         * Returns the number of fields in this collection.
+         * @return The number of fields in this collection.
+         */
+        TInt FieldCount() const ;
+
+        /**
+         * Returns a read-only field in this collection.
+         *
+         * @param aIndex    Zero-based index of the field to return.
+         * @return  Reference to a field at aIndex. Reference is 
+         *          valid until FieldAt is called again.
+         * @see MVPbkBaseContactFieldCollection::ConstFieldAt
+         * @precond aIndex >= 0 && aIndex < FieldCount()
+         *          Panic VPbkError::EInvalidFieldIndex is raised if the
+         *          precondition does not hold.
+         */
+        //const MVPbkBaseContactField& FieldAt(
+          //      TInt aIndex) const ;
+
+    };
+
+
+#endif  // SCVPBKBASECONTACTFIELDCOLLECTION_H
+
+//End of file