Back to index

lightning-sunbird  0.9+nobinonly
nsIImportFieldMap.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039        Field map interface for importing address books
00040   
00041        A field map is an arbitrary sized list of mozilla address book fields.
00042        The field map is used by import to map fields from the import format
00043        to mozilla fields.
00044        For export, the map contains the ordered list of mozilla fields to
00045        export!
00046 */
00047 
00048 #include "nsISupports.idl"
00049 
00050 interface nsIAddrDatabase;
00051 interface nsIMdbRow;
00052 interface nsIAbCard;
00053 
00054 
00055 [scriptable, uuid(0e376da3-e289-4d14-bdec-867764585eb7)]
00056 interface nsIImportFieldMap : nsISupports
00057 {
00058   /*
00059     Flag to indicate whether or not to skip the first record,
00060     for instance csv files often have field names as the first
00061     record
00062   */
00063   attribute boolean skipFirstRecord;
00064 
00065        readonly attribute long     numMozFields;
00066        readonly attribute long     mapSize;
00067        
00068        wstring GetFieldDescription( in long index);
00069        
00070        /*
00071               Set the size of the field map, all unpopulated entries
00072               will default to -1
00073        */
00074        void   SetFieldMapSize( in long size);
00075               
00076        /*
00077               Initialize the field map to a given size with default values
00078        */
00079        void   DefaultFieldMap( in long size);
00080 
00081        /*
00082               Return the field number that this index maps to, -1 for no field
00083        */
00084        long   GetFieldMap( in long index);
00085 
00086        /*
00087               Set the field that this index maps to, -1 for no field
00088        */
00089        void   SetFieldMap( in long index, in long fieldNum);   
00090        
00091        /*
00092               Set the field that this index maps to, -1 for no field
00093        */
00094        void   SetFieldMapByDescription( in long index, in wstring fieldDesc);       
00095        
00096        /*
00097               Return if this field is "active" in the map.
00098        */
00099        boolean       GetFieldActive( in long index);
00100 
00101        /*
00102               Set the active state of this field
00103        */
00104        void   SetFieldActive( in long index, in boolean active);
00105 
00106        /*
00107               Set the value of the given field in the database row 
00108        */
00109        void   SetFieldValue( in nsIAddrDatabase database, in nsIMdbRow row, in long fieldNum, in wstring value);
00110 
00111        /*
00112               Set the value of the given field in the database row 
00113        */
00114        void   SetFieldValueByDescription( in nsIAddrDatabase database, in nsIMdbRow row, in wstring fieldDesc, in wstring value);
00115        
00116        /*
00117               Get the value of the given field from the address card
00118        */
00119        wstring GetFieldValue( in nsIAbCard card, in long fieldNum);
00120 
00121        /*
00122               Get the value of the given field from the address card
00123        */
00124        wstring GetFieldValueByDescription( in nsIAbCard card, in wstring fieldDesc);
00125 
00126 };
00127        
00128 
00129 
00130 %{ C++
00131 
00132 %}