Main Page | Modules | Class List | Directories | File List | Class Members | File Members | Examples

axis2_param_container.h

Go to the documentation of this file.
00001 /*
00002  * Copyright 2004,2005 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *      http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef AXIS2_PARAM_CONTAINER_H
00018 #define AXIS2_PARAM_CONTAINER_H
00019 
00025 #include <axis2_utils.h>
00026 #include <axis2_error.h>
00027 #include <axis2_utils_defines.h>
00028 #include <axis2_env.h>
00029 #include <axis2_allocator.h>
00030 #include <axis2_string.h>
00031 #include <axis2_array_list.h>
00032 #include <axis2_hash.h>
00033 
00034 /*#include <axiom_element.h>*/
00035 #include <axis2_qname.h>
00036 #include <axis2_param.h>
00037 
00038 #ifdef __cplusplus
00039 extern "C"
00040 {
00041 #endif
00042 
00043 struct axis2_param_container;
00044 struct axis2_param_container_ops;
00045  
00051 typedef axis2_status_t (AXIS2_CALL *AXIS2_PARAM_VALUE_FREE)(void *param, const axis2_env_t *env);    
00052 
00062 AXIS2_DECLARE_DATA typedef struct axis2_param_container_ops
00063 {
00067    axis2_status_t (AXIS2_CALL *
00068    free)(struct axis2_param_container *param_container,
00069         const axis2_env_t *env);
00070 
00075    axis2_status_t (AXIS2_CALL *
00076    add_param)(struct axis2_param_container *param_container,
00077             const axis2_env_t *env,
00078             axis2_param_t *param);
00079 
00084    axis2_param_t *(AXIS2_CALL *
00085    get_param) (struct axis2_param_container *param_container, 
00086             const axis2_env_t *env,
00087             const axis2_char_t *name);
00088 
00089 
00093    axis2_array_list_t *(AXIS2_CALL *
00094    get_params)(struct axis2_param_container *param_container, 
00095             const axis2_env_t *env);
00096 
00101    axis2_bool_t (AXIS2_CALL *
00102    is_param_locked)(struct axis2_param_container *param_container, 
00103                 const axis2_env_t *env,
00104                 const axis2_char_t *param_name) ;
00105 
00106 }axis2_param_container_ops_t;
00107 
00112 AXIS2_DECLARE_DATA typedef struct axis2_param_container
00113 {
00114    axis2_param_container_ops_t *ops;
00115 }axis2_param_container_t;
00116 
00121 AXIS2_EXTERN axis2_param_container_t * AXIS2_CALL 
00122 axis2_param_container_create (const axis2_env_t *env);
00123 
00129 AXIS2_EXTERN axis2_status_t AXIS2_CALL 
00130 axis2_param_container_free_void_arg (void *param_container,
00131                                         const axis2_env_t *env);
00132                                     
00133 /*************************** Function macros **********************************/
00134 
00135 #define AXIS2_PARAM_CONTAINER_FREE(param_container, env) \
00136       ((param_container)->ops->free (param_container, env))
00137 
00138 #define AXIS2_PARAM_CONTAINER_ADD_PARAM(param_container, env, param) \
00139       ((param_container)->ops->add_param (param_container, env, param))
00140 
00141 #define AXIS2_PARAM_CONTAINER_GET_PARAM(param_container, env, name) \
00142       ((param_container)->ops->get_param (param_container, env, name))
00143 
00144 #define AXIS2_PARAM_CONTAINER_GET_PARAMS(param_container, env) \
00145       ((param_container)->ops->get_params (param_container, env))
00146 
00147 #define AXIS2_PARAM_CONTAINER_IS_PARAM_LOCKED(param_container, env, param_name) \
00148       ((param_container)->ops->is_param_locked (param_container, env, \
00149       param_name))
00150 
00151 /*************************** End of function macros ***************************/
00152 
00155 #ifdef __cplusplus
00156 }
00157 #endif
00158 #endif  /* AXIS2_PARAM_CONTAINER_H */

Generated on Fri Jun 16 18:02:31 2006 for Axis2/C by  doxygen 1.4.2