CContactItem in Application Engines CNTMODEL

class CContactItem : public CBase;

Description

The abstract base class for contact cards, templates and groups. All contact items are identified by a contact ID, (TContactItemId), have a last modified date/time and own one or more fields (the field set). Contact items also have an access count and attributes (e.g. hidden). Note that fields in a contact item also have attributes. Attribute values specified in the contact item override those in the contained fields. The access count is a record of the number of objects referencing a contact item. A contact item cannot be fully deleted until its access count is zero.

Derivation

CBase - Base class for all classes to be instantiated on the heap

CContactItem - The abstract base class for contact cards, templates and groups

Members

Defined in CContactItem:

AccessCount()Gets the contact item's access count
AddFieldL()Appends a field to the contact item's field set
CardFields()Gets a reference to the contact item's field set
DecAccessCount()Decrements the contact item's access count
ECompressedGuidTo set the contact item's hidden attribute
EDeletedTo set the contact item's Is deleted attribute
EHiddenTo set the contact item's hidden attribute
ESystemTo set the contact item's system attribute
ExternalizeL()Externalises a CContactItem object to a write stream
Guid()Accessor function for Contact Guid
Id()Gets the contact item's ID
IncAccessCount()Increments the contact item's access count
InsertFieldL()Inserts a field into the contact item's field set
InternalizeL()Internalises a CContactItem object from a read stream
IsDeletable()Tests whether the contact item is deletable
IsDeleted()Gets the value of the Is deleted attribute as set by SetDeleted()
IsHidden()Gets the value of the contact item's hidden attribute
IsSystem()Gets the value of the contact item's system attribute
LastModified()Gets the contact item's last modified date/time
RemoveField()Removes a field from the contact item's field set
SetDeleted()Sets the value of the contact item's Is deleted attribute
SetHidden()Sets the contact item's hidden attribute
SetLastModified()Sets the last modified date/time value stored in the local copy of the contact item
SetSystem()Sets the contact item's system attribute
SetTemplateRefId()Sets the ID of the template on which this contact item is based
SetUidStringL()Sets the item's UID string
TemplateRefId()Gets the ID of the template which was used to create this contact item
Type()Gets the contact item's type
UidStringL()Returns a descriptor which contains the item's UID string
UpdateFieldSet()Replaces the contact item's field set
anonymousContact item's attribute flags
~CContactItem()The destructor frees all resources owned by the contact item, prior to its destruction

Inherited from CBase:

Delete()Deletes the specified object
Extension_()Extension function
operator new()Initialises the object to binary zeroes

IMPORT_C ~CContactItem();

Description

The destructor frees all resources owned by the contact item, prior to its destruction.

virtual TUid Type() const=0;

Description

Gets the contact item's type.

Return value

TUid

The contact item's type.

IMPORT_C TContactItemId Id() const;

Description

Gets the contact item's ID.

Return value

TContactItemId

The contact item's ID.

IMPORT_C TContactItemId TemplateRefId() const;

Description

Gets the ID of the template which was used to create this contact item.

Return value

TContactItemId

The ID of the template on which this item is based. KNullContactId if the item is not based on a template.

IMPORT_C TTime LastModified() const;

Description

Gets the contact item's last modified date/time.

Return value

TTime

The contact item's last modified date/time.

IMPORT_C void SetLastModified(const TTime &aLastModified);

Description

Sets the last modified date/time value stored in the local copy of the contact item. This value is returned by LastModified() for this copy of the item.

This function has no effect on the item's last modified date/time which is stored in the database; this is always the date/time the contact was last committed.

This function is provided for use when synchronising contact items.

Parameters

const TTime &aLastModified

The contact item's last modified date/time.

IMPORT_C void AddFieldL(CContactItemField &aField);

Description

Appends a field to the contact item's field set. The contact item takes ownership of the field.

Parameters


                                 						CContactItemField &aField

The field to append to the contact item's field set.

IMPORT_C void RemoveField(TInt aFieldPos);

Description

Removes a field from the contact item's field set. A panic occurs if the specified field does not exist in the field set.

Parameters


                                 						TInt aFieldPos

Index within the field set of the field to remove.

IMPORT_C void InsertFieldL(CContactItemField &aField, TInt aFieldPos);

Description

Inserts a field into the contact item's field set. The contact item takes ownership of the field.

Parameters

`CContactItemField &aField`	The field to insert into the contact item's field set.
`TInt aFieldPos`	The position in the field set at which to insert the field. If this value is greater than the total number of fields, it is appended. The position is relative to zero, i.e. zero implies that the element is inserted at the beginning of the array.

IMPORT_C CContactItemFieldSet &CardFields() const;

Description

Gets a reference to the contact item's field set.

Return value

CContactItemFieldSet &

A reference to the contact item's field set.

IMPORT_C void SetHidden(TBool aHidden);

Description

Sets the contact item's hidden attribute. Hidden means that the item is not displayed if the view definition excludes hidden fields.

Parameters


                                 						TBool aHidden

ETrue to set the hidden attribute for the item, EFalse to unset it.

IMPORT_C void SetSystem(TBool aSystem);

Description

Sets the contact item's system attribute. Note that the system attribute is not currently used in the contacts model.

Parameters


                                 						TBool aSystem

ETrue to set the system attribute, EFalse to unset it.

