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