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 00038 #ifndef INCL_ABSTRACT_COMMAND 00039 #define INCL_ABSTRACT_COMMAND 00040 /** @cond DEV */ 00041 00042 #include "base/fscapi.h" 00043 #include "base/util/ArrayElement.h" 00044 #include "syncml/core/CmdID.h" 00045 #include "syncml/core/Meta.h" 00046 #include "syncml/core/Cred.h" 00047 #include "base/globalsdef.h" 00048 00049 BEGIN_NAMESPACE 00050 00051 00052 00053 /** 00054 * This class implements an abstract command. It must be derived to be used by other classes. 00055 * 00056 */ 00057 00058 class AbstractCommand : public ArrayElement { 00059 00060 // ---------------------------------------------------------- Protected data 00061 protected: 00062 00063 CmdID* cmdID ; 00064 bool noResp; 00065 Meta* meta; 00066 Cred* credential; 00067 00068 void initialize(); 00069 00070 // ---------------------------------------------------------- Protected data 00071 public: 00072 AbstractCommand(); 00073 00074 AbstractCommand(CmdID* cmdID, bool noResp); 00075 00076 /** 00077 * Create a new AbstractCommand object with the given commandIdentifier 00078 * 00079 * @param cmdID the command identifier - NOT NULL 00080 * 00081 */ 00082 AbstractCommand(CmdID* cmdID); 00083 00084 /** 00085 * Create a new AbstractCommand object with the given commandIdentifier 00086 * and noResponse 00087 * 00088 * @param cmdID the command identifier - NOT NULL 00089 * @param noResponse true if the command doesn't require a response 00090 * @param meta the Meta object 00091 */ 00092 AbstractCommand(CmdID* cmdID, bool noResp, Meta* meta); 00093 00094 void set(CmdID* cmdID, bool noResp); 00095 00096 virtual ~AbstractCommand(); 00097 00098 /** 00099 * Get CommandIdentifier property 00100 * 00101 * @return the command identifier - NOT NULL 00102 */ 00103 CmdID* getCmdID(); 00104 00105 /** 00106 * Sets the CommandIdentifier property 00107 * 00108 * @param cmdID the command identifier 00109 * 00110 */ 00111 void setCmdID(CmdID* cmdID); 00112 00113 /** 00114 * Gets noResp property 00115 * 00116 * @return true if the command doesn't require a response, false otherwise 00117 */ 00118 bool isNoResp(); 00119 00120 bool getNoResp(); 00121 00122 /** 00123 * Sets noResp true if no response is required 00124 * 00125 * @param noResp is true if no response is required 00126 * 00127 */ 00128 void setNoResp(bool noResp); 00129 00130 /** 00131 * Gets Credential object 00132 * 00133 * @return the Credential object 00134 */ 00135 Cred* getCred(); 00136 00137 /** 00138 * Sets authentication credential 00139 * 00140 * @param cred the authentication credential 00141 * 00142 */ 00143 void setCred(Cred* cred); 00144 00145 /** 00146 * Gets an Meta object 00147 * 00148 * @return an Meta object 00149 */ 00150 Meta* getMeta(); 00151 00152 /** 00153 * Sets Meta object 00154 * 00155 * @param meta the meta object 00156 * 00157 */ 00158 void setMeta(Meta* meta); 00159 00160 /** 00161 * Get name property 00162 * 00163 * @return the name of the command 00164 */ 00165 virtual const char* getName() = 0; 00166 00167 virtual ArrayElement* clone() = 0; 00168 00169 }; 00170 00171 00172 END_NAMESPACE 00173 00174 /** @endcond */ 00175 #endif