javaextensions/midppush/pushregistryplugin/inc/pushalarmutilsinterface.h
branchRCL_3
changeset 19 04becd199f91
equal deleted inserted replaced
16:f5050f1da672 19:04becd199f91
       
     1 /*
       
     2 * Copyright (c) 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:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef PUSHALARMUTILSINTERFACE_H
       
    20 #define PUSHALARMUTILSINTERFACE_H
       
    21 
       
    22 #include "rtcinterface.h"
       
    23 #include "javauid.h"
       
    24 
       
    25 namespace java
       
    26 {
       
    27 namespace push
       
    28 {
       
    29 
       
    30 /**
       
    31  * This interface provides method to launch a MIDlet and get information from
       
    32  * push registrations.
       
    33  */
       
    34 class PushAlarmUtilsInterface
       
    35 {
       
    36 public:
       
    37 
       
    38     PushAlarmUtilsInterface() {}
       
    39 
       
    40     /**
       
    41      * This method launches a MIDlet.
       
    42      * @param aMidletUid UID of the MIDlet.
       
    43      * @param aLaunchType Launching mode.
       
    44      * @returns true if drive, where MIDlet was installed, was available.
       
    45      *          Otherwise false.
       
    46      * @throws This operation does not throw exceptions.
       
    47      */
       
    48     virtual bool launchMidlet(const java::util::Uid& aMidletUid,
       
    49                               const int& aLaunchType) = 0;
       
    50 
       
    51     /**
       
    52      * This operation returns MIDlet's media uid.
       
    53      * @return MIDlet's media id. Returns -2 if MIDlet by uid is not found.
       
    54      *         Returns -1 if "is mmc available" check is not needed to do.
       
    55      */
       
    56     virtual int getMediaIdByMidletUid(const java::util::Uid& aMidletUid) = 0;
       
    57 
       
    58 };
       
    59 
       
    60 
       
    61 }//end namespace push
       
    62 }//end namespace java
       
    63 
       
    64 #endif // PUSHALARMUTILSINTERFACE_H
       
    65