00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2003 - 2007 Funambol, Inc. 00004 * 00005 * This program is free software; you can redistribute it and/or modify it under 00006 * the terms of the GNU Affero General Public License version 3 as published by 00007 * the Free Software Foundation with the addition of the following permission 00008 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED 00009 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 00010 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 00011 * 00012 * This program is distributed in the hope that it will be useful, but WITHOUT 00013 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00014 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00015 * details. 00016 * 00017 * You should have received a copy of the GNU Affero General Public License 00018 * along with this program; if not, see http://www.gnu.org/licenses or write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 00020 * MA 02110-1301 USA. 00021 * 00022 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 00023 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com. 00024 * 00025 * The interactive user interfaces in modified source and object code versions 00026 * of this program must display Appropriate Legal Notices, as required under 00027 * Section 5 of the GNU Affero General Public License version 3. 00028 * 00029 * In accordance with Section 7(b) of the GNU Affero General Public License 00030 * version 3, these Appropriate Legal Notices must retain the display of the 00031 * "Powered by Funambol" logo. If the display of the logo is not reasonably 00032 * feasible for technical reasons, the Appropriate Legal Notices must display 00033 * the words "Powered by Funambol". 00034 */ 00035 00036 00037 #ifndef INCL_SEARCH 00038 #define INCL_SEARCH 00039 /** @cond DEV */ 00040 00041 #include "base/fscapi.h" 00042 #include "base/util/ArrayList.h" 00043 #include "syncml/core/AbstractCommand.h" 00044 #include "syncml/core/Data.h" 00045 #include "syncml/core/Target.h" 00046 00047 #define SEARCH_COMMAND_NAME "Search" 00048 #include "base/globalsdef.h" 00049 00050 BEGIN_NAMESPACE 00051 00052 class Search : public AbstractCommand{ 00053 00054 // ------------------------------------------------------------ Private data 00055 private: 00056 char* COMMAND_NAME; 00057 bool noResults; 00058 Target* target ; 00059 ArrayList* sources; // Source[]. It is an ArrayList of SourceArray object. Every one contains a Source object 00060 char* lang; 00061 Data* data; 00062 00063 // ---------------------------------------------------------- Public data 00064 public: 00065 00066 Search(); 00067 ~Search(); 00068 00069 /** 00070 * Creates a new Search object. 00071 * 00072 * @param cmdID command identifier - NOT NULL 00073 * @param noResp is <NoResponse/> required? 00074 * @param noResults is <NoResults/> required? 00075 * @param cred authentication credentials 00076 * @param target target 00077 * @param sources sources - NOT NULL 00078 * @param lang preferred language 00079 * @param meta meta data - NOT NULL 00080 * @param data contains the search grammar - NOT NULL 00081 * 00082 * 00083 */ 00084 Search(CmdID* cmdID , 00085 bool noResp , 00086 bool noResults, 00087 Cred* cred , 00088 Target* target , 00089 ArrayList* sources , 00090 char* lang , 00091 Meta* meta , 00092 Data* data ); 00093 00094 /** 00095 * Sets noResults 00096 * 00097 * @param noResults the noResults value 00098 */ 00099 void setNoResults(bool noResults); 00100 00101 /** 00102 * Gets the Boolean value of noResults property 00103 * 00104 * @return noResults if boolean value is true, otherwise null 00105 */ 00106 bool getNoResults(); 00107 00108 /** 00109 * Returns target property 00110 * @return target the Target property 00111 */ 00112 Target* getTarget(); 00113 00114 /** 00115 * Sets target property 00116 * 00117 * @param target the target property 00118 */ 00119 void setTarget(Target* target); 00120 00121 /** 00122 * Returns command sources 00123 * @return command sources 00124 */ 00125 ArrayList* getSources(); 00126 00127 /** 00128 * Sets command sources 00129 * 00130 * @param sources the command sources - NOT NULL 00131 * 00132 */ 00133 void setSources(ArrayList* sources); 00134 00135 /** 00136 * Returns the preferred language 00137 * 00138 * @return the preferred language 00139 * 00140 */ 00141 const char* getLang(); 00142 00143 /** 00144 * Sets the preferred language 00145 * 00146 * @param lang the preferred language 00147 */ 00148 void setLang(const char* lang); 00149 00150 /** 00151 * Returns data 00152 * 00153 * @return data 00154 * 00155 */ 00156 Data* getData(); 00157 00158 /** 00159 * Sets data 00160 * 00161 * @param data the command's data - NOT NULL 00162 * 00163 */ 00164 void setData(Data* data); 00165 00166 /** 00167 * Returns the command name 00168 * 00169 * @return the command name 00170 */ 00171 const char* getName(); 00172 00173 ArrayElement* clone(); 00174 00175 }; 00176 00177 00178 END_NAMESPACE 00179 00180 /** @endcond */ 00181 #endif