commonappservices/alarmserver/Server/Include/ASSrvIteratorBySessionId.h
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     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 "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __ASSRVITERATORBYSESSIONID_H__
       
    17 #define __ASSRVITERATORBYSESSIONID_H__
       
    18 
       
    19 // System includes
       
    20 #include <e32base.h>
       
    21 
       
    22 // User includes
       
    23 #include <asshddefs.h>
       
    24 #include "ASSrvDefs.h"
       
    25 #include "ASSrvIteratorBase.h"
       
    26 
       
    27 // Classes referenced
       
    28 class CASSrvAlarmQueue;
       
    29 
       
    30 
       
    31 //
       
    32 // ----> RASSrvIteratorBySessionId (header)
       
    33 //
       
    34 /**
       
    35  * Locate alarms by their session identifier.
       
    36  */
       
    37 class RASSrvIteratorBySessionId : public RASSrvIteratorBase
       
    38 	{
       
    39 //
       
    40 public:										// CONSTRUCT
       
    41 //
       
    42 
       
    43 	/**
       
    44 	 * Constructor
       
    45 	 * 
       
    46 	 * @param aQueue The alarm queue
       
    47 	 * @param aId The session id of alarms to locate
       
    48 	 */
       
    49 	RASSrvIteratorBySessionId(CASSrvAlarmQueue& aQueue, TASSrvSessionId aId);
       
    50 
       
    51 //
       
    52 public:										// ACCESS
       
    53 //
       
    54 	
       
    55 	/**
       
    56 	 * Change the category for this iterator. Resets the iterator back to the start
       
    57 	 * of the queue.
       
    58 	 */
       
    59 	void									SetSessionId(TASSrvSessionId aId);
       
    60 
       
    61 //
       
    62 private:									// FROM RASSrvIteratorBase
       
    63 //
       
    64 
       
    65 	/**
       
    66 	 * @see RASSrvIteratorBase
       
    67 	 */
       
    68 	TBool									Matches(const TASSrvAlarm& aAlarm) const;
       
    69 
       
    70 //
       
    71 private:									// MEMBER DATA
       
    72 //
       
    73 
       
    74 	/**
       
    75 	 * The session id we're matching against
       
    76 	 */
       
    77 	TASSrvSessionId							iSessionId;
       
    78 	};
       
    79 
       
    80 #endif