// Copyright (c) 2005-2009 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:

//

#include "calentryimpl.h"

#include "agmentry.h"

#include  <e32math.h>

/** Allocates and constructs a new entry of the specified type, Global UID

and sequence number.

The entry's data is all initialised to default values, e.g.

the start and end dates are reset to null.

The entry takes ownership of the Uid descriptor.

Note that this function will not work unless a CCalSession has been created

by calling CCalSession::NewL().

@param aType One of: EAppt, ETodo, EEvent, EReminder, EAnniv to create

an appointment, a todo, an event, a reminder or an anniversary entry.

@param aUid The Global UID of the entry. This field is mandatory. NewL takes ownership of the global UID.

@param aMethod The Method value describing the entry. Default value is EGSMethodNone.

@param aSeqNum The sequence number of the entry. Default value is 0.

@return Pointer to the new entry.

@capability None

@publishedAll

@released

*/

EXPORT_C CCalEntry* CCalEntry::NewL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum)

	{

	CCalEntry* entry = new (ELeave) CCalEntry();

	CleanupStack::PushL(entry);

	entry->ConstructL(aType, aUid, aMethod, aSeqNum);

	CleanupStack::Pop(entry);

	return entry;

	}

/** Allocates and constructs a new entry of the specified type, Global UID,

sequence number and recurrence ID.

The entry takes ownership of the Uid descriptor.

@param aType One of: EAppt, ETodo, EEvent, EReminder, EAnniv to create

an appointment, a todo, an event, a reminder or an anniversary entry.

@param aUid The Global UID of the entry. This field is mandatory. NewL takes ownership of the global UID.

@param aMethod The Method value describing the entry.

@param aSeqNum The sequence number of the entry.

@param aRecurrenceId The recurrence ID of the entry.

@param aRange The recurrence ID range of the entry.

@return Pointer to the new entry.

@leave KErrArgument If the UID passed is invalid

@panic CalInterimAPI 8 If the entry type passed is invalid

@capability None

@publishedAll

@released

 */

EXPORT_C CCalEntry* CCalEntry::NewL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum,

									const TCalTime& aRecurrenceId, CalCommon::TRecurrenceRange aRange)

	{

	CCalEntry* entry = new (ELeave) CCalEntry();

	CleanupStack::PushL(entry);

	entry->ConstructL(aType, aUid, aMethod, aSeqNum, aRecurrenceId, aRange);

	CleanupStack::Pop(entry);

	return entry;

	}

// Takes ownership of the implementation class

CCalEntry* CCalEntry::NewL(CCalEntryImpl* aImpl)

	{

	CCalEntry* entry = new (ELeave) CCalEntry();

	CleanupStack::PushL(entry);

	entry->ConstructL(aImpl);

	CleanupStack::Pop(entry);

	return entry;

	}

void CCalEntry::ConstructL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum)

	{

	iImpl = CCalEntryImpl::NewL(aType, aUid, aMethod, aSeqNum);

	}

void CCalEntry::ConstructL(TType aType, HBufC8* aUid, TMethod aMethod, TUint aSeqNum, const TCalTime& aRecurrenceId, CalCommon::TRecurrenceRange aRange)

	{

	iImpl = CCalEntryImpl::NewL(aType, aUid, aMethod, aSeqNum, aRecurrenceId, aRange);

	}

void CCalEntry::ConstructL(CCalEntryImpl* aImpl)

	{

	iImpl = aImpl;

	}

CCalEntryImpl* CCalEntry::Impl() const

	{

	return iImpl;

	}

/** The destructor frees all resources owned by the entry, prior to its destruction.

@publishedAll

@released

@capability None

 */

EXPORT_C CCalEntry::~CCalEntry()

	{

	delete iImpl;

	}

/** Compares another entry for equality with this one.

@param aEntry Pointer to an entry.

@return ETrue if aEntry is the same as this entry, EFalse if not.

@publishedAll

@released

@capability None

 */

EXPORT_C TBool CCalEntry::CompareL(const CCalEntry& aEntry) const

	{

	return iImpl->CompareL(aEntry);

	}

/** Copies the contents of another entry to this one.

All entry fields will be overwritten, including the UID and the local UID. This is identical to calling CopyFromL(aOther, ECopyAll).

Please note that this function cannot be called under the following conditions:

- if a file attachment has been added to this entry by its file handle, AND

- if that entry has not been stored in the calendar store yet.

 @param aOther Reference to source entry.

 @panic CalInterimAPI 7 If the entry type is invalid

 @publishedAll

 @released

 @capability None

  */

EXPORT_C void CCalEntry::CopyFromL(const CCalEntry& aOther)

	{

	iImpl->CopyFromL(*aOther.iImpl, ECopyAll);

	}

