axiom_attribute_ops Struct Reference
[attribute]

attribute ops struct ops Encapsulator struct for axiom_attribute More...

#include <axiom_attribute.h>

List of all members.

Public Attributes

axis2_status_t(* free )(struct axiom_attribute *om_attribute, const axis2_env_t *env)
axis2_qname_t *(* get_qname )(struct axiom_attribute *om_attribute, const axis2_env_t *env)
int(* serialize )(struct axiom_attribute *om_attribute, const axis2_env_t *env, axiom_output_t *om_output)
axis2_char_t *(* get_localname )(struct axiom_attribute *om_attribute, const axis2_env_t *env)
axis2_char_t *(* get_value )(struct axiom_attribute *om_attribute, const axis2_env_t *env)
axiom_namespace_t *(* get_namespace )(struct axiom_attribute *om_attribute, const axis2_env_t *env)
axis2_status_t(* set_localname )(struct axiom_attribute *om_attribute, const axis2_env_t *env, const axis2_char_t *localname)
axis2_status_t(* set_value )(struct axiom_attribute *om_attribute, const axis2_env_t *env, const axis2_char_t *value)
axis2_status_t(* set_namespace )(struct axiom_attribute *om_attribute, const axis2_env_t *env, axiom_namespace_t *om_namespace)
axiom_attribute *(* clone )(struct axiom_attribute *om_attribute, const axis2_env_t *env)


Detailed Description

attribute ops struct ops Encapsulator struct for axiom_attribute


Member Data Documentation

axis2_status_t( * axiom_attribute_ops::free)(struct axiom_attribute *om_attribute, const axis2_env_t *env)

Free an axiom_attribute struct

Parameters:
om_attribute pointer to attribute struct to be freed
env Environment. MUST NOT be NULL
Returns:
satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_qname_t*( * axiom_attribute_ops::get_qname)(struct axiom_attribute *om_attribute, const axis2_env_t *env)

Creates and returns a qname struct for this attribute

Parameters:
om_attribute pointer to attribute struct for which the qname is to be returned
env Environment. MUST NOT be NULL
Returns:
returns qname for given attribute.NULL on error

int( * axiom_attribute_ops::serialize)(struct axiom_attribute *om_attribute, const axis2_env_t *env, axiom_output_t *om_output)

Serialize op

Parameters:
om_attribute pointer to attribute struct to be serialized
env Environment. MUST NOT be NULL,
om_output AXIOM output handler to be used in serializing
Returns:
satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_char_t*( * axiom_attribute_ops::get_localname)(struct axiom_attribute *om_attribute, const axis2_env_t *env)

returns the localname of this attribute

Parameters:
om_attribute pointer to attribute struct
env environment. MUST NOT not be NULL.
Returns:
localname returns NULL on error.

axis2_char_t*( * axiom_attribute_ops::get_value)(struct axiom_attribute *om_attribute, const axis2_env_t *env)

returns value of this attribute

Parameters:
om_attribute pointer to om_attribute struct
env environment N not be null
Returns:
value , null on error

axiom_namespace_t*( * axiom_attribute_ops::get_namespace)(struct axiom_attribute *om_attribute, const axis2_env_t *env)

returns namespace of this attribute

Parameters:
om_attribute 
env environment MUST NOT be NULL
Returns:
a pointer to om_namespace struct , returns NULL on error.

axis2_status_t( * axiom_attribute_ops::set_localname)(struct axiom_attribute *om_attribute, const axis2_env_t *env, const axis2_char_t *localname)

sets the localname of the attribute

Parameters:
om_attribute pointer to om attribute struct.
env environment, MUST NOT be null.
localname localname that should be set for this attribute
Returns:
status code AXIS2_SUCCESS on success and AXIS2_FAILURE on error.

axis2_status_t( * axiom_attribute_ops::set_value)(struct axiom_attribute *om_attribute, const axis2_env_t *env, const axis2_char_t *value)

set the attribute value

Parameters:
om_attribute a pointer to om_attribute struct.
env environment, MUST NOT be NULL.
value value that should be set for this attribute
Returns:
status code, AXIS2_SUCCESS on success and AXIS2_FAILURE on error.

axis2_status_t( * axiom_attribute_ops::set_namespace)(struct axiom_attribute *om_attribute, const axis2_env_t *env, axiom_namespace_t *om_namespace)

set namespace of the attribute

Parameters:
om_attribute a pointer to om_attribute struct
env environment, MUST NOT be NULL.
om_namespace a pointer to om_namespace struct that should be set for this attribute
Returns:
status code, AXIS2_SUCCESS on success and AXIS2_FAILURE on error.

struct axiom_attribute*( * axiom_attribute_ops::clone)(struct axiom_attribute *om_attribute, const axis2_env_t *env)

clones an om attribute

Parameters:
om_attibute 
env environment
Returns:
pointer to cloned om attribute struct on success NULL otherwise


The documentation for this struct was generated from the following file:
Generated on Wed Dec 20 20:35:10 2006 for Axis2/C by  doxygen 1.5.1