3
#ifndef ADB_NCSTARTNETWORKTYPE_H
4
#define ADB_NCSTARTNETWORKTYPE_H
7
* adb_ncStartNetworkType.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_ncStartNetworkType class
16
typedef struct adb_ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_t
39
* @param env pointer to environment struct
40
* @return newly created adb_ncStartNetworkType_t object
42
adb_ncStartNetworkType_t* AXIS2_CALL
43
adb_ncStartNetworkType_create(
44
const axutil_env_t *env );
47
* Free adb_ncStartNetworkType_t object
48
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_free (
54
adb_ncStartNetworkType_t* _ncStartNetworkType,
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 _ncStartNetworkType adb_ncStartNetworkType_t object
66
* @param env pointer to environment struct
67
* @return axis2_char_t*
69
axis2_char_t* AXIS2_CALL
70
adb_ncStartNetworkType_get_correlationId(
71
adb_ncStartNetworkType_t* _ncStartNetworkType,
72
const axutil_env_t *env);
75
* Setter for correlationId.
76
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_set_correlationId(
83
adb_ncStartNetworkType_t* _ncStartNetworkType,
84
const axutil_env_t *env,
85
const axis2_char_t* arg_correlationId);
88
* Resetter for correlationId
89
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_reset_correlationId(
95
adb_ncStartNetworkType_t* _ncStartNetworkType,
96
const axutil_env_t *env);
103
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
104
* @param env pointer to environment struct
105
* @return axis2_char_t*
107
axis2_char_t* AXIS2_CALL
108
adb_ncStartNetworkType_get_userId(
109
adb_ncStartNetworkType_t* _ncStartNetworkType,
110
const axutil_env_t *env);
114
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_set_userId(
121
adb_ncStartNetworkType_t* _ncStartNetworkType,
122
const axutil_env_t *env,
123
const axis2_char_t* arg_userId);
126
* Resetter for userId
127
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_reset_userId(
133
adb_ncStartNetworkType_t* _ncStartNetworkType,
134
const axutil_env_t *env);
141
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
142
* @param env pointer to environment struct
143
* @return axis2_bool_t
145
axis2_bool_t AXIS2_CALL
146
adb_ncStartNetworkType_get_return(
147
adb_ncStartNetworkType_t* _ncStartNetworkType,
148
const axutil_env_t *env);
152
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_set_return(
159
adb_ncStartNetworkType_t* _ncStartNetworkType,
160
const axutil_env_t *env,
161
axis2_bool_t arg_return);
164
* Resetter for return
165
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_reset_return(
171
adb_ncStartNetworkType_t* _ncStartNetworkType,
172
const axutil_env_t *env);
178
* Getter for statusMessage.
179
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
180
* @param env pointer to environment struct
184
adb_ncStartNetworkType_get_statusMessage(
185
adb_ncStartNetworkType_t* _ncStartNetworkType,
186
const axutil_env_t *env);
189
* Setter for statusMessage.
190
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_set_statusMessage(
197
adb_ncStartNetworkType_t* _ncStartNetworkType,
198
const axutil_env_t *env,
199
const int arg_statusMessage);
202
* Resetter for statusMessage
203
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_reset_statusMessage(
209
adb_ncStartNetworkType_t* _ncStartNetworkType,
210
const axutil_env_t *env);
216
* Getter for remoteHosts. Deprecated for array types, Use adb_ncStartNetworkType_get_remoteHosts_at instead
217
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_get_remoteHosts(
223
adb_ncStartNetworkType_t* _ncStartNetworkType,
224
const axutil_env_t *env);
227
* Setter for remoteHosts.Deprecated for array types, Use adb_ncStartNetworkType_set_remoteHosts_at
228
* or adb_ncStartNetworkType_add_remoteHosts instead.
229
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
230
* @param env pointer to environment struct
231
* @param arg_remoteHosts Array of axis2_char_t*s.
232
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
234
axis2_status_t AXIS2_CALL
235
adb_ncStartNetworkType_set_remoteHosts(
236
adb_ncStartNetworkType_t* _ncStartNetworkType,
237
const axutil_env_t *env,
238
axutil_array_list_t* arg_remoteHosts);
241
* Resetter for remoteHosts
242
* @param _ncStartNetworkType adb_ncStartNetworkType_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_ncStartNetworkType_reset_remoteHosts(
248
adb_ncStartNetworkType_t* _ncStartNetworkType,
249
const axutil_env_t *env);
255
* Getter for remoteHostPort.
256
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
257
* @param env pointer to environment struct
261
adb_ncStartNetworkType_get_remoteHostPort(
262
adb_ncStartNetworkType_t* _ncStartNetworkType,
263
const axutil_env_t *env);
266
* Setter for remoteHostPort.
267
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
268
* @param env pointer to environment struct
269
* @param arg_remoteHostPort int
270
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
272
axis2_status_t AXIS2_CALL
273
adb_ncStartNetworkType_set_remoteHostPort(
274
adb_ncStartNetworkType_t* _ncStartNetworkType,
275
const axutil_env_t *env,
276
const int arg_remoteHostPort);
279
* Resetter for remoteHostPort
280
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
281
* @param env pointer to environment struct
282
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
284
axis2_status_t AXIS2_CALL
285
adb_ncStartNetworkType_reset_remoteHostPort(
286
adb_ncStartNetworkType_t* _ncStartNetworkType,
287
const axutil_env_t *env);
294
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
295
* @param env pointer to environment struct
299
adb_ncStartNetworkType_get_vlan(
300
adb_ncStartNetworkType_t* _ncStartNetworkType,
301
const axutil_env_t *env);
305
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
306
* @param env pointer to environment struct
307
* @param arg_vlan int
308
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
310
axis2_status_t AXIS2_CALL
311
adb_ncStartNetworkType_set_vlan(
312
adb_ncStartNetworkType_t* _ncStartNetworkType,
313
const axutil_env_t *env,
318
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
319
* @param env pointer to environment struct
320
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
322
axis2_status_t AXIS2_CALL
323
adb_ncStartNetworkType_reset_vlan(
324
adb_ncStartNetworkType_t* _ncStartNetworkType,
325
const axutil_env_t *env);
328
/****************************** Getters and Setters For Arrays **********************************/
329
/************ Array Specific Operations: get_at, set_at, add, remove_at, sizeof *****************/
332
* E.g. use of get_at, set_at, add and sizeof
334
* for(i = 0; i < adb_element_sizeof_property(adb_object, env); i ++ )
336
* // Getting ith value to property_object variable
337
* property_object = adb_element_get_property_at(adb_object, env, i);
339
* // Setting ith value from property_object variable
340
* adb_element_set_property_at(adb_object, env, i, property_object);
342
* // Appending the value to the end of the array from property_object variable
343
* adb_element_add_property(adb_object, env, property_object);
345
* // Removing the ith value from an array
346
* adb_element_remove_property_at(adb_object, env, i);
355
* Get the ith element of remoteHosts.
356
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
357
* @param env pointer to environment struct
358
* @param i index of the item to return
359
* @return ith axis2_char_t* of the array
361
axis2_char_t* AXIS2_CALL
362
adb_ncStartNetworkType_get_remoteHosts_at(
363
adb_ncStartNetworkType_t* _ncStartNetworkType,
364
const axutil_env_t *env, int i);
367
* Set the ith element of remoteHosts. (If the ith already exist, it will be replaced)
368
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
369
* @param env pointer to environment struct
370
* @param i index of the item to return
371
* @param arg_remoteHosts element to set axis2_char_t* to the array
372
* @return ith axis2_char_t* of the array
374
axis2_status_t AXIS2_CALL
375
adb_ncStartNetworkType_set_remoteHosts_at(
376
adb_ncStartNetworkType_t* _ncStartNetworkType,
377
const axutil_env_t *env, int i,
378
const axis2_char_t* arg_remoteHosts);
382
* Add to remoteHosts.
383
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
384
* @param env pointer to environment struct
385
* @param arg_remoteHosts element to add axis2_char_t* to the array
386
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
388
axis2_status_t AXIS2_CALL
389
adb_ncStartNetworkType_add_remoteHosts(
390
adb_ncStartNetworkType_t* _ncStartNetworkType,
391
const axutil_env_t *env,
392
const axis2_char_t* arg_remoteHosts);
395
* Get the size of the remoteHosts array.
396
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
397
* @param env pointer to environment struct.
398
* @return the size of the remoteHosts array.
401
adb_ncStartNetworkType_sizeof_remoteHosts(
402
adb_ncStartNetworkType_t* _ncStartNetworkType,
403
const axutil_env_t *env);
406
* Remove the ith element of remoteHosts.
407
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
408
* @param env pointer to environment struct
409
* @param i index of the item to remove
410
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
412
axis2_status_t AXIS2_CALL
413
adb_ncStartNetworkType_remove_remoteHosts_at(
414
adb_ncStartNetworkType_t* _ncStartNetworkType,
415
const axutil_env_t *env, int i);
420
/******************************* Checking and Setting NIL values *********************************/
421
/* Use 'Checking and Setting NIL values for Arrays' to check and set nil for individual elements */
424
* NOTE: set_nil is only available for nillable properties
430
* Check whether correlationId is nill
431
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
432
* @param env pointer to environment struct
433
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
435
axis2_bool_t AXIS2_CALL
436
adb_ncStartNetworkType_is_correlationId_nil(
437
adb_ncStartNetworkType_t* _ncStartNetworkType,
438
const axutil_env_t *env);
444
* Check whether userId is nill
445
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
446
* @param env pointer to environment struct
447
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
449
axis2_bool_t AXIS2_CALL
450
adb_ncStartNetworkType_is_userId_nil(
451
adb_ncStartNetworkType_t* _ncStartNetworkType,
452
const axutil_env_t *env);
458
* Check whether return is nill
459
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
460
* @param env pointer to environment struct
461
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
463
axis2_bool_t AXIS2_CALL
464
adb_ncStartNetworkType_is_return_nil(
465
adb_ncStartNetworkType_t* _ncStartNetworkType,
466
const axutil_env_t *env);
472
* Check whether statusMessage is nill
473
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
474
* @param env pointer to environment struct
475
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
477
axis2_bool_t AXIS2_CALL
478
adb_ncStartNetworkType_is_statusMessage_nil(
479
adb_ncStartNetworkType_t* _ncStartNetworkType,
480
const axutil_env_t *env);
485
* Set statusMessage to nill (currently the same as reset)
486
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
487
* @param env pointer to environment struct
488
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
490
axis2_status_t AXIS2_CALL
491
adb_ncStartNetworkType_set_statusMessage_nil(
492
adb_ncStartNetworkType_t* _ncStartNetworkType,
493
const axutil_env_t *env);
497
* Check whether remoteHosts is nill
498
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
499
* @param env pointer to environment struct
500
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
502
axis2_bool_t AXIS2_CALL
503
adb_ncStartNetworkType_is_remoteHosts_nil(
504
adb_ncStartNetworkType_t* _ncStartNetworkType,
505
const axutil_env_t *env);
511
* Check whether remoteHostPort is nill
512
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
513
* @param env pointer to environment struct
514
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
516
axis2_bool_t AXIS2_CALL
517
adb_ncStartNetworkType_is_remoteHostPort_nil(
518
adb_ncStartNetworkType_t* _ncStartNetworkType,
519
const axutil_env_t *env);
525
* Check whether vlan is nill
526
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
527
* @param env pointer to environment struct
528
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
530
axis2_bool_t AXIS2_CALL
531
adb_ncStartNetworkType_is_vlan_nil(
532
adb_ncStartNetworkType_t* _ncStartNetworkType,
533
const axutil_env_t *env);
537
/*************************** Checking and Setting 'NIL' values in Arrays *****************************/
540
* NOTE: You may set this to remove specific elements in the array
541
* But you can not remove elements, if the specific property is declared to be non-nillable or sizeof(array) < minOccurs
545
* Check whether remoteHosts is nill at i
546
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
547
* @param env pointer to environment struct.
548
* @param i index of the item to return.
549
* @return AXIS2_TRUE if the element is nil or AXIS2_FALSE otherwise
551
axis2_bool_t AXIS2_CALL
552
adb_ncStartNetworkType_is_remoteHosts_nil_at(
553
adb_ncStartNetworkType_t* _ncStartNetworkType,
554
const axutil_env_t *env, int i);
558
* Set remoteHosts to nill at i
559
* @param _ncStartNetworkType _ adb_ncStartNetworkType_t object
560
* @param env pointer to environment struct.
561
* @param i index of the item to set.
562
* @return AXIS2_SUCCESS on success, or AXIS2_FAILURE otherwise.
564
axis2_status_t AXIS2_CALL
565
adb_ncStartNetworkType_set_remoteHosts_nil_at(
566
adb_ncStartNetworkType_t* _ncStartNetworkType,
567
const axutil_env_t *env, int i);
571
/**************************** Serialize and Deserialize functions ***************************/
572
/*********** These functions are for use only inside the generated code *********************/
576
* Deserialize an XML to adb objects
577
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
578
* @param env pointer to environment struct
579
* @param dp_parent double pointer to the parent node to deserialize
580
* @param dp_is_early_node_valid double pointer to a flag (is_early_node_valid?)
581
* @param dont_care_minoccurs Dont set errors on validating minoccurs,
582
* (Parent will order this in a case of choice)
583
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
585
axis2_status_t AXIS2_CALL
586
adb_ncStartNetworkType_deserialize(
587
adb_ncStartNetworkType_t* _ncStartNetworkType,
588
const axutil_env_t *env,
589
axiom_node_t** dp_parent,
590
axis2_bool_t *dp_is_early_node_valid,
591
axis2_bool_t dont_care_minoccurs);
596
* Declare namespace in the most parent node
597
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
598
* @param env pointer to environment struct
599
* @param parent_element parent element
600
* @param namespaces hash of namespace uri to prefix
601
* @param next_ns_index pointer to an int which contain the next namespace index
604
adb_ncStartNetworkType_declare_parent_namespaces(
605
adb_ncStartNetworkType_t* _ncStartNetworkType,
606
const axutil_env_t *env, axiom_element_t *parent_element,
607
axutil_hash_t *namespaces, int *next_ns_index);
612
* Serialize to an XML from the adb objects
613
* @param _ncStartNetworkType adb_ncStartNetworkType_t object
614
* @param env pointer to environment struct
615
* @param ncStartNetworkType_om_node node to serialize from
616
* @param ncStartNetworkType_om_element parent element to serialize from
617
* @param tag_closed whether the parent tag is closed or not
618
* @param namespaces hash of namespace uri to prefix
619
* @param next_ns_index an int which contain the next namespace index
620
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
622
axiom_node_t* AXIS2_CALL
623
adb_ncStartNetworkType_serialize(
624
adb_ncStartNetworkType_t* _ncStartNetworkType,
625
const axutil_env_t *env,
626
axiom_node_t* ncStartNetworkType_om_node, axiom_element_t *ncStartNetworkType_om_element, int tag_closed, axutil_hash_t *namespaces, int *next_ns_index);
629
* Check whether the adb_ncStartNetworkType is a particle class (E.g. group, inner sequence)
630
* @return whether this is a particle class.
632
axis2_bool_t AXIS2_CALL
633
adb_ncStartNetworkType_is_particle();
640
#endif /* ADB_NCSTARTNETWORKTYPE_H */