axiom_soap_fault_ops Struct Reference
[soap fault]

soap_fault operations struct ops Encapsulator struct of axiom_soap fault More...

#include <axiom_soap_fault.h>

List of all members.

Public Attributes

axis2_status_t(* free_fn )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axiom_soap_fault_code *(* get_code )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axiom_soap_fault_reason *(* get_reason )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axiom_soap_fault_node *(* get_node )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axiom_soap_fault_role *(* get_role )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axiom_soap_fault_detail *(* get_detail )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axis2_char_t *(* get_exception )(axiom_soap_fault_t *fault, const axis2_env_t *env)
axis2_status_t(* set_exception )(axiom_soap_fault_t *fault, const axis2_env_t *env, axis2_char_t *exception)
axiom_node_t *(* get_base_node )(axiom_soap_fault_t *fault, const axis2_env_t *env)


Detailed Description

soap_fault operations struct ops Encapsulator struct of axiom_soap fault


Member Data Documentation

axis2_status_t( * axiom_soap_fault_ops::free_fn)(axiom_soap_fault_t *fault, const axis2_env_t *env)

Free an axiom_soap_fault

Parameters:
fault pointer to soap_fault struct
env Environment. MUST NOT be NULL
Returns:
status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axiom_node_t*( * axiom_soap_fault_ops::get_base_node)(axiom_soap_fault_t *fault, const axis2_env_t *env)

returns the axiom_node_t struct which is wrapped by this soap fault struct

Parameters:
fault soap fault struct
env environment must not be NULL
Returns:
a pointer to axiom_node_t struct if an om node is associated with this soap fault struct, otherwise return NULL

struct axiom_soap_fault_code*( * axiom_soap_fault_ops::get_code)(axiom_soap_fault_t *fault, const axis2_env_t *env)

this function returns a axiom_soap_fault_code struct if a fault code is associated with this soap fault only valid when called after building the soap fault

Parameters:
fault soap fault struct
env environment must not be NULL
Returns:
pointer to soap_fault_code struct if one is associated with this soap_fault struct , NULL is returned otherwise

struct axiom_soap_fault_detail*( * axiom_soap_fault_ops::get_detail)(axiom_soap_fault_t *fault, const axis2_env_t *env)

Parameters:
fault soap fault struct
env environment must not be NULL
Returns:
a pointer to soap_fault_code struct if one is associated with this soap_fault struct , NULL is returned otherwise

axis2_char_t*( * axiom_soap_fault_ops::get_exception)(axiom_soap_fault_t *fault, const axis2_env_t *env)

Parameters:
fault soap fault struct
env enviroment must not be NULL
Returns:
a pointer to soap_fault_code struct if one is associated with this soap_fault struct , NULL is returned otherwise

struct axiom_soap_fault_node*( * axiom_soap_fault_ops::get_node)(axiom_soap_fault_t *fault, const axis2_env_t *env)

Parameters:
fault soap fault struct
env environment must not be NULL
Returns:
pointer to soap_fault_node struct if one is associated with this soap_fault struct , NULL is returned otherwise

struct axiom_soap_fault_reason*( * axiom_soap_fault_ops::get_reason)(axiom_soap_fault_t *fault, const axis2_env_t *env)

Parameters:
fault soap fault struct
env environment must not be NULL
Returns:
pointer to soap_fault_reason struct if one is associated with this soap_fault struct , NULL is returned otherwise

struct axiom_soap_fault_role*( * axiom_soap_fault_ops::get_role)(axiom_soap_fault_t *fault, const axis2_env_t *env)

Parameters:
fault soap fault struct
env environment must not be NULL
Returns:
pointer to soap_fault_code struct if one is associated with this soap_fault struct , NULL is returned otherwise

axis2_status_t( * axiom_soap_fault_ops::set_exception)(axiom_soap_fault_t *fault, const axis2_env_t *env, axis2_char_t *exception)

set an error string

Parameters:
fualt soap fault struct
env enviroment must not be NULL
exception error message to be stored on soap fault


The documentation for this struct was generated from the following file:
Generated on Thu Oct 26 21:00:30 2006 for Axis2/C by  doxygen 1.4.7