axiom_soap_body_ops Struct Reference
[soap body]

soap_body operations struct ops Encapsulator struct of axiom_soap body More...

#include <axiom_soap_body.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axiom_soap_body_t *body, const axis2_env_t *env)
axis2_bool_t(* has_fault )(axiom_soap_body_t *body, const axis2_env_t *env)
axiom_soap_fault_t *(* get_fault )(axiom_soap_body_t *body, const axis2_env_t *env)
axiom_node_t *(* get_base_node )(axiom_soap_body_t *body, const axis2_env_t *env)
int(* get_soap_version )(axiom_soap_body_t *body, const axis2_env_t *env)
axis2_status_t(* build )(axiom_soap_body_t *body, const axis2_env_t *env)
axis2_status_t(* add_child )(axiom_soap_body_t *body, const axis2_env_t *env, axiom_node_t *child)


Detailed Description

soap_body operations struct ops Encapsulator struct of axiom_soap body


Member Data Documentation

axis2_status_t( * axiom_soap_body_ops::add_child)(axiom_soap_body_t *body, const axis2_env_t *env, axiom_node_t *child)

add an om node as the child to this soap_body the child is added to as the first child

Parameters:
body pointer to soap_body struct
env axis2_environment struct MUST not be NULL
Returns:
status code , AXIS2_SUCCESS on success , AXIS2_ERROR otherwise

axis2_status_t( * axiom_soap_body_ops::build)(axiom_soap_body_t *body, const axis2_env_t *env)

build the soap body completely . return the status code,

Returns:
AXIS2_SUCCESS on success and AXIS2_FAILURE on error

axis2_status_t( * axiom_soap_body_ops::free)(axiom_soap_body_t *body, const axis2_env_t *env)

Deallocate all the resources associated to soap_body But it does not deallocate the underlying om structure

Parameters:
body soap_body struct
env must not be null
Returns:
status code AXIS2_SUCCESS

axiom_node_t*( * axiom_soap_body_ops::get_base_node)(axiom_soap_body_t *body, const axis2_env_t *env)

get the underlying om_node

Parameters:
body soap_body
env environment must not be null
Returns:
axiom_node_t

axiom_soap_fault_t*( * axiom_soap_body_ops::get_fault)(axiom_soap_body_t *body, const axis2_env_t *env)

returns the soap fault in this soap_body IF a soap_builder is associated with the soap_body Pulling will take place

Parameters:
body soap_body
env environment must not be null
Returns:
axiom_soap_fault_t if available, NULL otherwise

int( * axiom_soap_body_ops::get_soap_version)(axiom_soap_body_t *body, const axis2_env_t *env)

return the soap version

Parameters:
body soap_body
env environment must not be null
Returns:
one of AXIOM_SOAP11 or AXIOM_SOAP12

axis2_bool_t( * axiom_soap_body_ops::has_fault)(axiom_soap_body_t *body, const axis2_env_t *env)

Indicates whether a soap fault is available with this soap body

Parameters:
body soap_body struct
env environment must not be null
Returns:
AXIS2_TRUE if fault is available, AXIS2_FALSE otherwise


The documentation for this struct was generated from the following file:
Generated on Tue Oct 3 20:48:18 2006 for Axis2/C by  doxygen 1.4.7