/** Copies the contents of another entry to this one.

The entry fields that are copied can be specified using the TCopyType parameter.

@param aOther Reference to source entry.

@param aCopyType Which entry details are to be copied.

 ECopyAll if original entry and new entry should be identical. This is identical to calling CopyFromL(aOther).

 EDontCopyId if UID and local UID should not be copied, this should be used when creating a modifying entry.

@panic CalInterimAPI 7 If the entry type is invalid

@publishedAll

@released

@capability None

 */

EXPORT_C void CCalEntry::CopyFromL(const CCalEntry& aOther, TCopyType aCopyType)

 	{

	iImpl->CopyFromL(*aOther.iImpl, aCopyType);

 	}

/** Set the alarm for the entry.

This doesn't take ownership of the parameter.

This function will leave with KErrNotSupported if the alarm is not on same day.

@param aAlarm Pointer to the alarm, or NULL if the alarm is to be cleared.

@leave KErrNotSupported if the alarm offset is less than KCalAlarmMinValidOffset.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetAlarmL(CCalAlarm* aAlarm)

	{

	iImpl->SetAlarmL(aAlarm);

	}

/** Creates an alarm class containing data for this entry's alarm.

@return Pointer to a new alarm object, or NULL if this entry doesn't have one. Returns ownership.

@publishedAll

@released

@capability None

*/

EXPORT_C CCalAlarm* CCalEntry::AlarmL() const

	{

	return iImpl->AlarmL();

	}

/** Sets the entry's repeat definition.

The repeat definition includes daily, weekly, monthly and yearly repeat

details, and start and end details.

If the start time of the entry is different from the start time of the 

repeat rule, the entry's start time will be used.

Also, the start time of the entry may be adjusted if it does not match an 

instance of the repeat rule.

This does not take ownership of the parameter.

@leave KErrNotSupported If the repeat rule passed is not one that is currently supported

@leave KErrArgument if this is a todo entry and its end date has not been set or this is a non-todo entry and its start date has not been set.

@leave KErrArgument if the until date of the repeat definition is non-NULL and is earlier than the start date.

@param aRpt The new repeat definition.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetRRuleL(const TCalRRule& aRpt)

	{

	return iImpl->SetRRuleL(aRpt);

	}

/** Get the entry's repeat rule.

In the returned TCalRRule, both the Count and the Until values can be accessed. However, in

the case of a repeat rule which repeats forever, the Count will always be returned as 0.

@param aRule On return contains the entry's repeat rule data, if present.

@return ETrue if the entry has a repeat rule, EFalse if not.

@publishedAll

@released

@capability None

*/

EXPORT_C TBool CCalEntry::GetRRuleL(TCalRRule& aRule) const

	{

	return Impl()->GetRRuleL(aRule);

	}

/** Clears the repeat details including exceptions and unsets the entry's 'is repeating'

property.

@capability None

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::ClearRepeatingPropertiesL()

	{

	iImpl->ClearRepeatingPropertiesL();

	}

/**

Gets the last modified date/time for this entry.

The last modified date of an entry is updated when:

- an entry is created using CCalEntry::NewL()

- an entry is updated in the calendar store using CCalEntryView::UpdateL()

- an existing entry is updated in the calendar store using CCalEntryView::StoreL()

- the client calls CCalEntry::SetLastModifiedDateL() on the entry

- the time zone rules (if any) associated with the entry are updated

@return The time at which the entry was last modified.

@publishedAll

@released

*/

EXPORT_C TCalTime CCalEntry::LastModifiedDateL() const

	{

	return iImpl->LastModifiedDateL();

	}

/** Gets the entry's DTSTAMP.

@return The DTSTAMP of the entry.

@publishedAll

@released

*/

EXPORT_C TCalTime CCalEntry::DTStampL() const

	{

	return iImpl->DTStampL();

	}

/** Sets the contents of the entry's location field.

@param aLocation Descriptor containing a location, e.g. for a meeting.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetLocationL(const TDesC& aLocation)

	{

	iImpl->SetLocationL(aLocation);

	}

/** Gets the contents of the entry's location field.

@return The location field.

@publishedAll

@released

@capability None

*/

EXPORT_C const TDesC& CCalEntry::LocationL() const

	{

	return iImpl->LocationL();

	}

/** Gets a list of the entry's categories.

@return An array of categories.

@publishedAll

@released

@capability None

*/

EXPORT_C const RPointerArray<CCalCategory>& CCalEntry::CategoryListL()

	{

	return iImpl->CategoryListL();

	}

