axiom/include/axiom_soap_fault_sub_code.h

/*
 * 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_SUB_CODE_H
#define AXIOM_SOAP_FAULT_SUB_CODE_H

/**
 * @file axiom_soap_fault_sub_code.h
 * @brief axiom_soap_fault_sub_code struct
 */
#include <axutil_env.h>
#include <axiom_soap_fault_code.h>

#ifdef __cplusplus
extern "C"
{
#endif

    typedef struct axiom_soap_fault_sub_code axiom_soap_fault_sub_code_t;
    struct axiom_soap_fault_value;
    struct axiom_soap_builder;

    /**
     * @defgroup axiom_soap_fault_sub_code soap fault sub code
     * @ingroup axiom_soap
     * @{
     */

    /**
      * creates a soap struct 
      * @param env Environment. MUST NOT be NULL
      * @param fault_code SOAP fault code
      *
      * @return Created SOAP fault sub code
      */
    AXIS2_EXTERN axiom_soap_fault_sub_code_t *AXIS2_CALL
    axiom_soap_fault_sub_code_create_with_parent(
        const axutil_env_t * env,
        axiom_soap_fault_code_t * fault_code);

    /**
      * Create a SOAP fault sub code from the given SOAP fault and value
      * @param  fault_sub_code pointer to soap_fault_sub_code struct
      * @param  env Environment. MUST NOT be NULL
      * @param value the value to be set to the SOAP fault
      *
      * @return Created SOAP sub code
      */
    AXIS2_EXTERN axiom_soap_fault_sub_code_t *AXIS2_CALL
    axiom_soap_fault_sub_code_create_with_parent_value(
        const axutil_env_t * env,
        axiom_soap_fault_code_t * fault_code,
        axis2_char_t * value);

    /**
      * Free an axiom_soap_fault_sub_code
      * @param  fault_sub_code pointer to soap_fault_sub_code struct
      * @param  env Environment. MUST NOT be NULL
      * @return VOID 
      */
    AXIS2_EXTERN void AXIS2_CALL
    axiom_soap_fault_sub_code_free(
        axiom_soap_fault_sub_code_t * fault_sub_code,
        const axutil_env_t * env);

    /**
      * Get the SOAP fault sub code
      * @param  fault_sub_code pointer to soap_fault_sub_code struct
      * @param  env Environment. MUST NOT be NULL
      *
      * @return the SOAP fault sub code
      */
    AXIS2_EXTERN axiom_soap_fault_sub_code_t *AXIS2_CALL
    axiom_soap_fault_sub_code_get_sub_code(
        axiom_soap_fault_sub_code_t * fault_sub_code,
        const axutil_env_t * env);

    /**
      * Get the value of the SOAP fault sub code
      * @param  fault_sub_code pointer to soap_fault_sub_code struct
      * @param  env Environment. MUST NOT be NULL
      *
      * @return the SOAP fault value
      */
    AXIS2_EXTERN struct axiom_soap_fault_value *AXIS2_CALL
    axiom_soap_fault_sub_code_get_value(
        axiom_soap_fault_sub_code_t * fault_sub_code,
        const axutil_env_t * env);

    /**
      * Get the base node of the SOAP fault sub code 
      * @param  fault_sub_code pointer to soap_fault_sub_code struct
      * @param  env Environment. MUST NOT be NULL
      *
      * @return the base node of the SOAP fault sub code as OM node
      */
    AXIS2_EXTERN axiom_node_t *AXIS2_CALL
    axiom_soap_fault_sub_code_get_base_node(
        axiom_soap_fault_sub_code_t * fault_sub_code,
        const axutil_env_t * env);

    /** @} */

#ifdef __cplusplus
}
#endif

#endif                          /* AXIOM_SOAP_FAULT_SUB_CODE_H */