IMPORT_C TBool IsHidden();

Description

Gets the value of the contact item's hidden attribute. Hidden means that the item is not displayed if the view definition excludes hidden fields.

Return value

TBool

ETrue if hidden, EFalse if not.

IMPORT_C TBool IsSystem();

Description

Gets the value of the contact item's system attribute. Note that the system attribute is not currently used in the contacts model.

Return value

TBool

ETrue if system, EFalse if not.

IMPORT_C void UpdateFieldSet(CContactItemFieldSet *aNewFieldSet);

Description

Replaces the contact item's field set.

Parameters


                                 						CContactItemFieldSet *aNewFieldSet

The new field set with which to replace the existing one.

IMPORT_C void SetDeleted(TBool aDeleted);

Description

Sets the value of the contact item's Is deleted attribute.

If the attribute is set, this means that an attempt has been made to delete the contact item, but because the item's access count is greater than zero, its data persists and the item is just marked as deleted.

Parameters


                                 						TBool aDeleted

ETrue to set the Is deleted attribute. EFalse to unset it.

IMPORT_C TBool IsDeleted() const;

Description

Gets the value of the Is deleted attribute as set by SetDeleted().

Return value

TBool

ETrue if deleted, EFalse if not.

IMPORT_C void SetTemplateRefId(TContactItemId aUid);

Description

Sets the ID of the template on which this contact item is based.

Parameters


                                 						TContactItemId aUid

The ID of the template on which this item is based.

inline TBool IsDeletable();

Description

Tests whether the contact item is deletable.

This is true if the item's access count is zero.

Return value


                                 						TBool

ETrue if deletable, EFalse if not deletable.

inline void IncAccessCount();

Description

Increments the contact item's access count.

inline void DecAccessCount();

Description

Decrements the contact item's access count.

inline TInt AccessCount() const;

Description

Gets the contact item's access count.

Return value


                                 						TInt

The item's access count.

IMPORT_C void SetUidStringL(TDesC &aString);

Description

Sets the item's UID string. This replaces any existing string. Contact items have a globally unique identifier, stored as a descriptor which is provided for vCard support. It is a combination of the database's unique identifier (see CContactDatabase::MachineId()), the contact item ID and the date/time of the contact item's creation.

Parameters


                                 						TDesC &aString

The contact item's UID string.

IMPORT_C TPtrC UidStringL(TInt64 aMachineUniqueId) const;

Description

Returns a descriptor which contains the item's UID string. Contact items have a globally unique identifier, stored as a descriptor. This is provided for vCard support. It is a combination of the database's unique identifier, the contact item ID and the date/time of the contact item's creation.

Parameters


                                 						TInt64 aMachineUniqueId

The database's unique identifier. This can be retrieved using CContactDatabase::MachineId().

Return value

TPtrC

The item's UID string.

inline TPtrC Guid();

Description

Accessor function for Contact Guid. This is used to cache contact items that are added during a sync.

Return value


                                 						TPtrC

Guid

virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a CContactItem object to a write stream.

Parameters


                                 						RWriteStream &aStream

Stream to which the object should be externalised.

virtual void InternalizeL(RReadStream &aStream);

Description

Internalises a CContactItem object from a read stream.

Parameters


                                 						RReadStream &aStream

Stream from which the object should be internalised.

n/a

Description

Contact item's attribute flags

These flags can be used to set the various attributes of a contact item.

`ESystem`	To set the contact item's system attribute.
`EHidden`	To set the contact item's hidden attribute.
`ECompressedGuid`	To set the contact item's hidden attribute.
`EDeleted`	To set the contact item's Is deleted attribute.

Class CContactItem

Description

Derivation

Members

Construction and destruction

~CContactItem()

Description

Member functions

Type()

Description

Return value

Id()

Description

Return value

TemplateRefId()

Description

Return value

LastModified()

Description

Return value

SetLastModified()

Description

Parameters

AddFieldL()

Description

Parameters

RemoveField()

Description

Parameters

InsertFieldL()

Description

Parameters

CardFields()

Description

Return value

SetHidden()

Description

Parameters

SetSystem()

Description

Parameters

IsHidden()

Description

Return value

IsSystem()

Description

Return value

UpdateFieldSet()

Description

Parameters

SetDeleted()

Description

Parameters

IsDeleted()

Description

Return value

SetTemplateRefId()

Description

Parameters

IsDeletable()

Description

Return value

IncAccessCount()

Description

DecAccessCount()

Description

AccessCount()

Description

Return value

SetUidStringL()

Description

Parameters

UidStringL()

Description

Parameters

Return value

Guid()

Description

Return value

ExternalizeL()

Class `CContactItem`

`~CContactItem()`

`Type()`

`Id()`

`TemplateRefId()`

`LastModified()`

`SetLastModified()`

`AddFieldL()`

`RemoveField()`

`InsertFieldL()`

`CardFields()`

`SetHidden()`

`SetSystem()`

`IsHidden()`

`IsSystem()`

`UpdateFieldSet()`

`SetDeleted()`

`IsDeleted()`

`SetTemplateRefId()`

`IsDeletable()`

`IncAccessCount()`

`DecAccessCount()`

`AccessCount()`

`SetUidStringL()`

`UidStringL()`

`Guid()`

`ExternalizeL()`

`InternalizeL()`

Enum `anonymous`