/** Appends a category to the entry's list of categories.

The entry takes ownership of the category specified.

@param aCategory The category to be added. This function takes ownership of the CCalCategory immediately so it should not be 

put on the cleanup stack before calling this function.

@leave KErrArgument if aCategory is NULL.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::AddCategoryL(CCalCategory* aCategory)

	{

	iImpl->AddCategoryL(aCategory);

	}

/** Deletes a category from the entry's list of categories.

@param aIndex The category to be deleted.

@leave KErrArgument If the index is out of range. Check CCalEntry::CategoryListL first to find out the range of allowed indexes.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::DeleteCategoryL(TInt aIndex)

	{

	iImpl->DeleteCategoryL(aIndex);

	}

/** Sets the priority for the entry.

The default value is zero.

@param aPriority Priority value between 0 and 255. The behaviour is undefined if the priority is greater than 255.

@leave KErrArgument if the priority value is not between 0 and 255.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetPriorityL(TUint aPriority)

	{

	__ASSERT_ALWAYS(aPriority <= 255, User::Leave(KErrArgument));

	iImpl->SetPriorityL(aPriority);

	}

/** Gets the priority of the entry.

@return Priority value between 0 and 255.

@publishedAll

@released

@capability None

*/

EXPORT_C TUint CCalEntry::PriorityL() const

	{

	return iImpl->PriorityL();

	}

/** Gets the start date/time for an entry.

@return The entry's start date/time.

@publishedAll

@released

@capability None

*/

EXPORT_C TCalTime CCalEntry::StartTimeL() const

	{

	return iImpl->StartTimeL();

	}

/** Gets the entry's end date/time.

@return The entry's end date/time.

@publishedAll

@released

@capability None

*/

EXPORT_C TCalTime CCalEntry::EndTimeL() const

	{

	return iImpl->EndTimeL();

	}

/** Sets the start and end date/times for an entry.

For an appointment, event or anniversary, the start time must be earlier than or equal to the end time.

For a reminder, the end time will be ignored.

For a todo entry, the end time is the 'due date'. If the end time is Time::NullTTime in a todo, then

the todo is undated - in this case both start and end date are set to Time::NullTTime. 

Only todos can be undated.

@param aStartDateTime The entry's new start date/time.

@param aEndDateTime The entry's new end date/time.

@leave KErrArgument If the start and end times are invalid.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetStartAndEndTimeL(const TCalTime& aStartDateTime, const TCalTime& aEndDateTime)

	{

	iImpl->SetStartAndEndTimeL(aStartDateTime, aEndDateTime);

	}

/** Gets a to-do entry's completed date.

This is the date on which the required action was carried out.

If the entry has not been crossed out, or if this is not a to-do entry, then

this function returns a null value.

@return The to-do entry's crossed out date.

@publishedAll

@released

@capability None

*/

EXPORT_C TCalTime CCalEntry::CompletedTimeL() const

	{

	return iImpl->CompletedTimeL();

	}

/** Sets the crossed out date for a to-do entry.

This is the date on which the required action was carried out.

If this function is called on an entry which is not a to-do, it will leave

with KErrNotSupported.

@param aCompleted ETrue if the to-do entry is complete - the entry's status is

set to ETodoCompleted; EFalse if the to-do entry is not complete - the entry's status is

set to ETodoNeedsAction

@param aDate The to-do entry's crossed out date. The time mode should not be

floating, it will leave with KErrArgument if it is.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetCompletedL(TBool aCompleted, const TCalTime& aDate)

	{

	// It doesn't make sense for the completed time to be floating.

	if (aDate.TimeMode() == TCalTime::EFloating)

	    {

	    User::Leave( KErrArgument );

	    }

	iImpl->SetCompletedL(aCompleted, aDate);

	}

/** Sets the summary text for this entry.

@param aSummary The summary text.

@leave KErrNotFound If a handle to the entry's summary could not be obtained

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetSummaryL(const TDesC& aSummary)

	{

	iImpl->SetSummaryL(aSummary);

	}

/** Gets the summary for the entry.

@return Descriptor pointer to the summary text.

@leave KErrNotFound If a handle to the entry's summary could not be obtained

@publishedAll

@released

@capability None

*/

EXPORT_C const TDesC& CCalEntry::SummaryL() const

	{

	return iImpl->SummaryL();

	}

/** Sets the description text for this entry.

@param aDescription The summary text.

@publishedAll

@released

@capability None

*/

EXPORT_C void CCalEntry::SetDescriptionL(const TDesC& aDescription)

	{

	iImpl->SetDescriptionL(aDescription);

	}

/** Gets the description text for the entry.

@return Descriptor pointer to the description text.

@publishedAll

@released

*/

EXPORT_C const TDesC& CCalEntry::DescriptionL() const

	{

	return iImpl->DescriptionL();

	}

/** Gets the type of entry.

@return The entry type. One of: EAppt, ETodo, EEvent, EReminder, EAnniv.

@publishedAll

@released

@capability None

*/

EXPORT_C CCalEntry::TType CCalEntry::EntryTypeL() const

	{

	return iImpl->EntryTypeL();

	}

/** Sets the entry status.