mds_plat/location_manager_api/inc/rlocationobjectmanipulator.h
changeset 60 79f826a55db2
equal deleted inserted replaced
58:fe894bb075c2 60:79f826a55db2
       
     1 /*
       
     2 * Copyright (c) 2006-2009 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:  An interface to Location Object Manipulator.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef R_RLOCATIONOBJECTMANIPULATOR_H
       
    19 #define R_RLOCATIONOBJECTMANIPULATOR_H
       
    20 
       
    21 #include <locationdatatype.h>
       
    22 #include <etel3rdparty.h>
       
    23 #include <rlocationmanager.h>
       
    24 #include <lbsposition.h> 
       
    25 
       
    26 #include "mdccommon.h"
       
    27 
       
    28 /**
       
    29  *  RLocationObjectManipulator class is used to create, edit, copy and delete 
       
    30  *  location context objects and tags and relationships between them 
       
    31  *  and media items in the MdE database.
       
    32  *
       
    33  *  @lib LocationManager.lib
       
    34  *  @since S60 3.2
       
    35  */
       
    36 NONSHARABLE_CLASS( RLocationObjectManipulator ) : public RLocationManager
       
    37     {
       
    38 
       
    39 public:	
       
    40 	/**
       
    41 	 * Creates a new location object in MdE database with given 
       
    42 	 * location data. Relationship is created between the location 
       
    43 	 * object and objects whose ID is given in the ID array.
       
    44 	 * @since S60 3.2
       
    45      * @param aLocationData, Location data consist info for GPS 
       
    46      * 		  and network data
       
    47      * @param aObjectId, Create relationships with location data and 
       
    48      * 		  given media object ID
       
    49      * @return KErrNone if successful, otherwise one of the other 
       
    50      *         system-wide error codes.
       
    51 	 */
       
    52 	IMPORT_C TInt CreateLocationObject( TLocationData& aLocationData,
       
    53 										TItemId aObjectId );
       
    54 	
       
    55 	/**
       
    56 	 * Creates a new location object in MdE database.
       
    57 	 * Relationship is created between the location objects whose ID is given.
       
    58 	 * Location data is taken from location trail.
       
    59 	 * @since S60 3.2
       
    60      * @param aObjectId, Create relationships with location data and 
       
    61      * 		  given media object ID
       
    62      * @return KErrNone if successful, otherwise one of the other 
       
    63      *         system-wide error codes.
       
    64 	 */
       
    65 	IMPORT_C TInt LocationSnapshot( TItemId aObjectId );
       
    66 	
       
    67 	/**
       
    68 	 * Deletes the relationship between an object and 
       
    69 	 * the location context object associated with it.
       
    70  	 * @since S60 3.2
       
    71      * @param aObjId, Remove relationship from given media object ID
       
    72      * @return KErrNone if successful, otherwise one of the other 
       
    73      *         system-wide error codes.
       
    74 	 */
       
    75 	IMPORT_C TInt RemoveLocationObject( TItemId aObjId );
       
    76 	
       
    77 	/**
       
    78 	 * Copies location data of a media object to one or more 
       
    79 	 * media objects. If the target media object doesn’t have 
       
    80 	 * a location object associated to it, one will be created.
       
    81  	 * @since S60 3.2
       
    82      * @param aSourceId, source media object ID
       
    83      * @param aTargetIds, target media object ID
       
    84      * @param aStatus Asynchronous request status
       
    85 	 */
       
    86 	IMPORT_C void CopyLocationData (TItemId aSourceId, 
       
    87 									RArray<TItemId>& aTargetIds,
       
    88 									TRequestStatus& aStatus);
       
    89 	/**
       
    90 	 * Copies location data of a media object to one or more 
       
    91 	 * media objects. If the target media object doesn’t have 
       
    92 	 * a location object associated to it, one will be created.
       
    93   	 * @since S60 3.2
       
    94      * @param aSourceURI, source media object URI
       
    95      * @param aTargetURIs, target media object URI
       
    96      * @param aStatus Asynchronous request status
       
    97 	 */
       
    98 	IMPORT_C void CopyLocationData (TDesC& aSourceURI, 
       
    99 									RPointerArray<TDesC>& aTargetURIs,
       
   100 									TRequestStatus& aStatus);
       
   101     };
       
   102     
       
   103     
       
   104 #endif // R_RLOCATIONOBJECTMANIPULATOR_H
       
   105 
       
   106 //End of File