ncdengine/inc/ncdnodeseen.h
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     1 /*
       
     2 * Copyright (c) 2007-2008 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:   Contains MNcdNodeSeen
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_NCDNODESEEN_H
       
    20 #define M_NCDNODESEEN_H
       
    21 
       
    22 #include "catalogsbase.h"
       
    23 #include "ncdinterfaceids.h"
       
    24 
       
    25 
       
    26 /**
       
    27  * This interface can be used to set a node as seen, or ask the 'seen' state
       
    28  * of the node. This is useful if new nodes should be separated from the seen
       
    29  * ones somehow. This interface can be queried from a node. If the node is
       
    30  * set as seen, all the nodes that have the same metadata are automatically
       
    31  * set as seen.
       
    32  *
       
    33  * 
       
    34  */
       
    35 class MNcdNodeSeen : public virtual MCatalogsBase
       
    36     {
       
    37 
       
    38 public:
       
    39 
       
    40     /**
       
    41      * Unique identifier for the interface, required for all MCatalogsBase interfaces.
       
    42      *
       
    43      * 
       
    44      */
       
    45     enum { KInterfaceUid = ENcdNodeSeenUid };
       
    46     
       
    47     /**
       
    48      * Tells whether the metadata is seen.
       
    49      */
       
    50     virtual TBool IsSeen() const = 0;
       
    51     
       
    52     /**
       
    53      * Sets the node as seen. Note, the effect takes place when the client-server session
       
    54      * is closed. All the other nodes having the same metadata are set as seen too.
       
    55      */
       
    56     virtual void SetSeenL() = 0;
       
    57     
       
    58 protected:
       
    59 
       
    60     /**
       
    61     * Destructor.
       
    62     *
       
    63     * @see MCatalogsBase::~MCatalogsBase
       
    64     */
       
    65     virtual ~MNcdNodeSeen() {}
       
    66 
       
    67     };
       
    68 
       
    69 
       
    70 #endif // M_NCDNODESEEN_H