uiservicetab/vimpststorage/tsrc/vimpststorage_ut/stubs/s_CVPbkStoreContactField.cpp
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:33:36 +0100
branchRCL_3
changeset 29 9a48e301e94b
parent 0 5e5d6b214f4f
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201033 Kit: 201035

/*
* 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:  
:                
*
*/



// INCLUDES
#include "s_CVPbkStoreContactField.h"
#include <VPbkEng.rsg>
#include "CVPbkContactFieldTextData_stub.h"
#include "s_MVPbkContactFieldUriData_stub.h"
#include "s_MVPbkContactFieldBinaryDatastub.h"

CVPbkContactFieldTextData_stub gTextFieldData;
CVPbkContactFieldUriData_Stub gUriFieldData;
CVPbkContactFieldBinaryDataStub gBinaryFieldData;
CVPbkContactFieldTextData_stub gJunkFieldData;
TBool gBestMatchingFieldType;

// CONSTANTS

//ctor
CVPbkStoreContactFieldStub::CVPbkStoreContactFieldStub( TInt aIndex)
: iIndex(aIndex)
{
	
}
/**
 * Destructor
 */
CVPbkStoreContactFieldStub::~CVPbkStoreContactFieldStub(){ }

const MVPbkContactFieldData& CVPbkStoreContactFieldStub::FieldData() const 
	{ 
	if (iIndex == 0)
		{
		return gTextFieldData;	
		}
	
	if (iIndex == 1)
		{
		return gUriFieldData;	
		}
	
	if (iIndex == 2)
		{
		return gBinaryFieldData;	
		}
	
	return gJunkFieldData; //some junk

	}


/**
 * Returns ETrue if the field supports label. 
 * 
 * Overwrites the global setting in MVPbkContactStoreProperties. 
 * This must be confirmed before using SetFieldLabelL or 
 * MaxLabelLength.
 * 
 * @return ETrue if the field supports label. Otherwise EFalse.
 */
TBool CVPbkStoreContactFieldStub::SupportsLabel() const { return EFalse; }

/**
 * Returns the label of the field or KNullDesC if there is no field 
 * label.
 *
 * @return The label of the field or KNullDesC
 */
TPtrC CVPbkStoreContactFieldStub::FieldLabel() const { return KNullDesC(); }

/**
 * Sets this field's label.
 *
 * SupportsLabel must be true for using this.
 *
 * @param aText The label for the field.
 */
void CVPbkStoreContactFieldStub::SetFieldLabelL( const TDesC& /*aText*/ ) { }

/**
 * Gets the maximum length of the label. 
 *
 * SupportsLabel must be true for using this.
 * 
 * @return The maximum length of the label or KVPbkUnlimitedLabelLength
 *         if the store has no limits. Zero should be returned in other
 *         cases though this shouldn't be called if labels are 
 *         not supported.
 */
TInt CVPbkStoreContactFieldStub::MaxLabelLength() const { return 0; }

/**
 * Returns the data storage (read-write) of the field. 
 *
 * The data type depends on the field and it's client's responsibility
 * to check the type before casting the type.
 *
 * @return The data storage of the field.
 * @see MVPbkContactFieldTextData::Cast
 * @see MVPbkContactFieldDateTimeData::Cast
 * @see MVPbkContactFieldBinaryData::Cast
 */
MVPbkContactFieldData& CVPbkStoreContactFieldStub::FieldData() 
	{
	

	if (iIndex == 0)
		{
		return gTextFieldData;	
		}
	
	if (iIndex == 1)
		{
		return gUriFieldData;	
		}
	
	if (iIndex == 2)
		{
		return gBinaryFieldData;	
		}
	
	return gJunkFieldData; //some junk
	}
	
	
/**
 * Clones the field. 
 * 
 * Pushes the created copy to the cleanup stack.
 *
 * @return A copy of the field.
 * @see MVPbkStoreContactFieldCollection::FieldAt
 */
MVPbkStoreContactField* CVPbkStoreContactFieldStub::CloneLC() const { return NULL; }

/**
 * Creates a link representing the contact and the field.
 *
 * The field can be later retrieved using the RetrieveField of
 * MVPbkStoreContactFieldCollection interface.
 *
 * 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.
 *
 * @return A link representing the contact and the field or NULL
 *         if the contact doesn't exist in the store. E.g a new
 *         contact that hasn't been committed has no unique
 *         identifier yet.
 *         NULL is not put into the CleanupStack.
 */
