williamr@2: /*
williamr@2: * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: 
williamr@2: *       Interface classes for accessing Phonebook contact data.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef __MPbkFieldData_H__
williamr@2: #define __MPbkFieldData_H__
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <cntdef.h>         // TStorageType
williamr@2: #include "PbkFields.hrh"    // TPbkFieldId
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class MPbkFieldData;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2:  * Array of MPbkFieldData objects.
williamr@2:  */
williamr@2: class MPbkFieldDataArray
williamr@2:     {
williamr@2:     public:  // Destructor
williamr@2:         virtual ~MPbkFieldDataArray() {}
williamr@2: 
williamr@2:     public:  // Abstract interface
williamr@2:         /**
williamr@2:          * Returns the number of field data objects in this array.
williamr@2:          * @return The number of field data objects in this array.
williamr@2:          */
williamr@2:         virtual TInt PbkFieldCount() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:          * Returns the field data object at aIndex.
williamr@2:          * @param aIndex    The field to index.
williamr@2:          * @return The field data object at aIndex.
williamr@2:          */
williamr@2:         virtual MPbkFieldData& PbkFieldAt(TInt aIndex) = 0;
williamr@2: 
williamr@2:         /**
williamr@2:          * Returns the const field data object at aIndex.
williamr@2:          * @return The const field data object at aIndex.
williamr@2:          */
williamr@2:         virtual const MPbkFieldData& PbkFieldAt(TInt aIndex) const = 0;
williamr@2:     };
williamr@2: 
williamr@2: /**
williamr@2:  * Phonebook field data abstract interface. The interface is used as an
williamr@2:  * abstraction to handle phonebook contact item field data access. 
williamr@2:  * The Phonebook contact item field abstraction TPbkContactItemField 
williamr@2:  * implements this interface.
williamr@2:  */
williamr@2: class MPbkFieldData
williamr@2:     {
williamr@2:     public:  // Destructor
williamr@2:         /**
williamr@2:          * Destructor.
williamr@2:          */
williamr@2:         virtual ~MPbkFieldData() {}
williamr@2: 
williamr@2:     public:  // Interface
williamr@2:         /**
williamr@2:          * Returns the type of this field data.
williamr@2:          * @return KStrorageTypeText or KStoragetTypeDateTime.
williamr@2:          */
williamr@2:         virtual TStorageType PbkFieldType() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:          * Returns the field id of this field data.
williamr@2:          */
williamr@2:         virtual TPbkFieldId PbkFieldId() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:          * Returns the text value of this field data.
williamr@2:          * @precond PbkFieldType()==KStrorageTypeText.
williamr@2:          */
williamr@2:         virtual TPtrC PbkFieldText() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:          * Returns the Time value of this field data.
williamr@2:          * @precond PbkFieldType()==KStoragetTypeDateTime.
williamr@2:          */
williamr@2:         virtual TTime PbkFieldTime() const = 0;
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: 
williamr@2: #endif // __MPbkFieldData_H__
williamr@2: 
williamr@2: // End of File