wvuing/wvcommandutils/Inc/MCASessionHandlerCmd.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Interface for Command Session Handler for managing observers
       
    15 *			   : MCAContactFetchObserver,MCAServiceStateObserver and to get some flag values
       
    16 *			   : for if the fetching is done or not. Note: Interface can be further extended
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 #ifndef MCASESSIONHANDLERCMD_H
       
    22 #define MCASESSIONHANDLERCMD_H
       
    23 
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class MCAContactFetchObserver;
       
    27 class MCAServiceStateObserver;
       
    28 
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 class MCASessionHandlerCmd
       
    33     {
       
    34     public:
       
    35         /**
       
    36          * Add given observer to ConatctFetch observer list
       
    37          * @param aObserver to add
       
    38          * @return none
       
    39          */
       
    40         virtual void AddContactFetchObserverL( MCAContactFetchObserver* aObserver ) = 0;
       
    41 
       
    42         /**
       
    43          * Remove given observer from observer list
       
    44          * @param aObserver observer to remove
       
    45          * @return none
       
    46          */
       
    47         virtual void RemoveContactFetchObserver( MCAContactFetchObserver* aObserver ) = 0;
       
    48 
       
    49         /**
       
    50          * Add given observer to ServiceState observer list
       
    51          * @param aObserver to add
       
    52          * @return none
       
    53          */
       
    54         virtual void AddServiceStateObserversL( MCAServiceStateObserver* aObserver ) = 0;
       
    55 
       
    56         /**
       
    57          * Remove given observer from observer list
       
    58          * @param aObserver observer to remove
       
    59          * @return none
       
    60          */
       
    61         virtual void RemoveServiceStateObservers( MCAServiceStateObserver* aObserver ) = 0;
       
    62 
       
    63         /**
       
    64          * Check if contact fetching is done
       
    65          * @return ETrue if done, EFalse otherwise
       
    66          */
       
    67         virtual TBool IsFetchDone() = 0;
       
    68 
       
    69         /**
       
    70          * @return ETrue if the contact list has been refreshed
       
    71          *         during this session
       
    72          */
       
    73         virtual TBool ContactsRefreshed() const = 0;
       
    74 
       
    75         /**
       
    76          * Gets the IsAlreadyLoggedOut flag value
       
    77          * @return ETrue if Already Logged Out
       
    78          */
       
    79         virtual TBool IsAlreadyLoggedOut() const = 0;
       
    80 
       
    81         /**
       
    82          * Tells if user is logged in or not
       
    83          * @return ETrue if logged in else EFalse
       
    84          */
       
    85         virtual TBool IsLoggedIn() const = 0;
       
    86 
       
    87 
       
    88         /**
       
    89         * Sets the contact refreshed flag
       
    90         * @param aRefreshed ETrue if the contact list has been refreshed
       
    91         */
       
    92         virtual void SetContactsRefreshed( TBool aRefreshed ) = 0;
       
    93 
       
    94 
       
    95         /**
       
    96          * Checks if background login is running.
       
    97          * @return ETrue if background login is running.
       
    98          */
       
    99         virtual TBool IsBackgroundTaskRunning() const = 0;
       
   100     };
       
   101 
       
   102 #endif      // MCASESSIONHANDLERCMD_H
       
   103 
       
   104 // End of File