summaryrefslogtreecommitdiff
path: root/inc/FSclCalTodoChangeInfo.h
blob: 8d445a664e99b69821d17c56c3fba8fc7dfa2cd0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
//
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
/**
 * @file	FSclCalTodoChangeInfo.h
 * @brief	This is the header file for the %CalTodoChangeInfo class.
 *
 * This header file contains the declarations of the %CalTodoChangeInfo class.
 */
#ifndef _FSCL_CAL_TODO_CHANGE_INFO_H_
#define _FSCL_CAL_TODO_CHANGE_INFO_H_

#include <FBaseObject.h>
#include <FSclTypes.h>

namespace Tizen { namespace Social
{

/**
 * @class	CalTodoChangeInfo
 * @brief	This class represents the calendar to-do change information.
 *
 * @since	2.0
 *
 * @final	This class is not intended for extension.
 *
 *	The %CalTodoChangeInfo class represents the change information of a to-do that is managed in a calendarbook.
 */
class _OSP_EXPORT_ CalTodoChangeInfo
	: public Tizen::Base::Object
{
public:
	/**
	 * This is the default constructor for this class.
	 *
	 * @since	2.0
	 */
	CalTodoChangeInfo(void);

	/**
	 * Copying of objects using this copy constructor is allowed.
	 *
	 * @since	2.0
	 *
	 * @param[in]	rhs		An instance of %CalTodoChangeInfo to copy
	 */
	CalTodoChangeInfo(const CalTodoChangeInfo& rhs);

	/**
	 * This destructor overrides Tizen::Base::Object::~Object().
	 *
	 * @since	2.0
	 */
	virtual ~CalTodoChangeInfo(void);

	/**
	 * Compares the specified Tizen::Base::Object with the current %CalTodoChangeInfo instance.
	 *
	 * @since	2.0
	 *
	 * @return		@c true if the specified object equals the current %CalTodoChangeInfo instance, @n
	 *				else @c false
	 * @param[in]	rhs	The object instance to compare with the current object
	 * @see			GetHashCode()
	 */
	virtual bool Equals(const Tizen::Base::Object& rhs) const;

	/**
	 * Gets the hash value of the current instance.
	 *
	 * @since	2.0
	 *
	 * @return		The hash value of the current instance
	 */
	virtual int GetHashCode(void) const;

	/**
	 * Gets the change type.
	 *
	 * @since	2.0
	 *
	 * @return		The change type
	 */
	RecordChangeType GetChangeType(void) const;

	/**
	 * Gets the changed to-do ID.
	 *
	 * @since	2.0
	 *
	 * @return		The changed to-do ID
	 */
	RecordId GetTodoId(void) const;

	/**
	 * Gets the calendar ID to which the changed to-do belongs.
	 *
	 * @since	2.0
	 *
	 * @return		The calendar ID to which the changed to-do belongs
	 */
	RecordId GetCalendarId(void) const;

	/**
	 * Gets the version of the change.
	 *
	 * @since	2.0
	 *
	 * @return		The version of the change
	 */
	int GetVersion(void) const;

	/**
	 * Copying of objects using this copy assignment operator is allowed.
	 *
	 * @since	2.0
	 *
	 * @param[in]	rhs		An instance of %CalTodoChangeInfo to copy
	 */
	CalTodoChangeInfo& operator =(const CalTodoChangeInfo& rhs);

private:
	friend class _CalTodoChangeInfoImpl;
	class _CalTodoChangeInfoImpl* __pCalTodoChangeInfoImpl;

};	// CalTodoChangeInfo

}}	// Tizen::Social

#endif // _FSCL_CAL_TODO_CHANGE_INFO_H_