summaryrefslogtreecommitdiffstats
path: root/axiom/include/axiom_soap_fault_text.h
blob: 10a0465f7f354664ba9c81b7b5fe7394f8e5cc29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef AXIOM_SOAP_FAULT_TEXT_H
#define AXIOM_SOAP_FAULT_TEXT_H

/**
 * @file axiom_soap_fault_text.h
 * @brief axiom_soap_fault_text
 */
#include <axutil_env.h>
#include <axiom_soap_fault_reason.h>

#ifdef __cplusplus
extern "C"
{
#endif

    typedef struct axiom_soap_fault_text axiom_soap_fault_text_t;

    /**
     * @defgroup axiom_soap_fault_text soap fault text
     * @ingroup axiom_soap
     * @{
     */

    /**
      * creates a soap fault struct 
      * @param env Environment. MUST NOT be NULL
      * @param fault the SOAP fault reason
      *
      * @return Created SOAP fault text
      */
    AXIS2_EXTERN axiom_soap_fault_text_t *AXIS2_CALL
    axiom_soap_fault_text_create_with_parent(
        const axutil_env_t * env,
        axiom_soap_fault_reason_t * fault);

    /**
      * Free an axiom_soap_fault_text
      * @param  fault_text pointer to soap_fault_text struct
      * @param  env Environment. MUST NOT be NULL
      * @return satus of the op. AXIS2_SUCCESS on success 
      *         else AXIS2_FAILURE
      */
    AXIS2_EXTERN void AXIS2_CALL
    axiom_soap_fault_text_free(
        axiom_soap_fault_text_t * fault_text,
        const axutil_env_t * env);

    /**
      * Set the lang of the SOAP fault text
      * @param  fault_text pointer to soap_fault_text struct
      * @param  env Environment. MUST NOT be NULL
      * @param lang the string to be set
      * @return satus of the op. AXIS2_SUCCESS on success 
      *         else AXIS2_FAILURE
      */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axiom_soap_fault_text_set_lang(
        axiom_soap_fault_text_t * fault_text,
        const axutil_env_t * env,
        const axis2_char_t * lang);

    /**
      * Get the lang of the SOAP fault
      * @param  fault_text pointer to soap_fault_text struct
      * @param  env Environment. MUST NOT be NULL
      * 
      * @return the lang of the SOAP fault 
      */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axiom_soap_fault_text_get_lang(
        axiom_soap_fault_text_t * fault_text,
        const axutil_env_t * env);

    /**
      * Get the base node of the SOAP fault text
      * @param  fault_text pointer to soap_fault_text struct
      * @param  env Environment. MUST NOT be NULL
      * 
      * @return the base node of the SOAP fault text 
      */
    AXIS2_EXTERN axiom_node_t *AXIS2_CALL
    axiom_soap_fault_text_get_base_node(
        axiom_soap_fault_text_t * fault_text,
        const axutil_env_t * env);

    /**
      * Set the SOAP fault text 
      * @param  fault_text pointer to soap_fault_text struct
      * @param  env Environment. MUST NOT be NULL
      * @param value the text value
      * @param lang string to be compared
      * @return satus of the op. AXIS2_SUCCESS on success 
      *         else AXIS2_FAILURE
      */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axiom_soap_fault_text_set_text(
        axiom_soap_fault_text_t * fault_text,
        const axutil_env_t * env,
        axis2_char_t * value,
        axis2_char_t * lang);

    /**
      * get the SOAP fault text 
      * @param  fault_text pointer to soap_fault_text struct
      * @param  env Environment. MUST NOT be NULL
      * 
      * @return the Text of the SOAP fault 
      */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axiom_soap_fault_text_get_text(
        axiom_soap_fault_text_t * fault_text,
        const axutil_env_t * env);

    /** @} */

#ifdef __cplusplus
}
#endif

#endif                          /* AXIOM_SOAP_FAULT_TEXT_H */