ZCRMSDK 2.0.0 → 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (174) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +87 -2
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +86 -31
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +71 -29
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +91 -21
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +7 -0
  7. data/src/com/zoho/api/logger/sdk_logger.rb +18 -9
  8. data/src/com/zoho/crm/api/assignment_rules/api_exception.rb +121 -0
  9. data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb +215 -0
  10. data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb +61 -0
  11. data/src/com/zoho/crm/api/assignment_rules/default_user.rb +80 -0
  12. data/src/com/zoho/crm/api/assignment_rules/response_handler.rb +10 -0
  13. data/src/com/zoho/crm/api/assignment_rules/response_wrapper.rb +63 -0
  14. data/src/com/zoho/crm/api/attachments/attachment.rb +42 -4
  15. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +6 -6
  16. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +2 -2
  17. data/src/com/zoho/crm/api/blue_print/escalation.rb +80 -0
  18. data/src/com/zoho/crm/api/blue_print/field.rb +1127 -0
  19. data/src/com/zoho/crm/api/blue_print/next_transition.rb +38 -0
  20. data/src/com/zoho/crm/api/blue_print/process_info.rb +4 -4
  21. data/src/com/zoho/crm/api/blue_print/transition.rb +19 -1
  22. data/src/com/zoho/crm/api/blue_print/validation_error.rb +57 -0
  23. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +3 -3
  24. data/src/com/zoho/crm/api/bulk_read/criteria.rb +20 -0
  25. data/src/com/zoho/crm/api/bulk_read/query.rb +5 -4
  26. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +3 -3
  27. data/src/com/zoho/crm/api/bulk_write/resource.rb +24 -4
  28. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +7 -7
  29. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +7 -7
  30. data/src/com/zoho/crm/api/custom_views/criteria.rb +5 -4
  31. data/src/com/zoho/crm/api/custom_views/custom_view.rb +100 -41
  32. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +2 -2
  33. data/src/com/zoho/crm/api/custom_views/{shared_details.rb → shared_to.rb} +2 -2
  34. data/src/com/zoho/crm/api/dc/au_datacenter.rb +3 -3
  35. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +3 -3
  36. data/src/com/zoho/crm/api/dc/datacenter.rb +3 -2
  37. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +3 -3
  38. data/src/com/zoho/crm/api/dc/in_datacenter.rb +3 -3
  39. data/src/com/zoho/crm/api/dc/us_datacenter.rb +3 -3
  40. data/src/com/zoho/crm/api/email_templates/api_exception.rb +121 -0
  41. data/src/com/zoho/crm/api/email_templates/attachment.rb +118 -0
  42. data/src/com/zoho/crm/api/email_templates/email_template.rb +390 -0
  43. data/src/com/zoho/crm/api/email_templates/email_templates_operations.rb +61 -0
  44. data/src/com/zoho/crm/api/email_templates/response_handler.rb +10 -0
  45. data/src/com/zoho/crm/api/email_templates/response_wrapper.rb +83 -0
  46. data/src/com/zoho/crm/api/field_attachments/api_exception.rb +121 -0
  47. data/src/com/zoho/crm/api/field_attachments/body_wrapper.rb +62 -0
  48. data/src/com/zoho/crm/api/field_attachments/field_attachments_operations.rb +52 -0
  49. data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb +64 -0
  50. data/src/com/zoho/crm/api/field_attachments/response_handler.rb +10 -0
  51. data/src/com/zoho/crm/api/fields/external.rb +99 -0
  52. data/src/com/zoho/crm/api/fields/field.rb +215 -61
  53. data/src/com/zoho/crm/api/fields/fields_operations.rb +2 -2
  54. data/src/com/zoho/crm/api/fields/history_tracking.rb +80 -0
  55. data/src/com/zoho/crm/api/fields/maps.rb +80 -0
  56. data/src/com/zoho/crm/api/fields/multi_module_lookup.rb +99 -0
  57. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +19 -0
  58. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
  59. data/src/com/zoho/crm/api/fields/pick_list_value.rb +19 -0
  60. data/src/com/zoho/crm/api/fields/related_details.rb +19 -0
  61. data/src/com/zoho/crm/api/files/file_operations.rb +2 -2
  62. data/src/com/zoho/crm/api/initializer.rb +45 -17
  63. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
  64. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
  65. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
  66. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
  67. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
  68. data/src/com/zoho/crm/api/layouts/layout.rb +38 -0
  69. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +2 -2
  70. data/src/com/zoho/crm/api/layouts/section.rb +19 -0
  71. data/src/com/zoho/crm/api/modules/module.rb +57 -0
  72. data/src/com/zoho/crm/api/modules/modules_operations.rb +4 -4
  73. data/src/com/zoho/crm/api/notes/note.rb +19 -0
  74. data/src/com/zoho/crm/api/notes/notes_operations.rb +7 -7
  75. data/src/com/zoho/crm/api/notification/notification_operations.rb +6 -6
  76. data/src/com/zoho/crm/api/org/hierarchy_preference.rb +61 -0
  77. data/src/com/zoho/crm/api/org/org.rb +38 -0
  78. data/src/com/zoho/crm/api/org/org_operations.rb +2 -2
  79. data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
  80. data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
  81. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
  82. data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
  83. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
  84. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
  85. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
  86. data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
  87. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
  88. data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
  89. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
  90. data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
  91. data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
  92. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
  93. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
  94. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
  95. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
  96. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
  97. data/src/com/zoho/crm/api/profiles/category.rb +19 -0
  98. data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
  99. data/src/com/zoho/crm/api/profiles/profile.rb +49 -11
  100. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +2 -2
  101. data/src/com/zoho/crm/api/query/query_operations.rb +1 -1
  102. data/src/com/zoho/crm/api/record/api_exception.rb +2 -0
  103. data/src/com/zoho/crm/api/record/body_wrapper.rb +0 -19
  104. data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
  105. data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
  106. data/src/com/zoho/crm/api/record/field.rb +17 -17
  107. data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
  108. data/src/com/zoho/crm/api/record/line_tax.rb +19 -0
  109. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +4 -4
  110. data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
  111. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
  112. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
  113. data/src/com/zoho/crm/api/record/price_book.rb +31 -0
  114. data/src/com/zoho/crm/api/record/record_operations.rb +196 -26
  115. data/src/com/zoho/crm/api/record/tax.rb +80 -0
  116. data/src/com/zoho/crm/api/record/territory.rb +70 -12
  117. data/src/com/zoho/crm/api/record/widget.rb +80 -0
  118. data/src/com/zoho/crm/api/record/wizard.rb +80 -0
  119. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +2 -2
  120. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +6 -6
  121. data/src/com/zoho/crm/api/request_proxy.rb +3 -4
  122. data/src/com/zoho/crm/api/roles/roles_operations.rb +2 -2
  123. data/src/com/zoho/crm/api/sdk_config.rb +2 -68
  124. data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
  125. data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
  126. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
  127. data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
  128. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
  129. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
  130. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
  131. data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
  132. data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
  133. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
  134. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
  135. data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
  136. data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
  137. data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
  138. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +4 -4
  139. data/src/com/zoho/crm/api/tags/tag.rb +19 -0
  140. data/src/com/zoho/crm/api/tags/tags_operations.rb +11 -11
  141. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +6 -6
  142. data/src/com/zoho/crm/api/territories/response_wrapper.rb +20 -0
  143. data/src/com/zoho/crm/api/territories/territories_operations.rb +2 -2
  144. data/src/com/zoho/crm/api/territories/territory.rb +61 -23
  145. data/src/com/zoho/crm/api/users/user.rb +34 -0
  146. data/src/com/zoho/crm/api/users/users_operations.rb +6 -6
  147. data/src/com/zoho/crm/api/util/api_http_connector.rb +6 -5
  148. data/src/com/zoho/crm/api/util/common_api_handler.rb +5 -3
  149. data/src/com/zoho/crm/api/util/constants.rb +140 -15
  150. data/src/com/zoho/crm/api/util/converter.rb +30 -7
  151. data/src/com/zoho/crm/api/util/data_type_converter.rb +8 -2
  152. data/src/com/zoho/crm/api/util/form_data_converter.rb +4 -15
  153. data/src/com/zoho/crm/api/util/json_converter.rb +7 -9
  154. data/src/com/zoho/crm/api/util/module_fields_handler.rb +1 -1
  155. data/src/com/zoho/crm/api/util/utility.rb +274 -87
  156. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +3 -3
  157. data/src/com/zoho/crm/api/variables/variables_operations.rb +9 -9
  158. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  159. data/src/com/zoho/crm/api/wizards/button.rb +252 -0
  160. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  161. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  162. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  163. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  164. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  165. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  166. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  167. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  168. data/src/com/zoho/crm/api/wizards/transition.rb +80 -0
  169. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  170. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  171. data/src/resources/JSONDetails.json +1 -1
  172. data/src/version.rb +1 -1
  173. metadata +92 -7
  174. data/src/com/zoho/crm/api/record/inventory_line_items.rb +0 -235
