axis2_desc_ops Struct Reference
[description]

#include <axis2_desc.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axis2_desc_t *desc, const axis2_env_t *env)
axis2_status_t(* add_param )(axis2_desc_t *desc, const axis2_env_t *env, axis2_param_t *param)
axis2_param_t *(* get_param )(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_array_list_t *(* get_all_params )(const axis2_desc_t *desc, const axis2_env_t *env)
axis2_bool_t(* is_param_locked )(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_status_t(* add_child )(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *key, const void *child)
axis2_hash_t *(* get_all_children )(const axis2_desc_t *desc, const axis2_env_t *env)
void *(* get_child )(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *key)
axis2_status_t(* remove_child )(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *key)


Detailed Description

description ops struct. Encapsulator struct for ops of axis2_desc.


Member Data Documentation

axis2_status_t( * axis2_desc_ops::add_child)(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *key, const void *child)

Adds child to the description. The type of children is based on the level of the description hierarchy. As an example, service has children of type operation, service group has children of type service

Parameters:
desc pointer to description
env pointer to environment struct
key key with which the child is to be added
child child to be added
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_desc_ops::add_param)(axis2_desc_t *desc, const axis2_env_t *env, axis2_param_t *param)

Adds given parameter to the list of parameters.

Parameters:
desc pointer to description
env pointer to environment struct
param pointer to parameter
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_desc_ops::free)(axis2_desc_t *desc, const axis2_env_t *env)

Frees description struct.

Parameters:
desc pointer to description
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_hash_t*( * axis2_desc_ops::get_all_children)(const axis2_desc_t *desc, const axis2_env_t *env)

Gets all children.

Parameters:
desc pointer to description
env pointer to environment struct
Returns:
pointer to hash map containing children

axis2_array_list_t*( * axis2_desc_ops::get_all_params)(const axis2_desc_t *desc, const axis2_env_t *env)

Gets all parameters stored in description.

Parameters:
desc pointer to description
env pointer to environment struct
Returns:
pointer to array list containing the list of parameters

void*( * axis2_desc_ops::get_child)(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *key)

Gets child with given key.

Parameters:
desc pointer to description
env pointer to environment struct
key key with which the child is stored
Returns:
pointer to child, returned as a void* value, need to cast to correct type

axis2_param_t*( * axis2_desc_ops::get_param)(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *param_name)

Gets named parameter.

Parameters:
desc pointer to description
env pointer to environment struct
param_name parameter name string
Returns:
pointer to named parameter, NULL if it does not exist

axis2_bool_t( * axis2_desc_ops::is_param_locked)(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *param_name)

Checks if a named parameter is locked.

Parameters:
desc pointer to description
env pointer to environment struct
param_name parameter name string
Returns:
AXIS2_TRUE if parameter is locked, else AXIS2_FALSE

axis2_status_t( * axis2_desc_ops::remove_child)(const axis2_desc_t *desc, const axis2_env_t *env, const axis2_char_t *key)

Removes the name child.

Parameters:
desc pointer to description
env pointer to environment struct
key key that represents the child to be removed
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


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