3
#ifndef ADB_DESCRIBEINSTANCESRESPONSETYPE_H
4
#define ADB_DESCRIBEINSTANCESRESPONSETYPE_H
7
* adb_describeInstancesResponseType.h
9
* This file was auto-generated from WSDL
10
* by the Apache Axis2/Java version: 1.4 Built on : Apr 26, 2008 (06:25:17 EDT)
14
* adb_describeInstancesResponseType class
16
typedef struct adb_describeInstancesResponseType adb_describeInstancesResponseType_t;
19
#include "adb_ccInstanceType.h"
24
#include <axis2_util.h>
25
#include <axiom_soap.h>
26
#include <axis2_client.h>
33
#define ADB_DEFAULT_DIGIT_LIMIT 64
34
#define ADB_DEFAULT_NAMESPACE_PREFIX_LIMIT 64
37
/******************************* Create and Free functions *********************************/
40
* Constructor for creating adb_describeInstancesResponseType_t
41
* @param env pointer to environment struct
42
* @return newly created adb_describeInstancesResponseType_t object
44
adb_describeInstancesResponseType_t* AXIS2_CALL
45
adb_describeInstancesResponseType_create(
46
const axutil_env_t *env );
49
* Free adb_describeInstancesResponseType_t object
50
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object to free
51
* @param env pointer to environment struct
52
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
54
axis2_status_t AXIS2_CALL
55
adb_describeInstancesResponseType_free (
56
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
57
const axutil_env_t *env);
61
/********************************** Getters and Setters **************************************/
62
/******** Deprecated for array types, Use 'Getters and Setters for Arrays' instead ***********/
66
* Getter for correlationId.
67
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
68
* @param env pointer to environment struct
69
* @return axis2_char_t*
71
axis2_char_t* AXIS2_CALL
72
adb_describeInstancesResponseType_get_correlationId(
73
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
74
const axutil_env_t *env);
77
* Setter for correlationId.
78
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
79
* @param env pointer to environment struct
80
* @param arg_correlationId axis2_char_t*
81
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
83
axis2_status_t AXIS2_CALL
84
adb_describeInstancesResponseType_set_correlationId(
85
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
86
const axutil_env_t *env,
87
const axis2_char_t* arg_correlationId);
90
* Resetter for correlationId
91
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
92
* @param env pointer to environment struct
93
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
95
axis2_status_t AXIS2_CALL
96
adb_describeInstancesResponseType_reset_correlationId(
97
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
98
const axutil_env_t *env);
105
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
106
* @param env pointer to environment struct
107
* @return axis2_char_t*
109
axis2_char_t* AXIS2_CALL
110
adb_describeInstancesResponseType_get_userId(
111
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
112
const axutil_env_t *env);
116
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
117
* @param env pointer to environment struct
118
* @param arg_userId axis2_char_t*
119
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
121
axis2_status_t AXIS2_CALL
122
adb_describeInstancesResponseType_set_userId(
123
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
124
const axutil_env_t *env,
125
const axis2_char_t* arg_userId);
128
* Resetter for userId
129
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
130
* @param env pointer to environment struct
131
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
133
axis2_status_t AXIS2_CALL
134
adb_describeInstancesResponseType_reset_userId(
135
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
136
const axutil_env_t *env);
142
* Getter for statusMessage.
143
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
144
* @param env pointer to environment struct
145
* @return axis2_char_t*
147
axis2_char_t* AXIS2_CALL
148
adb_describeInstancesResponseType_get_statusMessage(
149
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
150
const axutil_env_t *env);
153
* Setter for statusMessage.
154
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
155
* @param env pointer to environment struct
156
* @param arg_statusMessage axis2_char_t*
157
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
159
axis2_status_t AXIS2_CALL
160
adb_describeInstancesResponseType_set_statusMessage(
161
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
162
const axutil_env_t *env,
163
const axis2_char_t* arg_statusMessage);
166
* Resetter for statusMessage
167
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
168
* @param env pointer to environment struct
169
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
171
axis2_status_t AXIS2_CALL
172
adb_describeInstancesResponseType_reset_statusMessage(
173
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
174
const axutil_env_t *env);
181
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
182
* @param env pointer to environment struct
183
* @return axis2_bool_t
185
axis2_bool_t AXIS2_CALL
186
adb_describeInstancesResponseType_get_return(
187
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
188
const axutil_env_t *env);
192
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
193
* @param env pointer to environment struct
194
* @param arg_return axis2_bool_t
195
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
197
axis2_status_t AXIS2_CALL
198
adb_describeInstancesResponseType_set_return(
199
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
200
const axutil_env_t *env,
201
axis2_bool_t arg_return);
204
* Resetter for return
205
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
206
* @param env pointer to environment struct
207
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
209
axis2_status_t AXIS2_CALL
210
adb_describeInstancesResponseType_reset_return(
211
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
212
const axutil_env_t *env);
218
* Getter for instances. Deprecated for array types, Use adb_describeInstancesResponseType_get_instances_at instead
219
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
220
* @param env pointer to environment struct
221
* @return Array of adb_ccInstanceType_t*s.
223
axutil_array_list_t* AXIS2_CALL
224
adb_describeInstancesResponseType_get_instances(
225
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
226
const axutil_env_t *env);
229
* Setter for instances.Deprecated for array types, Use adb_describeInstancesResponseType_set_instances_at
230
* or adb_describeInstancesResponseType_add_instances instead.
231
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
232
* @param env pointer to environment struct
233
* @param arg_instances Array of adb_ccInstanceType_t*s.
234
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
236
axis2_status_t AXIS2_CALL
237
adb_describeInstancesResponseType_set_instances(
238
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
239
const axutil_env_t *env,
240
axutil_array_list_t* arg_instances);
243
* Resetter for instances
244
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
245
* @param env pointer to environment struct
246
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
248
axis2_status_t AXIS2_CALL
249
adb_describeInstancesResponseType_reset_instances(
250
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
251
const axutil_env_t *env);
254
/****************************** Getters and Setters For Arrays **********************************/
255
/************ Array Specific Operations: get_at, set_at, add, remove_at, sizeof *****************/
258
* E.g. use of get_at, set_at, add and sizeof
260
* for(i = 0; i < adb_element_sizeof_property(adb_object, env); i ++ )
262
* // Getting ith value to property_object variable
263
* property_object = adb_element_get_property_at(adb_object, env, i);
265
* // Setting ith value from property_object variable
266
* adb_element_set_property_at(adb_object, env, i, property_object);
268
* // Appending the value to the end of the array from property_object variable
269
* adb_element_add_property(adb_object, env, property_object);
271
* // Removing the ith value from an array
272
* adb_element_remove_property_at(adb_object, env, i);
281
* Get the ith element of instances.
282
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
283
* @param env pointer to environment struct
284
* @param i index of the item to return
285
* @return ith adb_ccInstanceType_t* of the array
287
adb_ccInstanceType_t* AXIS2_CALL
288
adb_describeInstancesResponseType_get_instances_at(
289
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
290
const axutil_env_t *env, int i);
293
* Set the ith element of instances. (If the ith already exist, it will be replaced)
294
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
295
* @param env pointer to environment struct
296
* @param i index of the item to return
297
* @param arg_instances element to set adb_ccInstanceType_t* to the array
298
* @return ith adb_ccInstanceType_t* of the array
300
axis2_status_t AXIS2_CALL
301
adb_describeInstancesResponseType_set_instances_at(
302
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
303
const axutil_env_t *env, int i,
304
adb_ccInstanceType_t* arg_instances);
309
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
310
* @param env pointer to environment struct
311
* @param arg_instances element to add adb_ccInstanceType_t* to the array
312
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
314
axis2_status_t AXIS2_CALL
315
adb_describeInstancesResponseType_add_instances(
316
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
317
const axutil_env_t *env,
318
adb_ccInstanceType_t* arg_instances);
321
* Get the size of the instances array.
322
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
323
* @param env pointer to environment struct.
324
* @return the size of the instances array.
327
adb_describeInstancesResponseType_sizeof_instances(
328
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
329
const axutil_env_t *env);
332
* Remove the ith element of instances.
333
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
334
* @param env pointer to environment struct
335
* @param i index of the item to remove
336
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
338
axis2_status_t AXIS2_CALL
339
adb_describeInstancesResponseType_remove_instances_at(
340
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
341
const axutil_env_t *env, int i);
346
/******************************* Checking and Setting NIL values *********************************/
347
/* Use 'Checking and Setting NIL values for Arrays' to check and set nil for individual elements */
350
* NOTE: set_nil is only available for nillable properties
356
* Check whether correlationId is nill
357
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
358
* @param env pointer to environment struct
359
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
361
axis2_bool_t AXIS2_CALL
362
adb_describeInstancesResponseType_is_correlationId_nil(
363
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
364
const axutil_env_t *env);
370
* Check whether userId is nill
371
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
372
* @param env pointer to environment struct
373
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
375
axis2_bool_t AXIS2_CALL
376
adb_describeInstancesResponseType_is_userId_nil(
377
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
378
const axutil_env_t *env);
384
* Check whether statusMessage is nill
385
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
386
* @param env pointer to environment struct
387
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
389
axis2_bool_t AXIS2_CALL
390
adb_describeInstancesResponseType_is_statusMessage_nil(
391
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
392
const axutil_env_t *env);
397
* Set statusMessage to nill (currently the same as reset)
398
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
399
* @param env pointer to environment struct
400
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
402
axis2_status_t AXIS2_CALL
403
adb_describeInstancesResponseType_set_statusMessage_nil(
404
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
405
const axutil_env_t *env);
409
* Check whether return is nill
410
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
411
* @param env pointer to environment struct
412
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
414
axis2_bool_t AXIS2_CALL
415
adb_describeInstancesResponseType_is_return_nil(
416
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
417
const axutil_env_t *env);
423
* Check whether instances is nill
424
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
425
* @param env pointer to environment struct
426
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
428
axis2_bool_t AXIS2_CALL
429
adb_describeInstancesResponseType_is_instances_nil(
430
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
431
const axutil_env_t *env);
436
* Set instances to nill (currently the same as reset)
437
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
438
* @param env pointer to environment struct
439
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
441
axis2_status_t AXIS2_CALL
442
adb_describeInstancesResponseType_set_instances_nil(
443
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
444
const axutil_env_t *env);
446
/*************************** Checking and Setting 'NIL' values in Arrays *****************************/
449
* NOTE: You may set this to remove specific elements in the array
450
* But you can not remove elements, if the specific property is declared to be non-nillable or sizeof(array) < minOccurs
454
* Check whether instances is nill at i
455
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
456
* @param env pointer to environment struct.
457
* @param i index of the item to return.
458
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
460
axis2_bool_t AXIS2_CALL
461
adb_describeInstancesResponseType_is_instances_nil_at(
462
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
463
const axutil_env_t *env, int i);
467
* Set instances to nill at i
468
* @param _describeInstancesResponseType _ adb_describeInstancesResponseType_t object
469
* @param env pointer to environment struct.
470
* @param i index of the item to set.
471
* @return AXIS2_SUCCESS on success, or AXIS2_FAILURE otherwise.
473
axis2_status_t AXIS2_CALL
474
adb_describeInstancesResponseType_set_instances_nil_at(
475
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
476
const axutil_env_t *env, int i);
480
/**************************** Serialize and Deserialize functions ***************************/
481
/*********** These functions are for use only inside the generated code *********************/
485
* Deserialize an XML to adb objects
486
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
487
* @param env pointer to environment struct
488
* @param dp_parent double pointer to the parent node to deserialize
489
* @param dp_is_early_node_valid double pointer to a flag (is_early_node_valid?)
490
* @param dont_care_minoccurs Dont set errors on validating minoccurs,
491
* (Parent will order this in a case of choice)
492
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
494
axis2_status_t AXIS2_CALL
495
adb_describeInstancesResponseType_deserialize(
496
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
497
const axutil_env_t *env,
498
axiom_node_t** dp_parent,
499
axis2_bool_t *dp_is_early_node_valid,
500
axis2_bool_t dont_care_minoccurs);
505
* Declare namespace in the most parent node
506
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
507
* @param env pointer to environment struct
508
* @param parent_element parent element
509
* @param namespaces hash of namespace uri to prefix
510
* @param next_ns_index pointer to an int which contain the next namespace index
513
adb_describeInstancesResponseType_declare_parent_namespaces(
514
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
515
const axutil_env_t *env, axiom_element_t *parent_element,
516
axutil_hash_t *namespaces, int *next_ns_index);
521
* Serialize to an XML from the adb objects
522
* @param _describeInstancesResponseType adb_describeInstancesResponseType_t object
523
* @param env pointer to environment struct
524
* @param describeInstancesResponseType_om_node node to serialize from
525
* @param describeInstancesResponseType_om_element parent element to serialize from
526
* @param tag_closed whether the parent tag is closed or not
527
* @param namespaces hash of namespace uri to prefix
528
* @param next_ns_index an int which contain the next namespace index
529
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
531
axiom_node_t* AXIS2_CALL
532
adb_describeInstancesResponseType_serialize(
533
adb_describeInstancesResponseType_t* _describeInstancesResponseType,
534
const axutil_env_t *env,
535
axiom_node_t* describeInstancesResponseType_om_node, axiom_element_t *describeInstancesResponseType_om_element, int tag_closed, axutil_hash_t *namespaces, int *next_ns_index);
538
* Check whether the adb_describeInstancesResponseType is a particle class (E.g. group, inner sequence)
539
* @return whether this is a particle class.
541
axis2_bool_t AXIS2_CALL
542
adb_describeInstancesResponseType_is_particle();
549
#endif /* ADB_DESCRIBEINSTANCESRESPONSETYPE_H */