@@ -0,0 +1,1127 @@
1
+ require_relative '../custom_views/criteria'
2
+ require_relative '../fields/association_details'
3
+ require_relative '../fields/auto_number'
4
+ require_relative '../fields/crypt'
5
+ require_relative '../fields/currency'
6
+ require_relative '../fields/external'
7
+ require_relative '../fields/formula'
8
+ require_relative '../fields/history_tracking'
9
+ require_relative '../fields/module'
10
+ require_relative '../fields/multi_module_lookup'
11
+ require_relative '../fields/multi_select_lookup'
12
+ require_relative '../fields/multi_user_lookup'
13
+ require_relative '../fields/pick_list_value'
14
+ require_relative '../fields/private'
15
+ require_relative '../fields/related_details'
16
+ require_relative '../fields/tool_tip'
17
+ require_relative '../fields/unique'
18
+ require_relative '../fields/view_type'
19
+ require_relative '../layouts/layout'
20
+ require_relative '../profiles/profile'
21
+ require_relative '../util/choice'
22
+ require_relative '../util/model'
23
+
24
+ module BluePrint
25
+ class Field
26
+ include Util::Model
27
+
28
+ # Creates an instance of Field
29
+ def initialize
30
+ @system_mandatory = nil
31
+ @webhook = nil
32
+ @private = nil
33
+ @layouts = nil
34
+ @profiles = nil
35
+ @sequence_number = nil
36
+ @content = nil
37
+ @column_name = nil
38
+ @type = nil
39
+ @transition_sequence = nil
40
+ @personality_name = nil
41
+ @message = nil
42
+ @mandatory = nil
43
+ @criteria = nil
44
+ @related_details = nil
45
+ @json_type = nil
46
+ @crypt = nil
47
+ @field_label = nil
48
+ @tooltip = nil
49
+ @created_source = nil
50
+ @field_read_only = nil
51
+ @display_label = nil
52
+ @ui_type = nil
53
+ @read_only = nil
54
+ @association_details = nil
55
+ @quick_sequence_number = nil
56
+ @businesscard_supported = nil
57
+ @multi_module_lookup = nil
58
+ @currency = nil
59
+ @id = nil
60
+ @custom_field = nil
61
+ @lookup = nil
62
+ @filterable = nil
63
+ @visible = nil
64
+ @pick_list_values_sorted_lexically = nil
65
+ @length = nil
66
+ @view_type = nil
67
+ @subform = nil
68
+ @api_name = nil
69
+ @sortable = nil
70
+ @unique = nil
71
+ @data_type = nil
72
+ @formula = nil
73
+ @decimal_place = nil
74
+ @mass_update = nil
75
+ @blueprint_supported = nil
76
+ @multiselectlookup = nil
77
+ @multiuserlookup = nil
78
+ @pick_list_values = nil
79
+ @auto_number = nil
80
+ @default_value = nil
81
+ @validation_rule = nil
82
+ @convert_mapping = nil
83
+ @external = nil
84
+ @history_tracking = nil
85
+ @display_type = nil
86
+ @key_modified = Hash.new
87
+ end
88
+
89
+ # The method to get the system_mandatory
90
+ # @return A Boolean value
91
+
92
+ def system_mandatory
93
+ @system_mandatory
94
+ end
95
+
96
+ # The method to set the value to system_mandatory
97
+ # @param system_mandatory [Boolean] A Boolean
98
+
99
+ def system_mandatory=(system_mandatory)
100
+ if system_mandatory!=nil and ! [true, false].include?system_mandatory
101
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: Boolean', nil, nil)
102
+ end
103
+ @system_mandatory = system_mandatory
104
+ @key_modified['system_mandatory'] = 1
105
+ end
106
+
107
+ # The method to get the webhook
108
+ # @return A Boolean value
109
+
110
+ def webhook
111
+ @webhook
112
+ end
113
+
114
+ # The method to set the value to webhook
115
+ # @param webhook [Boolean] A Boolean
116
+
117
+ def webhook=(webhook)
118
+ if webhook!=nil and ! [true, false].include?webhook
119
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: Boolean', nil, nil)
120
+ end
121
+ @webhook = webhook
122
+ @key_modified['webhook'] = 1
123
+ end
124
+
125
+ # The method to get the private
126
+ # @return An instance of Fields::Private
127
+
128
+ def private
129
+ @private
130
+ end
131
+
132
+ # The method to set the value to private
133
+ # @param private [Fields::Private] An instance of Fields::Private
134
+
135
+ def private=(private)
136
+ if private!=nil and !private.is_a? Fields::Private
137
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', nil, nil)
138
+ end
139
+ @private = private
140
+ @key_modified['private'] = 1
141
+ end
142
+
143
+ # The method to get the layouts
144
+ # @return An instance of Layouts::Layout
145
+
146
+ def layouts
147
+ @layouts
148
+ end
149
+
150
+ # The method to set the value to layouts
151
+ # @param layouts [Layouts::Layout] An instance of Layouts::Layout
152
+
153
+ def layouts=(layouts)
154
+ if layouts!=nil and !layouts.is_a? Layouts::Layout
155
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Layout', nil, nil)
156
+ end
157
+ @layouts = layouts
158
+ @key_modified['layouts'] = 1
159
+ end
160
+
161
+ # The method to get the profiles
162
+ # @return An instance of Array
163
+
164
+ def profiles
165
+ @profiles
166
+ end
167
+
168
+ # The method to set the value to profiles
169
+ # @param profiles [Array] An instance of Array
170
+
171
+ def profiles=(profiles)
172
+ if profiles!=nil and !profiles.is_a? Array
173
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: Array', nil, nil)
174
+ end
175
+ @profiles = profiles
176
+ @key_modified['profiles'] = 1
177
+ end
178
+
179
+ # The method to get the sequence_number
180
+ # @return A Integer value
181
+
182
+ def sequence_number
183
+ @sequence_number
184
+ end
185
+
186
+ # The method to set the value to sequence_number
187
+ # @param sequence_number [Integer] A Integer
188
+
189
+ def sequence_number=(sequence_number)
190
+ if sequence_number!=nil and !sequence_number.is_a? Integer
191
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
192
+ end
193
+ @sequence_number = sequence_number
194
+ @key_modified['sequence_number'] = 1
195
+ end
196
+
197
+ # The method to get the content
198
+ # @return A String value
199
+
200
+ def content
201
+ @content
202
+ end
203
+
204
+ # The method to set the value to content
205
+ # @param content [String] A String
206
+
207
+ def content=(content)
208
+ if content!=nil and !content.is_a? String
209
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: String', nil, nil)
210
+ end
211
+ @content = content
212
+ @key_modified['content'] = 1
213
+ end
214
+
215
+ # The method to get the column_name
216
+ # @return A String value
217
+
218
+ def column_name
219
+ @column_name
220
+ end
221
+
222
+ # The method to set the value to column_name
223
+ # @param column_name [String] A String
224
+
225
+ def column_name=(column_name)
226
+ if column_name!=nil and !column_name.is_a? String
227
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: String', nil, nil)
228
+ end
229
+ @column_name = column_name
230
+ @key_modified['column_name'] = 1
231
+ end
232
+
233
+ # The method to get the type
234
+ # @return A String value
235
+
236
+ def type
237
+ @type
238
+ end
239
+
240
+ # The method to set the value to type
241
+ # @param type [String] A String
242
+
243
+ def type=(type)
244
+ if type!=nil and !type.is_a? String
245
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
246
+ end
247
+ @type = type
248
+ @key_modified['_type'] = 1
249
+ end
250
+
251
+ # The method to get the transition_sequence
252
+ # @return A Integer value
253
+
254
+ def transition_sequence
255
+ @transition_sequence
256
+ end
257
+
258
+ # The method to set the value to transition_sequence
259
+ # @param transition_sequence [Integer] A Integer
260
+
261
+ def transition_sequence=(transition_sequence)
262
+ if transition_sequence!=nil and !transition_sequence.is_a? Integer
263
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transition_sequence EXPECTED TYPE: Integer', nil, nil)
264
+ end
265
+ @transition_sequence = transition_sequence
266
+ @key_modified['transition_sequence'] = 1
267
+ end
268
+
269
+ # The method to get the personality_name
270
+ # @return A String value
271
+
272
+ def personality_name
273
+ @personality_name
274
+ end
275
+
276
+ # The method to set the value to personality_name
277
+ # @param personality_name [String] A String
278
+
279
+ def personality_name=(personality_name)
280
+ if personality_name!=nil and !personality_name.is_a? String
281
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: personality_name EXPECTED TYPE: String', nil, nil)
282
+ end
283
+ @personality_name = personality_name
284
+ @key_modified['personality_name'] = 1
285
+ end
286
+
287
+ # The method to get the message
288
+ # @return A String value
289
+
290
+ def message
291
+ @message
292
+ end
293
+
294
+ # The method to set the value to message
295
+ # @param message [String] A String
296
+
297
+ def message=(message)
298
+ if message!=nil and !message.is_a? String
299
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: String', nil, nil)
300
+ end
301
+ @message = message
302
+ @key_modified['message'] = 1
303
+ end
304
+
305
+ # The method to get the mandatory
306
+ # @return A Boolean value
307
+
308
+ def mandatory
309
+ @mandatory
310
+ end
311
+
312
+ # The method to set the value to mandatory
313
+ # @param mandatory [Boolean] A Boolean
314
+
315
+ def mandatory=(mandatory)
316
+ if mandatory!=nil and ! [true, false].include?mandatory
317
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mandatory EXPECTED TYPE: Boolean', nil, nil)
318
+ end
319
+ @mandatory = mandatory
320
+ @key_modified['mandatory'] = 1
321
+ end
322
+
323
+ # The method to get the criteria
324
+ # @return An instance of CustomViews::Criteria
325
+
326
+ def criteria
327
+ @criteria
328
+ end
329
+
330
+ # The method to set the value to criteria
331
+ # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
332
+
333
+ def criteria=(criteria)
334
+ if criteria!=nil and !criteria.is_a? CustomViews::Criteria
335
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
336
+ end
337
+ @criteria = criteria
338
+ @key_modified['criteria'] = 1
339
+ end
340
+
341
+ # The method to get the related_details
342
+ # @return An instance of Fields::RelatedDetails
343
+
344
+ def related_details
345
+ @related_details
346
+ end
347
+
348
+ # The method to set the value to related_details
349
+ # @param related_details [Fields::RelatedDetails] An instance of Fields::RelatedDetails
350
+
351
+ def related_details=(related_details)
352
+ if related_details!=nil and !related_details.is_a? Fields::RelatedDetails
353
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_details EXPECTED TYPE: RelatedDetails', nil, nil)
354
+ end
355
+ @related_details = related_details
356
+ @key_modified['related_details'] = 1
357
+ end
358
+
359
+ # The method to get the json_type
360
+ # @return A String value
361
+
362
+ def json_type
363
+ @json_type
364
+ end
365
+
366
+ # The method to set the value to json_type
367
+ # @param json_type [String] A String
368
+
369
+ def json_type=(json_type)
370
+ if json_type!=nil and !json_type.is_a? String
371
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: String', nil, nil)
372
+ end
373
+ @json_type = json_type
374
+ @key_modified['json_type'] = 1
375
+ end
376
+
377
+ # The method to get the crypt
378
+ # @return An instance of Fields::Crypt
379
+
380
+ def crypt
381
+ @crypt
382
+ end
383
+
384
+ # The method to set the value to crypt
385
+ # @param crypt [Fields::Crypt] An instance of Fields::Crypt
386
+
387
+ def crypt=(crypt)
388
+ if crypt!=nil and !crypt.is_a? Fields::Crypt
389
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', nil, nil)
390
+ end
391
+ @crypt = crypt
392
+ @key_modified['crypt'] = 1
393
+ end
394
+
395
+ # The method to get the field_label
396
+ # @return A String value
397
+
398
+ def field_label
399
+ @field_label
400
+ end
401
+
402
+ # The method to set the value to field_label
403
+ # @param field_label [String] A String
404
+
405
+ def field_label=(field_label)
406
+ if field_label!=nil and !field_label.is_a? String
407
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: String', nil, nil)
408
+ end
409
+ @field_label = field_label
410
+ @key_modified['field_label'] = 1
411
+ end
412
+
413
+ # The method to get the tooltip
414
+ # @return An instance of Fields::ToolTip
415
+
416
+ def tooltip
417
+ @tooltip
418
+ end
419
+
420
+ # The method to set the value to tooltip
421
+ # @param tooltip [Fields::ToolTip] An instance of Fields::ToolTip
422
+
423
+ def tooltip=(tooltip)
424
+ if tooltip!=nil and !tooltip.is_a? Fields::ToolTip
425
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', nil, nil)
426
+ end
427
+ @tooltip = tooltip
428
+ @key_modified['tooltip'] = 1
429
+ end
430
+
431
+ # The method to get the created_source
432
+ # @return A String value
433
+
434
+ def created_source
435
+ @created_source
436
+ end
437
+
438
+ # The method to set the value to created_source
439
+ # @param created_source [String] A String
440
+
441
+ def created_source=(created_source)
442
+ if created_source!=nil and !created_source.is_a? String
443
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: String', nil, nil)
444
+ end
445
+ @created_source = created_source
446
+ @key_modified['created_source'] = 1
447
+ end
448
+
449
+ # The method to get the field_read_only
450
+ # @return A Boolean value
451
+
452
+ def field_read_only
453
+ @field_read_only
454
+ end
455
+
456
+ # The method to set the value to field_read_only
457
+ # @param field_read_only [Boolean] A Boolean
458
+
459
+ def field_read_only=(field_read_only)
460
+ if field_read_only!=nil and ! [true, false].include?field_read_only
461
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: Boolean', nil, nil)
462
+ end
463
+ @field_read_only = field_read_only
464
+ @key_modified['field_read_only'] = 1
465
+ end
466
+
467
+ # The method to get the display_label
468
+ # @return A String value
469
+
470
+ def display_label
471
+ @display_label
472
+ end
473
+
474
+ # The method to set the value to display_label
475
+ # @param display_label [String] A String
476
+
477
+ def display_label=(display_label)
478
+ if display_label!=nil and !display_label.is_a? String
479
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
480
+ end
481
+ @display_label = display_label
482
+ @key_modified['display_label'] = 1
483
+ end
484
+
485
+ # The method to get the ui_type
486
+ # @return A Integer value
487
+
488
+ def ui_type
489
+ @ui_type
490
+ end
491
+
492
+ # The method to set the value to ui_type
493
+ # @param ui_type [Integer] A Integer
494
+
495
+ def ui_type=(ui_type)
496
+ if ui_type!=nil and !ui_type.is_a? Integer
497
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: Integer', nil, nil)
498
+ end
499
+ @ui_type = ui_type
500
+ @key_modified['ui_type'] = 1
501
+ end
502
+
503
+ # The method to get the read_only
504
+ # @return A Boolean value
505
+
506
+ def read_only
507
+ @read_only
508
+ end
509
+
510
+ # The method to set the value to read_only
511
+ # @param read_only [Boolean] A Boolean
512
+
513
+ def read_only=(read_only)
514
+ if read_only!=nil and ! [true, false].include?read_only
515
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: Boolean', nil, nil)
516
+ end
517
+ @read_only = read_only
518
+ @key_modified['read_only'] = 1
519
+ end
520
+
521
+ # The method to get the association_details
522
+ # @return An instance of Fields::AssociationDetails
523
+
524
+ def association_details
525
+ @association_details
526
+ end
527
+
528
+ # The method to set the value to association_details
529
+ # @param association_details [Fields::AssociationDetails] An instance of Fields::AssociationDetails
530
+
531
+ def association_details=(association_details)
532
+ if association_details!=nil and !association_details.is_a? Fields::AssociationDetails
533
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', nil, nil)
534
+ end
535
+ @association_details = association_details
536
+ @key_modified['association_details'] = 1
537
+ end
538
+
539
+ # The method to get the quick_sequence_number
540
+ # @return A Integer value
541
+
542
+ def quick_sequence_number
543
+ @quick_sequence_number
544
+ end
545
+
546
+ # The method to set the value to quick_sequence_number
547
+ # @param quick_sequence_number [Integer] A Integer
548
+
549
+ def quick_sequence_number=(quick_sequence_number)
550
+ if quick_sequence_number!=nil and !quick_sequence_number.is_a? Integer
551
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: Integer', nil, nil)
552
+ end
553
+ @quick_sequence_number = quick_sequence_number
554
+ @key_modified['quick_sequence_number'] = 1
555
+ end
556
+
557
+ # The method to get the businesscard_supported
558
+ # @return A Boolean value
559
+
560
+ def businesscard_supported
561
+ @businesscard_supported
562
+ end
563
+
564
+ # The method to set the value to businesscard_supported
565
+ # @param businesscard_supported [Boolean] A Boolean
566
+
567
+ def businesscard_supported=(businesscard_supported)
568
+ if businesscard_supported!=nil and ! [true, false].include?businesscard_supported
569
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: Boolean', nil, nil)
570
+ end
571
+ @businesscard_supported = businesscard_supported
572
+ @key_modified['businesscard_supported'] = 1
573
+ end
574
+
575
+ # The method to get the multi_module_lookup
576
+ # @return An instance of Fields::MultiModuleLookup
577
+
578
+ def multi_module_lookup
579
+ @multi_module_lookup
580
+ end
581
+
582
+ # The method to set the value to multi_module_lookup
583
+ # @param multi_module_lookup [Fields::MultiModuleLookup] An instance of Fields::MultiModuleLookup
584
+
585
+ def multi_module_lookup=(multi_module_lookup)
586
+ if multi_module_lookup!=nil and !multi_module_lookup.is_a? Fields::MultiModuleLookup
587
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', nil, nil)
588
+ end
589
+ @multi_module_lookup = multi_module_lookup
590
+ @key_modified['multi_module_lookup'] = 1
591
+ end
592
+
593
+ # The method to get the currency
594
+ # @return An instance of Fields::Currency
595
+
596
+ def currency
597
+ @currency
598
+ end
599
+
600
+ # The method to set the value to currency
601
+ # @param currency [Fields::Currency] An instance of Fields::Currency
602
+
603
+ def currency=(currency)
604
+ if currency!=nil and !currency.is_a? Fields::Currency
605
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', nil, nil)
606
+ end
607
+ @currency = currency
608
+ @key_modified['currency'] = 1
609
+ end
610
+
611
+ # The method to get the id
612
+ # @return A Integer value
613
+
614
+ def id
615
+ @id
616
+ end
617
+
618
+ # The method to set the value to id
619
+ # @param id [Integer] A Integer
620
+
621
+ def id=(id)
622
+ if id!=nil and !id.is_a? Integer
623
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
624
+ end
625
+ @id = id
626
+ @key_modified['id'] = 1
627
+ end
628
+
629
+ # The method to get the custom_field
630
+ # @return A Boolean value
631
+
632
+ def custom_field
633
+ @custom_field
634
+ end
635
+
636
+ # The method to set the value to custom_field
637
+ # @param custom_field [Boolean] A Boolean
638
+
639
+ def custom_field=(custom_field)
640
+ if custom_field!=nil and ! [true, false].include?custom_field
641
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: Boolean', nil, nil)
642
+ end
643
+ @custom_field = custom_field
644
+ @key_modified['custom_field'] = 1
645
+ end
646
+
647
+ # The method to get the lookup
648
+ # @return An instance of Fields::Module
649
+
650
+ def lookup
651
+ @lookup
652
+ end
653
+
654
+ # The method to set the value to lookup
655
+ # @param lookup [Fields::Module] An instance of Fields::Module
656
+
657
+ def lookup=(lookup)
658
+ if lookup!=nil and !lookup.is_a? Fields::Module
659
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Module', nil, nil)
660
+ end
661
+ @lookup = lookup
662
+ @key_modified['lookup'] = 1
663
+ end
664
+
665
+ # The method to get the filterable
666
+ # @return A Boolean value
667
+
668
+ def filterable
669
+ @filterable
670
+ end
671
+
672
+ # The method to set the value to filterable
673
+ # @param filterable [Boolean] A Boolean
674
+
675
+ def filterable=(filterable)
676
+ if filterable!=nil and ! [true, false].include?filterable
677
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: Boolean', nil, nil)
678
+ end
679
+ @filterable = filterable
680
+ @key_modified['filterable'] = 1
681
+ end
682
+
683
+ # The method to get the visible
684
+ # @return A Boolean value
685
+
686
+ def visible
687
+ @visible
688
+ end
689
+
690
+ # The method to set the value to visible
691
+ # @param visible [Boolean] A Boolean
692
+
693
+ def visible=(visible)
694
+ if visible!=nil and ! [true, false].include?visible
695
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
696
+ end
697
+ @visible = visible
698
+ @key_modified['visible'] = 1
699
+ end
700
+
701
+ # The method to get the pick_list_values_sorted_lexically
702
+ # @return A Boolean value
703
+
704
+ def pick_list_values_sorted_lexically
705
+ @pick_list_values_sorted_lexically
706
+ end
707
+
708
+ # The method to set the value to pick_list_values_sorted_lexically
709
+ # @param pick_list_values_sorted_lexically [Boolean] A Boolean
710
+
711
+ def pick_list_values_sorted_lexically=(pick_list_values_sorted_lexically)
712
+ if pick_list_values_sorted_lexically!=nil and ! [true, false].include?pick_list_values_sorted_lexically
713
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: Boolean', nil, nil)
714
+ end
715
+ @pick_list_values_sorted_lexically = pick_list_values_sorted_lexically
716
+ @key_modified['pick_list_values_sorted_lexically'] = 1
717
+ end
718
+
719
+ # The method to get the length
720
+ # @return A Integer value
721
+
722
+ def length
723
+ @length
724
+ end
725
+
726
+ # The method to set the value to length
727
+ # @param length [Integer] A Integer
728
+
729
+ def length=(length)
730
+ if length!=nil and !length.is_a? Integer
731
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: Integer', nil, nil)
732
+ end
733
+ @length = length
734
+ @key_modified['length'] = 1
735
+ end
736
+
737
+ # The method to get the view_type
738
+ # @return An instance of Fields::ViewType
739
+
740
+ def view_type
741
+ @view_type
742
+ end
743
+
744
+ # The method to set the value to view_type
745
+ # @param view_type [Fields::ViewType] An instance of Fields::ViewType
746
+
747
+ def view_type=(view_type)
748
+ if view_type!=nil and !view_type.is_a? Fields::ViewType
749
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', nil, nil)
750
+ end
751
+ @view_type = view_type
752
+ @key_modified['view_type'] = 1
753
+ end
754
+
755
+ # The method to get the subform
756
+ # @return An instance of Fields::Module
757
+
758
+ def subform
759
+ @subform
760
+ end
761
+
762
+ # The method to set the value to subform
763
+ # @param subform [Fields::Module] An instance of Fields::Module
764
+
765
+ def subform=(subform)
766
+ if subform!=nil and !subform.is_a? Fields::Module
767
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Module', nil, nil)
768
+ end
769
+ @subform = subform
770
+ @key_modified['subform'] = 1
771
+ end
772
+
773
+ # The method to get the api_name
774
+ # @return A String value
775
+
776
+ def api_name
777
+ @api_name
778
+ end
779
+
780
+ # The method to set the value to api_name
781
+ # @param api_name [String] A String
782
+
783
+ def api_name=(api_name)
784
+ if api_name!=nil and !api_name.is_a? String
785
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
786
+ end
787
+ @api_name = api_name
788
+ @key_modified['api_name'] = 1
789
+ end
790
+
791
+ # The method to get the sortable
792
+ # @return A Boolean value
793
+
794
+ def sortable
795
+ @sortable
796
+ end
797
+
798
+ # The method to set the value to sortable
799
+ # @param sortable [Boolean] A Boolean
800
+
801
+ def sortable=(sortable)
802
+ if sortable!=nil and ! [true, false].include?sortable
803
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: Boolean', nil, nil)
804
+ end
805
+ @sortable = sortable
806
+ @key_modified['sortable'] = 1
807
+ end
808
+
809
+ # The method to get the unique
810
+ # @return An instance of Fields::Unique
811
+
812
+ def unique
813
+ @unique
814
+ end
815
+
816
+ # The method to set the value to unique
817
+ # @param unique [Fields::Unique] An instance of Fields::Unique
818
+
819
+ def unique=(unique)
820
+ if unique!=nil and !unique.is_a? Fields::Unique
821
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', nil, nil)
822
+ end
823
+ @unique = unique
824
+ @key_modified['unique'] = 1
825
+ end
826
+
827
+ # The method to get the data_type
828
+ # @return A String value
829
+
830
+ def data_type
831
+ @data_type
832
+ end
833
+
834
+ # The method to set the value to data_type
835
+ # @param data_type [String] A String
836
+
837
+ def data_type=(data_type)
838
+ if data_type!=nil and !data_type.is_a? String
839
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: String', nil, nil)
840
+ end
841
+ @data_type = data_type
842
+ @key_modified['data_type'] = 1
843
+ end
844
+
845
+ # The method to get the formula
846
+ # @return An instance of Fields::Formula
847
+
848
+ def formula
849
+ @formula
850
+ end
851
+
852
+ # The method to set the value to formula
853
+ # @param formula [Fields::Formula] An instance of Fields::Formula
854
+
855
+ def formula=(formula)
856
+ if formula!=nil and !formula.is_a? Fields::Formula
857
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', nil, nil)
858
+ end
859
+ @formula = formula
860
+ @key_modified['formula'] = 1
861
+ end
862
+
863
+ # The method to get the decimal_place
864
+ # @return A Integer value
865
+
866
+ def decimal_place
867
+ @decimal_place
868
+ end
869
+
870
+ # The method to set the value to decimal_place
871
+ # @param decimal_place [Integer] A Integer
872
+
873
+ def decimal_place=(decimal_place)
874
+ if decimal_place!=nil and !decimal_place.is_a? Integer
875
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: Integer', nil, nil)
876
+ end
877
+ @decimal_place = decimal_place
878
+ @key_modified['decimal_place'] = 1
879
+ end
880
+
881
+ # The method to get the mass_update
882
+ # @return A Boolean value
883
+
884
+ def mass_update
885
+ @mass_update
886
+ end
887
+
888
+ # The method to set the value to mass_update
889
+ # @param mass_update [Boolean] A Boolean
890
+
891
+ def mass_update=(mass_update)
892
+ if mass_update!=nil and ! [true, false].include?mass_update
893
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: Boolean', nil, nil)
894
+ end
895
+ @mass_update = mass_update
896
+ @key_modified['mass_update'] = 1
897
+ end
898
+
899
+ # The method to get the blueprint_supported
900
+ # @return A Boolean value
901
+
902
+ def blueprint_supported
903
+ @blueprint_supported
904
+ end
905
+
906
+ # The method to set the value to blueprint_supported
907
+ # @param blueprint_supported [Boolean] A Boolean
908
+
909
+ def blueprint_supported=(blueprint_supported)
910
+ if blueprint_supported!=nil and ! [true, false].include?blueprint_supported
911
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: Boolean', nil, nil)
912
+ end
913
+ @blueprint_supported = blueprint_supported
914
+ @key_modified['blueprint_supported'] = 1
915
+ end
916
+
917
+ # The method to get the multiselectlookup
918
+ # @return An instance of Fields::MultiSelectLookup
919
+
920
+ def multiselectlookup
921
+ @multiselectlookup
922
+ end
923
+
924
+ # The method to set the value to multiselectlookup
925
+ # @param multiselectlookup [Fields::MultiSelectLookup] An instance of Fields::MultiSelectLookup
926
+
927
+ def multiselectlookup=(multiselectlookup)
928
+ if multiselectlookup!=nil and !multiselectlookup.is_a? Fields::MultiSelectLookup
929
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: MultiSelectLookup', nil, nil)
930
+ end
931
+ @multiselectlookup = multiselectlookup
932
+ @key_modified['multiselectlookup'] = 1
933
+ end
934
+
935
+ # The method to get the multiuserlookup
936
+ # @return An instance of Fields::MultiUserLookup
937
+
938
+ def multiuserlookup
939
+ @multiuserlookup
940
+ end
941
+
942
+ # The method to set the value to multiuserlookup
943
+ # @param multiuserlookup [Fields::MultiUserLookup] An instance of Fields::MultiUserLookup
944
+
945
+ def multiuserlookup=(multiuserlookup)
946
+ if multiuserlookup!=nil and !multiuserlookup.is_a? Fields::MultiUserLookup
947
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: MultiUserLookup', nil, nil)
948
+ end
949
+ @multiuserlookup = multiuserlookup
950
+ @key_modified['multiuserlookup'] = 1
951
+ end
952
+
953
+ # The method to get the pick_list_values
954
+ # @return An instance of Array
955
+
956
+ def pick_list_values
957
+ @pick_list_values
958
+ end
959
+
960
+ # The method to set the value to pick_list_values
961
+ # @param pick_list_values [Array] An instance of Array
962
+
963
+ def pick_list_values=(pick_list_values)
964
+ if pick_list_values!=nil and !pick_list_values.is_a? Array
965
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: Array', nil, nil)
966
+ end
967
+ @pick_list_values = pick_list_values
968
+ @key_modified['pick_list_values'] = 1
969
+ end
970
+
971
+ # The method to get the auto_number
972
+ # @return An instance of Fields::AutoNumber
973
+
974
+ def auto_number
975
+ @auto_number
976
+ end
977
+
978
+ # The method to set the value to auto_number
979
+ # @param auto_number [Fields::AutoNumber] An instance of Fields::AutoNumber
980
+
981
+ def auto_number=(auto_number)
982
+ if auto_number!=nil and !auto_number.is_a? Fields::AutoNumber
983
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: auto_number EXPECTED TYPE: AutoNumber', nil, nil)
984
+ end
985
+ @auto_number = auto_number
986
+ @key_modified['auto_number'] = 1
987
+ end
988
+
989
+ # The method to get the default_value
990
+ # @return A String value
991
+
992
+ def default_value
993
+ @default_value
994
+ end
995
+
996
+ # The method to set the value to default_value
997
+ # @param default_value [String] A String
998
+
999
+ def default_value=(default_value)
1000
+ if default_value!=nil and !default_value.is_a? String
1001
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: String', nil, nil)
1002
+ end
1003
+ @default_value = default_value
1004
+ @key_modified['default_value'] = 1
1005
+ end
1006
+
1007
+ # The method to get the validation_rule
1008
+ # @return An instance of Hash
1009
+
1010
+ def validation_rule
1011
+ @validation_rule
1012
+ end
1013
+
1014
+ # The method to set the value to validation_rule
1015
+ # @param validation_rule [Hash] An instance of Hash
1016
+
1017
+ def validation_rule=(validation_rule)
1018
+ if validation_rule!=nil and !validation_rule.is_a? Hash
1019
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: Hash', nil, nil)
1020
+ end
1021
+ @validation_rule = validation_rule
1022
+ @key_modified['validation_rule'] = 1
1023
+ end
1024
+
1025
+ # The method to get the convert_mapping
1026
+ # @return An instance of Hash
1027
+
1028
+ def convert_mapping
1029
+ @convert_mapping
1030
+ end
1031
+
1032
+ # The method to set the value to convert_mapping
1033
+ # @param convert_mapping [Hash] An instance of Hash
1034
+
1035
+ def convert_mapping=(convert_mapping)
1036
+ if convert_mapping!=nil and !convert_mapping.is_a? Hash
1037
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
1038
+ end
1039
+ @convert_mapping = convert_mapping
1040
+ @key_modified['convert_mapping'] = 1
1041
+ end
1042
+
1043
+ # The method to get the external
1044
+ # @return An instance of Fields::External
1045
+
1046
+ def external
1047
+ @external
1048
+ end
1049
+
1050
+ # The method to set the value to external
1051
+ # @param external [Fields::External] An instance of Fields::External
1052
+
1053
+ def external=(external)
1054
+ if external!=nil and !external.is_a? Fields::External
1055
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', nil, nil)
1056
+ end
1057
+ @external = external
1058
+ @key_modified['external'] = 1
1059
+ end
1060
+
1061
+ # The method to get the history_tracking
1062
+ # @return An instance of Fields::HistoryTracking
1063
+
1064
+ def history_tracking
1065
+ @history_tracking
1066
+ end
1067
+
1068
+ # The method to set the value to history_tracking
1069
+ # @param history_tracking [Fields::HistoryTracking] An instance of Fields::HistoryTracking
1070
+
1071
+ def history_tracking=(history_tracking)
1072
+ if history_tracking!=nil and !history_tracking.is_a? Fields::HistoryTracking
1073
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', nil, nil)
1074
+ end
1075
+ @history_tracking = history_tracking
1076
+ @key_modified['history_tracking'] = 1
1077
+ end
1078
+
1079
+ # The method to get the display_type
1080
+ # @return An instance of Util::Choice
1081
+
1082
+ def display_type
1083
+ @display_type
1084
+ end
1085
+
1086
+ # The method to set the value to display_type
1087
+ # @param display_type [Util::Choice] An instance of Util::Choice
1088
+
1089
+ def display_type=(display_type)
1090
+ if display_type!=nil and !display_type.is_a? Util::Choice
1091
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: Util::Choice', nil, nil)
1092
+ end
1093
+ @display_type = display_type
1094
+ @key_modified['display_type'] = 1
1095
+ end
1096
+
1097
+ # The method to check if the user has modified the given key
1098
+ # @param key [String] A String
1099
+ # @return A Integer value
1100
+
1101
+ def is_key_modified(key)
1102
+ if key!=nil and !key.is_a? String
1103
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
1104
+ end
1105
+ if @key_modified.key?(key)
1106
+ return @key_modified[key]
1107
+ end
1108
+
1109
+ nil
1110
+ end
1111
+
1112
+ # The method to mark the given key as modified
1113
+ # @param key [String] A String
1114
+ # @param modification [Integer] A Integer
1115
+
1116
+ def set_key_modified(key, modification)
1117
+ if key!=nil and !key.is_a? String
1118
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
1119
+ end
1120
+ if modification!=nil and !modification.is_a? Integer
1121
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
1122
+ end
1123
+ @key_modified[key] = modification
1124
+ end
1125
+
1126
+ end
1127
+ end