3
#ifndef ADB_NCDESCRIBEINSTANCESTYPE_H
4
#define ADB_NCDESCRIBEINSTANCESTYPE_H
7
* adb_ncDescribeInstancesType.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_ncDescribeInstancesType class
16
typedef struct adb_ncDescribeInstancesType adb_ncDescribeInstancesType_t;
22
#include <axis2_util.h>
23
#include <axiom_soap.h>
24
#include <axis2_client.h>
31
#define ADB_DEFAULT_DIGIT_LIMIT 64
32
#define ADB_DEFAULT_NAMESPACE_PREFIX_LIMIT 64
35
/******************************* Create and Free functions *********************************/
38
* Constructor for creating adb_ncDescribeInstancesType_t
39
* @param env pointer to environment struct
40
* @return newly created adb_ncDescribeInstancesType_t object
42
adb_ncDescribeInstancesType_t* AXIS2_CALL
43
adb_ncDescribeInstancesType_create(
44
const axutil_env_t *env );
47
* Free adb_ncDescribeInstancesType_t object
48
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object to free
49
* @param env pointer to environment struct
50
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
52
axis2_status_t AXIS2_CALL
53
adb_ncDescribeInstancesType_free (
54
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
55
const axutil_env_t *env);
59
/********************************** Getters and Setters **************************************/
60
/******** Deprecated for array types, Use 'Getters and Setters for Arrays' instead ***********/
64
* Getter for correlationId.
65
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
66
* @param env pointer to environment struct
67
* @return axis2_char_t*
69
axis2_char_t* AXIS2_CALL
70
adb_ncDescribeInstancesType_get_correlationId(
71
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
72
const axutil_env_t *env);
75
* Setter for correlationId.
76
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
77
* @param env pointer to environment struct
78
* @param arg_correlationId axis2_char_t*
79
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
81
axis2_status_t AXIS2_CALL
82
adb_ncDescribeInstancesType_set_correlationId(
83
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
84
const axutil_env_t *env,
85
const axis2_char_t* arg_correlationId);
88
* Resetter for correlationId
89
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
90
* @param env pointer to environment struct
91
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
93
axis2_status_t AXIS2_CALL
94
adb_ncDescribeInstancesType_reset_correlationId(
95
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
96
const axutil_env_t *env);
103
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
104
* @param env pointer to environment struct
105
* @return axis2_char_t*
107
axis2_char_t* AXIS2_CALL
108
adb_ncDescribeInstancesType_get_userId(
109
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
110
const axutil_env_t *env);
114
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
115
* @param env pointer to environment struct
116
* @param arg_userId axis2_char_t*
117
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
119
axis2_status_t AXIS2_CALL
120
adb_ncDescribeInstancesType_set_userId(
121
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
122
const axutil_env_t *env,
123
const axis2_char_t* arg_userId);
126
* Resetter for userId
127
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
128
* @param env pointer to environment struct
129
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
131
axis2_status_t AXIS2_CALL
132
adb_ncDescribeInstancesType_reset_userId(
133
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
134
const axutil_env_t *env);
141
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
142
* @param env pointer to environment struct
143
* @return axis2_bool_t
145
axis2_bool_t AXIS2_CALL
146
adb_ncDescribeInstancesType_get_return(
147
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
148
const axutil_env_t *env);
152
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
153
* @param env pointer to environment struct
154
* @param arg_return axis2_bool_t
155
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
157
axis2_status_t AXIS2_CALL
158
adb_ncDescribeInstancesType_set_return(
159
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
160
const axutil_env_t *env,
161
axis2_bool_t arg_return);
164
* Resetter for return
165
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
166
* @param env pointer to environment struct
167
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
169
axis2_status_t AXIS2_CALL
170
adb_ncDescribeInstancesType_reset_return(
171
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
172
const axutil_env_t *env);
178
* Getter for statusMessage.
179
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
180
* @param env pointer to environment struct
184
adb_ncDescribeInstancesType_get_statusMessage(
185
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
186
const axutil_env_t *env);
189
* Setter for statusMessage.
190
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
191
* @param env pointer to environment struct
192
* @param arg_statusMessage int
193
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
195
axis2_status_t AXIS2_CALL
196
adb_ncDescribeInstancesType_set_statusMessage(
197
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
198
const axutil_env_t *env,
199
const int arg_statusMessage);
202
* Resetter for statusMessage
203
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
204
* @param env pointer to environment struct
205
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
207
axis2_status_t AXIS2_CALL
208
adb_ncDescribeInstancesType_reset_statusMessage(
209
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
210
const axutil_env_t *env);
216
* Getter for instanceIds. Deprecated for array types, Use adb_ncDescribeInstancesType_get_instanceIds_at instead
217
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
218
* @param env pointer to environment struct
219
* @return Array of axis2_char_t*s.
221
axutil_array_list_t* AXIS2_CALL
222
adb_ncDescribeInstancesType_get_instanceIds(
223
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
224
const axutil_env_t *env);
227
* Setter for instanceIds.Deprecated for array types, Use adb_ncDescribeInstancesType_set_instanceIds_at
228
* or adb_ncDescribeInstancesType_add_instanceIds instead.
229
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
230
* @param env pointer to environment struct
231
* @param arg_instanceIds Array of axis2_char_t*s.
232
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
234
axis2_status_t AXIS2_CALL
235
adb_ncDescribeInstancesType_set_instanceIds(
236
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
237
const axutil_env_t *env,
238
axutil_array_list_t* arg_instanceIds);
241
* Resetter for instanceIds
242
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
243
* @param env pointer to environment struct
244
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
246
axis2_status_t AXIS2_CALL
247
adb_ncDescribeInstancesType_reset_instanceIds(
248
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
249
const axutil_env_t *env);
252
/****************************** Getters and Setters For Arrays **********************************/
253
/************ Array Specific Operations: get_at, set_at, add, remove_at, sizeof *****************/
256
* E.g. use of get_at, set_at, add and sizeof
258
* for(i = 0; i < adb_element_sizeof_property(adb_object, env); i ++ )
260
* // Getting ith value to property_object variable
261
* property_object = adb_element_get_property_at(adb_object, env, i);
263
* // Setting ith value from property_object variable
264
* adb_element_set_property_at(adb_object, env, i, property_object);
266
* // Appending the value to the end of the array from property_object variable
267
* adb_element_add_property(adb_object, env, property_object);
269
* // Removing the ith value from an array
270
* adb_element_remove_property_at(adb_object, env, i);
279
* Get the ith element of instanceIds.
280
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
281
* @param env pointer to environment struct
282
* @param i index of the item to return
283
* @return ith axis2_char_t* of the array
285
axis2_char_t* AXIS2_CALL
286
adb_ncDescribeInstancesType_get_instanceIds_at(
287
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
288
const axutil_env_t *env, int i);
291
* Set the ith element of instanceIds. (If the ith already exist, it will be replaced)
292
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
293
* @param env pointer to environment struct
294
* @param i index of the item to return
295
* @param arg_instanceIds element to set axis2_char_t* to the array
296
* @return ith axis2_char_t* of the array
298
axis2_status_t AXIS2_CALL
299
adb_ncDescribeInstancesType_set_instanceIds_at(
300
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
301
const axutil_env_t *env, int i,
302
const axis2_char_t* arg_instanceIds);
306
* Add to instanceIds.
307
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
308
* @param env pointer to environment struct
309
* @param arg_instanceIds element to add axis2_char_t* to the array
310
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
312
axis2_status_t AXIS2_CALL
313
adb_ncDescribeInstancesType_add_instanceIds(
314
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
315
const axutil_env_t *env,
316
const axis2_char_t* arg_instanceIds);
319
* Get the size of the instanceIds array.
320
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
321
* @param env pointer to environment struct.
322
* @return the size of the instanceIds array.
325
adb_ncDescribeInstancesType_sizeof_instanceIds(
326
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
327
const axutil_env_t *env);
330
* Remove the ith element of instanceIds.
331
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
332
* @param env pointer to environment struct
333
* @param i index of the item to remove
334
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
336
axis2_status_t AXIS2_CALL
337
adb_ncDescribeInstancesType_remove_instanceIds_at(
338
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
339
const axutil_env_t *env, int i);
344
/******************************* Checking and Setting NIL values *********************************/
345
/* Use 'Checking and Setting NIL values for Arrays' to check and set nil for individual elements */
348
* NOTE: set_nil is only available for nillable properties
354
* Check whether correlationId is nill
355
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
356
* @param env pointer to environment struct
357
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
359
axis2_bool_t AXIS2_CALL
360
adb_ncDescribeInstancesType_is_correlationId_nil(
361
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
362
const axutil_env_t *env);
368
* Check whether userId is nill
369
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
370
* @param env pointer to environment struct
371
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
373
axis2_bool_t AXIS2_CALL
374
adb_ncDescribeInstancesType_is_userId_nil(
375
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
376
const axutil_env_t *env);
382
* Check whether return is nill
383
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
384
* @param env pointer to environment struct
385
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
387
axis2_bool_t AXIS2_CALL
388
adb_ncDescribeInstancesType_is_return_nil(
389
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
390
const axutil_env_t *env);
396
* Check whether statusMessage is nill
397
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
398
* @param env pointer to environment struct
399
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
401
axis2_bool_t AXIS2_CALL
402
adb_ncDescribeInstancesType_is_statusMessage_nil(
403
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
404
const axutil_env_t *env);
409
* Set statusMessage to nill (currently the same as reset)
410
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
411
* @param env pointer to environment struct
412
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
414
axis2_status_t AXIS2_CALL
415
adb_ncDescribeInstancesType_set_statusMessage_nil(
416
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
417
const axutil_env_t *env);
421
* Check whether instanceIds is nill
422
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
423
* @param env pointer to environment struct
424
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
426
axis2_bool_t AXIS2_CALL
427
adb_ncDescribeInstancesType_is_instanceIds_nil(
428
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
429
const axutil_env_t *env);
433
/*************************** Checking and Setting 'NIL' values in Arrays *****************************/
436
* NOTE: You may set this to remove specific elements in the array
437
* But you can not remove elements, if the specific property is declared to be non-nillable or sizeof(array) < minOccurs
441
* Check whether instanceIds is nill at i
442
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
443
* @param env pointer to environment struct.
444
* @param i index of the item to return.
445
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
447
axis2_bool_t AXIS2_CALL
448
adb_ncDescribeInstancesType_is_instanceIds_nil_at(
449
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
450
const axutil_env_t *env, int i);
454
* Set instanceIds to nill at i
455
* @param _ncDescribeInstancesType _ adb_ncDescribeInstancesType_t object
456
* @param env pointer to environment struct.
457
* @param i index of the item to set.
458
* @return AXIS2_SUCCESS on success, or AXIS2_FAILURE otherwise.
460
axis2_status_t AXIS2_CALL
461
adb_ncDescribeInstancesType_set_instanceIds_nil_at(
462
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
463
const axutil_env_t *env, int i);
467
/**************************** Serialize and Deserialize functions ***************************/
468
/*********** These functions are for use only inside the generated code *********************/
472
* Deserialize an XML to adb objects
473
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
474
* @param env pointer to environment struct
475
* @param dp_parent double pointer to the parent node to deserialize
476
* @param dp_is_early_node_valid double pointer to a flag (is_early_node_valid?)
477
* @param dont_care_minoccurs Dont set errors on validating minoccurs,
478
* (Parent will order this in a case of choice)
479
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
481
axis2_status_t AXIS2_CALL
482
adb_ncDescribeInstancesType_deserialize(
483
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
484
const axutil_env_t *env,
485
axiom_node_t** dp_parent,
486
axis2_bool_t *dp_is_early_node_valid,
487
axis2_bool_t dont_care_minoccurs);
492
* Declare namespace in the most parent node
493
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
494
* @param env pointer to environment struct
495
* @param parent_element parent element
496
* @param namespaces hash of namespace uri to prefix
497
* @param next_ns_index pointer to an int which contain the next namespace index
500
adb_ncDescribeInstancesType_declare_parent_namespaces(
501
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
502
const axutil_env_t *env, axiom_element_t *parent_element,
503
axutil_hash_t *namespaces, int *next_ns_index);
508
* Serialize to an XML from the adb objects
509
* @param _ncDescribeInstancesType adb_ncDescribeInstancesType_t object
510
* @param env pointer to environment struct
511
* @param ncDescribeInstancesType_om_node node to serialize from
512
* @param ncDescribeInstancesType_om_element parent element to serialize from
513
* @param tag_closed whether the parent tag is closed or not
514
* @param namespaces hash of namespace uri to prefix
515
* @param next_ns_index an int which contain the next namespace index
516
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
518
axiom_node_t* AXIS2_CALL
519
adb_ncDescribeInstancesType_serialize(
520
adb_ncDescribeInstancesType_t* _ncDescribeInstancesType,
521
const axutil_env_t *env,
522
axiom_node_t* ncDescribeInstancesType_om_node, axiom_element_t *ncDescribeInstancesType_om_element, int tag_closed, axutil_hash_t *namespaces, int *next_ns_index);
525
* Check whether the adb_ncDescribeInstancesType is a particle class (E.g. group, inner sequence)
526
* @return whether this is a particle class.
528
axis2_bool_t AXIS2_CALL
529
adb_ncDescribeInstancesType_is_particle();
536
#endif /* ADB_NCDESCRIBEINSTANCESTYPE_H */
added
removed
node/generated/adb_ncDescribeInstancesType.h