MVPbkContactLink* CVPbkStoreContactFieldStub::CreateLinkLC() const { return NULL; }


/**
 * Returns the parent contact where this field is from.
 *
 * @return The parent contact where this field is from.
 */
MVPbkBaseContact& CVPbkStoreContactFieldStub::ParentContact() const 
{ 
MVPbkBaseContact* ret=NULL;
return *ret;
}

/**
 * Returns this field's type or NULL if no mapping exists
 * between the native type and phonebook type.
 *
 * @param aMatchPriority    matching priority to use.
 * @return The field type or NULL
 * @postcond !FieldType(list) || list.ContainsSame(*FieldType(list))
 */
const MVPbkFieldType* CVPbkStoreContactFieldStub::MatchFieldType(
        TInt /*aMatchPriority*/) const { return NULL; }

/**
 * Returns the best matching type of the field or NULL 
 * if no mapping exists between the native type and 
 * phonebook type. This is the same as looping 
 * MatchFieldType from priority 0 and getting the first 
 * matched type.
 *
 * @return The field type or NULL
 * @postcond !FieldType(list) || list.ContainsSame(*FieldType(list))
 */
const MVPbkFieldType* CVPbkStoreContactFieldStub::BestMatchingFieldType() const 
	{
	if (gBestMatchingFieldType)
		{
		return this;
		}
	return NULL;
	}



/**
 * Returns true if this field is the same as another field in the
 * contact instance. 
 * Doesn't work for fields from different contact instances.
 * Always use this method instead of direct pointer comparison.
 *
 * @param aOther another field inside the contact
 * @return ETrue if contact is same
 */
TBool CVPbkStoreContactFieldStub::IsSame(const MVPbkBaseContactField& /*aOther*/) const { return EFalse;}


/**
 * Returns the parent object of this object. For the root of the 
 * hierarchy returns self.
 * @return The parent object.
 */
MVPbkObjectHierarchy& CVPbkStoreContactFieldStub::ParentObject() const 
{ 
MVPbkObjectHierarchy* ret =NULL;
return *ret;
}


/**
 * Returns the Versit properties mapped to this field type.
 *
 * @return Versit properties.
 */
TArray<TVPbkFieldVersitProperty> CVPbkStoreContactFieldStub::VersitProperties() const 
{ 

}

/**
 * Returns the Versit parameters fields of this type should not have.
 *
 * @return Excluded parameters.
 */
const TVPbkFieldTypeParameters& CVPbkStoreContactFieldStub::ExcludedParameters() const 
{ 
TVPbkFieldTypeParameters* ret = NULL;
return *ret;
}

/**
 * Type name for field types not supported by the Versit 2.1 standard.
 *
 * @return A non-Versit type.
 */
TVPbkNonVersitFieldType CVPbkStoreContactFieldStub::NonVersitType() const 
{ 
return EVPbkNonVersitTypeNone;
}

/**
 * Returns true if this field type is the same as aOtherType.
 *
 * @param aOtherType The type to compare.
 * @return ETrue if the field types are the same.
 */
TBool CVPbkStoreContactFieldStub::IsSame(
        const MVPbkFieldType& /*aOtherType*/ ) const { return EFalse; }

/**
 * Returns true if this field type matches a Versit property.
 *
 * @param aMatchProperty A versit property to match against.
 * @param aMatchPriority A matching priority. Priorities start
 *                       from zero which is the highest priority.
 *                       Priority is also a direct index to
 *                       VersitProperties() array.
 * @return ETrue if this field type matches aMatchProperty at
 *         aMatchPriority. Returns always false if 
 *         aMatchPriority >= VersitProperties().Count().
 */
TBool CVPbkStoreContactFieldStub::Matches(
        const TVPbkFieldVersitProperty& /*aMatchProperty*/,
        TInt /*aMatchPriority*/ ) const { return EFalse; }

/**
 * Returns the field type resource id from VPbkEng.rsg
 * that be used to identify a type.
 *
 * @return A field type resource id.
 */
TInt CVPbkStoreContactFieldStub::FieldTypeResId() const 
	{ 	

	if (iIndex == 0)
		{
		return R_VPBK_FIELD_TYPE_VOIPHOME;	
		}
	
	if (iIndex == 1)
		{
		return R_VPBK_FIELD_TYPE_IMPP;	
		}
	
	if (iIndex == 2)
		{
		return R_VPBK_FIELD_TYPE_THUMBNAILPIC;	
		}
	
	return R_VPBK_FIELD_TYPE_JOBTITLE; //some junk
	} 
        
// End of file