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_RESPONSE_COMMAND 00038 #define INCL_RESPONSE_COMMAND 00039 /** @cond DEV */ 00040 00041 #include "base/fscapi.h" 00042 #include "syncml/core/ItemizedCommand.h" 00043 #include "base/globalsdef.h" 00044 00045 BEGIN_NAMESPACE 00046 00047 00048 class ResponseCommand : public ItemizedCommand { 00049 00050 // ------------------------------------------------------------ Protected data 00051 protected: 00052 /** 00053 * Message reference 00054 */ 00055 char* msgRef; 00056 00057 /** 00058 * Command reference 00059 */ 00060 char* cmdRef; 00061 00062 /** 00063 * Target references 00064 */ 00065 ArrayList* targetRef; // TargetRef[] 00066 00067 /** 00068 * Source references 00069 */ 00070 ArrayList* sourceRef; // SourceRef[] 00071 00072 00073 // ---------------------------------------------------------- Public data 00074 public: 00075 00076 ResponseCommand(); 00077 ~ResponseCommand(); 00078 00079 /** 00080 * Creates a new ResponseCommand object. 00081 * 00082 * @param cmdID the command idendifier - NOT NULL 00083 * @param msgRef message reference 00084 * @param cmdRef command reference - NOT NULL 00085 * @param targetRefs target references 00086 * @param sourceRefs source references 00087 * @param items command items 00088 * if any of the NOT NULL parameter is null 00089 */ 00090 ResponseCommand( 00091 CmdID* cmdID , 00092 const char* msgRef , 00093 const char* cmdRef , 00094 ArrayList* targetRefs, 00095 ArrayList* sourceRefs, 00096 ArrayList* items ); 00097 00098 00099 /** 00100 * Returns the message reference 00101 * 00102 * @return the message reference 00103 * 00104 */ 00105 const char* getMsgRef(); 00106 00107 /** 00108 * Sets the message reference 00109 * 00110 * @param msgRef message reference 00111 */ 00112 void setMsgRef(const char* msgRef); 00113 00114 /** 00115 * Returns the command reference 00116 * 00117 * @return the command reference 00118 * 00119 */ 00120 const char* getCmdRef(); 00121 00122 /** 00123 * Sets the command reference 00124 * 00125 * @param cmdRef commandreference - NOT NULL 00126 * 00127 */ 00128 void setCmdRef(const char* cmdRef); 00129 00130 /** 00131 * Returns the target references 00132 * 00133 * @return the target references 00134 * 00135 */ 00136 ArrayList* getTargetRef(); 00137 00138 /** 00139 * Sets the target references 00140 * 00141 * @param targetRefs target refrences 00142 */ 00143 void setTargetRef(ArrayList* targetRefs); 00144 00145 /** 00146 * Returns the source references 00147 * 00148 * @return the source references 00149 * 00150 */ 00151 ArrayList* getSourceRef(); 00152 00153 /** 00154 * Sets the source references 00155 * 00156 * @param sourceRefs source refrences 00157 */ 00158 void setSourceRef(ArrayList* sourceRefs); 00159 00160 /** 00161 * Returns the command name. It must be redefined by subclasses. 00162 * 00163 * @return the command name 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