epoc32/include/msvscheduledentry.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
/// All rights reserved.
williamr@2
     3
/// This component and the accompanying materials are made available
williamr@2
     4
/// 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
     5
/// which accompanies this distribution, and is available
williamr@2
     6
/// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
///
williamr@2
     8
/// Initial Contributors:
williamr@2
     9
/// Nokia Corporation - initial contribution.
williamr@2
    10
///
williamr@2
    11
/// Contributors:
williamr@2
    12
///
williamr@2
    13
/// Description:
williamr@2
    14
/// All rights reserved.
williamr@2
    15
/// This component and the accompanying materials are made available
williamr@2
    16
/// 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
    17
/// which accompanies this distribution, and is available
williamr@2
    18
/// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
    19
/// Initial Contributors:
williamr@2
    20
/// Nokia Corporation - initial contribution.
williamr@2
    21
/// Contributors:
williamr@2
    22
///
williamr@2
    23
williamr@2
    24
williamr@2
    25
williamr@2
    26
/**
williamr@2
    27
 
williamr@2
    28
 
williamr@2
    29
 
williamr@2
    30
 Gets the entry's ID.
williamr@2
    31
 
williamr@2
    32
 @return The entry's ID.
williamr@2
    33
*/
williamr@2
    34
williamr@2
    35
inline const TMsvId CMsvScheduledEntry::Id() const
williamr@2
    36
	{
williamr@2
    37
	return iEntry.Id();
williamr@2
    38
	}
williamr@2
    39
williamr@2
    40
williamr@2
    41
/**
williamr@2
    42
Gets the entry's OffPeak() flag.
williamr@2
    43
williamr@2
    44
@return The entry's OffPeak() flag.
williamr@2
    45
*/
williamr@2
    46
williamr@2
    47
inline const TBool CMsvScheduledEntry::OffPeak() const
williamr@2
    48
	{
williamr@2
    49
	return iEntry.OffPeak();
williamr@2
    50
	}
williamr@2
    51
williamr@2
    52
williamr@2
    53
/**
williamr@2
    54
Gets the entry's iMtm data member.
williamr@2
    55
williamr@2
    56
@return The entry's iMtm data member.
williamr@2
    57
*/
williamr@2
    58
williamr@2
    59
inline const TUid CMsvScheduledEntry::Mtm() const
williamr@2
    60
	{
williamr@2
    61
	return iEntry.iMtm;
williamr@2
    62
	}
williamr@2
    63
williamr@2
    64
williamr@2
    65
/**
williamr@2
    66
Gets the entry's iDate member.
williamr@2
    67
williamr@2
    68
@return Entry's iDate member.
williamr@2
    69
*/
williamr@2
    70
williamr@2
    71
inline const TTime& CMsvScheduledEntry::ScheduleDate() const
williamr@2
    72
	{
williamr@2
    73
	return iEntry.iDate;
williamr@2
    74
	}
williamr@2
    75
williamr@2
    76
williamr@2
    77
/**
williamr@2
    78
Sets the entry's iDate member.
williamr@2
    79
williamr@2
    80
@param aDate Entry's iDate member.
williamr@2
    81
*/
williamr@2
    82
williamr@2
    83
inline void CMsvScheduledEntry::SetScheduleDate(const TTime& aDate)
williamr@2
    84
	{
williamr@2
    85
	iEntry.iDate = aDate;
williamr@2
    86
	}
williamr@2
    87
williamr@2
    88
williamr@2
    89
/**
williamr@2
    90
Gets the entry's Scheduled() flag.
williamr@2
    91
williamr@2
    92
@return The entry's Scheduled() flag.
williamr@2
    93
*/
williamr@2
    94
williamr@2
    95
inline const TBool CMsvScheduledEntry::Scheduled() const
williamr@2
    96
	{
williamr@2
    97
	return iEntry.Scheduled();
williamr@2
    98
	}
williamr@2
    99
williamr@2
   100
williamr@2
   101
/**
williamr@2
   102
Sets the entry's Scheduled() flag.
williamr@2
   103
williamr@2
   104
@param aScheduled The entry's Scheduled() flag.
williamr@2
   105
*/
williamr@2
   106
williamr@2
   107
inline void CMsvScheduledEntry::SetScheduled(const TBool aScheduled)
williamr@2
   108
	{
williamr@2
   109
	iEntry.SetScheduled(aScheduled);
williamr@2
   110
	}
williamr@2
   111
williamr@2
   112
williamr@2
   113
/**
williamr@2
   114
Gets the entry's iError data member.
williamr@2
   115
williamr@2
   116
@return The entry's iError data member.
williamr@2
   117
*/
williamr@2
   118
williamr@2
   119
inline const TInt CMsvScheduledEntry::Error() const
williamr@2
   120
	{
williamr@2
   121
	return iEntry.iError;
williamr@2
   122
	}
williamr@2
   123
williamr@2
   124
williamr@2
   125
/**
williamr@2
   126
Gets the entry's SendingState() flag.
williamr@2
   127
williamr@2
   128
@return The entry's SendingState() flag.
williamr@2
   129
*/
williamr@2
   130
williamr@2
   131
inline const TInt CMsvScheduledEntry::SendingState() const
williamr@2
   132
	{
williamr@2
   133
	return iEntry.SendingState();
williamr@2
   134
	}
williamr@2
   135
williamr@2
   136
williamr@2
   137
/**
williamr@2
   138
Sets the entry's SendingState() flag.
williamr@2
   139
williamr@2
   140
@param aState
williamr@2
   141
The entry's SendingState() flag.
williamr@2
   142
*/
williamr@2
   143
williamr@2
   144
inline void CMsvScheduledEntry::SetSendingState(TInt aState)
williamr@2
   145
	{
williamr@2
   146
	iEntry.SetSendingState(aState);
williamr@2
   147
	}
williamr@2
   148
williamr@2
   149
williamr@2
   150
/**
williamr@2
   151
Sets the entry's Failed() flag.
williamr@2
   152
williamr@2
   153
@param aFail
williamr@2
   154
The entry's Failed() flag.
williamr@2
   155
*/
williamr@2
   156
williamr@2
   157
inline void CMsvScheduledEntry::SetFailed(const TBool aFail)
williamr@2
   158
	{
williamr@2
   159
	iEntry.SetFailed(aFail);
williamr@2
   160
	}
williamr@2
   161
williamr@2
   162
williamr@2
   163
/**
williamr@2
   164
Gets the entry's Failed() flag.
williamr@2
   165
williamr@2
   166
@return The entry's Failed() flag.
williamr@2
   167
*/
williamr@2
   168
williamr@2
   169
inline const TBool CMsvScheduledEntry::Failed() const
williamr@2
   170
	{
williamr@2
   171
	return iEntry.Failed();
williamr@2
   172
	}