You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ra...@apache.org on 2005/03/23 07:41:18 UTC
cvs commit: ws-axis/c/include/axis IMessageData.hpp
rangika 2005/03/22 22:41:18
Modified: c/include/axis IMessageData.hpp
Log:
Added API documentation to IMessagedata.hpp.
Revision Changes Path
1.7 +116 -1 ws-axis/c/include/axis/IMessageData.hpp
Index: IMessageData.hpp
===================================================================
RCS file: /home/cvs/ws-axis/c/include/axis/IMessageData.hpp,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- IMessageData.hpp 22 Mar 2005 14:24:23 -0000 1.6
+++ IMessageData.hpp 23 Mar 2005 06:41:18 -0000 1.7
@@ -42,23 +42,138 @@
virtual ~IMessageData(){};
private:
virtual void getAdminUtils(IAdminUtils** pIAdminUtils)=0;
-public:
+public:
+
+/**
+ * This method stores the given property value with the key, inside the
+ * MessageData object.
+ *
+ * @param pachName is the key of the property.
+ * @param pachValue is the value of the property.
+ * @return AXIS_SUCCESS to indicate successful operation.
+ */
virtual int setProperty(const AxisChar* pachName, const AxisChar* pachValue)=0;
+
+/**
+ * This method stores the given property value with the key, inside the
+ * MessageData object.
+ *
+ * @param pachName is the key of the property.
+ * @param pachValue is the value of the property.
+ * @param len is the size of value (pachValue).
+ * @return AXIS_SUCCESS to indicate successfull operation.
+*/
virtual int setProperty(const AxisChar* pachName, const void* pachValue, int len)=0;
+
+/**
+ * This method stores the given property value with the key, inside the
+ * MessageData object. The value is a complex object.
+ *
+ * @param pachName is the key of the property.
+ * @param pachValue is the value of the property.
+ * @param iObjectSize is the size of value (pachValue).
+ */
virtual void setComplexProperty(const AxisChar* pachName, void* pachValue, int iObjectSize)=0;
+
+/**
+ * This method returns the matching property value (to the given
+ * corresponding key)
+ *
+ * @param sName is the key of the required property.
+ * @return If it is found then matching property value is returned. If not found then it
+ * will return an empty string.
+ */
virtual const void* getProperty(const AxisChar* sName)=0;
+
+/**
+ * This method returns the matching property value (to the given
+ * corresponding key)
+ *
+ * @param pachName is the key of the required property.
+ * @return If it is found then matching property value is returned.
+ * If not found NULL is returned.
+ */
virtual void* getComplexProperty(const AxisChar* pachName)=0;
+
+/**
+ * Returns the current operation name.
+ *
+ * @return This method will return the OperationName.
+ */
virtual const AxisChar* AXISCALL getOperationName()=0;
+
+/**
+ * This method will assign the current instance of SoapSerializer
+ * to the given IWrapperSoapSerializer pointer-to-pointer.By calling this
+ * method a caller will have access to the SoapSerializer.
+ *
+ * @param pIWSS is a pointer to pointer used to get access to the
+ * current instance of soapSerializer.
+ */
virtual void AXISCALL getSoapSerializer(IWrapperSoapSerializer** pIWSS)=0;
+
+/**
+ * This method will assign the current instance of SoapDeSerializer
+ * to the given IWrapperSoapDeSerializer pointer-to-pointer. By calling this
+ * method a caller will have access to the SoapDeSerializer.
+ *
+ * @param pIWSDS is a pointer to pointer used to store the
+ * current instance of SoapDeSerializer.
+ */
virtual void AXISCALL getSoapDeSerializer
(IWrapperSoapDeSerializer** pIWSDS)=0;
+
+/**
+ * This method will assign the current instance of SoapSerializer
+ * to the given IHandlerSoapSerializer pointer-to-pointer. By calling this
+ * method a caller will have access to the SoapSerializer.
+ *
+ * @param pIHandlerSoapSerializer is a pointer to pointer used to store the
+ * current instance of soapSerializer.
+ */
virtual void getSoapSerializer
(IHandlerSoapSerializer** pIHandlerSoapSerializer)=0;
+
+/**
+ * This method will assign the current instance of SoapDeSerializer
+ * to the given IHandlerSoapDeSerializer pointer-to-pointer. By calling this
+ * method a caller will have access to the SoapDeSerializer.
+ *
+ * @param pIHandlerSoapDeSerializer is a pointer to pointer used to store the
+ * current instance of soapDeSerializer.
+ */
virtual void getSoapDeSerializer
(IHandlerSoapDeSerializer** pIHandlerSoapDeSerializer)=0;
+
+/**
+ * This method will store the given username inside the MessageData object.
+ *
+ * @param m_sUserName is the value that is passed to be set.
+ */
virtual void setUserName(string& m_sUserName)=0;
+
+/**
+ * This method returns the user name.
+ *
+ * @return this method will return the UserName.
+ */
virtual string& getUserName()=0;
+
+/**
+ * This method will return a boolean value which will say whether at the time
+ * of calling this method has already passed the pivot point.
+ *
+ * @return Returns true if the pivot point is past. Returns false if not.
+*/
virtual bool isPastPivot()=0;
+
+/**
+ * This method is used to set the pivot point status.
+ *
+ * @param bState is the value of the state that should be set. Set true if
+ * pivot point is past. Set false if pivot point is not past yet.
+ * @return will return AXIS_SUCCESS to indicate successful operation.
+*/
virtual int setPastPivotState(bool bState)=0;
};