1 /*------------------------------------------------------------------------------
2 Name: GetReturnKey.h
3 Project: xmlBlaster.org
4 Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
5 ------------------------------------------------------------------------------*/
6
7 /**
8 * Parses the key of returned MsgUnit of get() invocations
9 * <p>
10 * See MsgKeySaxFactory for a syntax description of the xml structure
11 * </p>
12 * @see org.xmlBlaster.util.key.MsgKeySaxFactory
13 * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.get.html" target="others">the interface.get requirement</a>
14 *
15 * @author <a href="mailto:xmlBlaster@marcelruff.info">Marcel Ruff</a>
16 * @author <a href="mailto:laghi@swissinfo.org">Michele Laghi</a>
17 */
18
19 #ifndef _CLIENT_KEY_GETRETURNKEY_H
20 #define _CLIENT_KEY_GETRETURNKEY_H
21
22 #include <client/key/UpdateKey.h>
23
24 namespace org { namespace xmlBlaster { namespace client { namespace key {
25
26 class Dll_Export GetReturnKey : public org::xmlBlaster::client::key::UpdateKey
27 {
28 public:
29
30 /**
31 * Minimal constructor.
32 */
33 GetReturnKey(org::xmlBlaster::util::Global& global);
34
35 GetReturnKey(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::key::MsgKeyData& data);
36
37 GetReturnKey(const GetReturnKey& key);
38
39 GetReturnKey& operator =(const GetReturnKey& key);
40
41 /**
42 * Messages starting with "__" are reserved for internal usage
43 */
44 bool isInternal() const;
45
46 };
47
48 }}}} // namespace
49
50 #endif
syntax highlighted by Code2HTML, v. 0.9.1