loyalty_information.h File Reference

Description

Loyalty information. Value depending on LoyaltyInfoType.

Object type loyalty_information.

Functions
ta_e_result_code_t	ta_loyalty_information_create (ta_object_t *loyalty_information, ta_object_t value, ta_object_t loyalty_info_type, ta_e_loyalty_function_type_t loyalty_function_type, ta_object_t loyalty_number)
	Create object of type loyalty_information. More...
ta_e_result_code_t	ta_loyalty_information_get_value (ta_object_t loyalty_information, ta_object_t *value)
	Information value. More...
ta_e_result_code_t	ta_loyalty_information_get_loyalty_info_type (ta_object_t loyalty_information, ta_object_t *loyalty_info_type)
	Specifies type of loyalty information. More...
ta_e_result_code_t	ta_loyalty_information_get_loyalty_function_type (ta_object_t loyalty_information, ta_e_loyalty_function_type_t *loyalty_function_type)
	Defines what kind of loyalty mode will be used. More...
ta_e_result_code_t	ta_loyalty_information_get_loyalty_number (ta_object_t loyalty_information, ta_object_t *loyalty_number)
	Coupon ID. More...

Function Documentation

ta_loyalty_information_create()

ta_e_result_code_t ta_loyalty_information_create	(	ta_object_t *	loyalty_information,
		ta_object_t	value,
		ta_object_t	loyalty_info_type,
		ta_e_loyalty_function_type_t	loyalty_function_type,
		ta_object_t	loyalty_number
	)

Create object of type loyalty_information.

Parameters

[out]	loyalty_information	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	value	Value of information. Object instance has to be of type string and is retained.
[in]	loyalty_info_type	Information type. Object instance has to be of type string and is retained.
[in]	loyalty_function_type	Loyalty function type.
[in]	loyalty_number	Loyalty number. Object instance has to be of type string and is retained.

Return values

ta_c_rc_ok	Object instance has been created and written to loyalty_information.
ta_c_rc_invalid_argument	loyalty_information is null-pointer.
ta_c_rc_invalid_argument	value is ta_invalid_object.
ta_c_rc_invalid_argument	value is not of type string.
ta_c_rc_invalid_argument	loyalty_info_type is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_info_type is not of type string.
ta_c_rc_invalid_argument	loyalty_function_type is not a valid value from ta_e_loyalty_function_type_t.
ta_c_rc_invalid_argument	loyalty_number is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_number is not of type string.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_loyalty_information_get_loyalty_function_type()

ta_e_result_code_t ta_loyalty_information_get_loyalty_function_type	(	ta_object_t	loyalty_information,
		ta_e_loyalty_function_type_t *	loyalty_function_type
	)

Defines what kind of loyalty mode will be used.

Parameters

[in]	loyalty_information	Object instance of type loyalty_information.
[out]	loyalty_function_type	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to value.
ta_c_rc_invalid_argument	loyalty_information is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_information is not of type loyalty_information.
ta_c_rc_invalid_argument	loyalty_function_type is null-pointer.

ta_loyalty_information_get_loyalty_info_type()

ta_e_result_code_t ta_loyalty_information_get_loyalty_info_type	(	ta_object_t	loyalty_information,
		ta_object_t *	loyalty_info_type
	)

Specifies type of loyalty information.

Parameters

[in]	loyalty_information	Object instance of type loyalty_information.
[out]	loyalty_info_type	Pointer to variable to write object instance to. Object instance is of type string and is not retained.

Return values

ta_c_rc_ok	Object instance written to value.
ta_c_rc_invalid_argument	loyalty_information is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_information is not of type loyalty_information.
ta_c_rc_invalid_argument	loyalty_info_type is null-pointer.

ta_loyalty_information_get_loyalty_number()

ta_e_result_code_t ta_loyalty_information_get_loyalty_number	(	ta_object_t	loyalty_information,
		ta_object_t *	loyalty_number
	)

Coupon ID.

Parameters

[in]	loyalty_information	Object instance of type loyalty_information.
[out]	loyalty_number	Pointer to variable to write object instance to. Object instance is of type string and is not retained.

Return values

ta_c_rc_ok	Object instance written to id.
ta_c_rc_invalid_argument	loyalty_information is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_information is not of type loyalty_information.
ta_c_rc_invalid_argument	loyalty_number is null-pointer.

ta_loyalty_information_get_value()

ta_e_result_code_t ta_loyalty_information_get_value	(	ta_object_t	loyalty_information,
		ta_object_t *	value
	)

Information value.

Parameters

[in]	loyalty_information	Object instance of type loyalty_information.
[out]	value	Pointer to variable to write object instance to. Object instance is of type string and is not retained.

Return values

ta_c_rc_ok	Object instance written to value.
ta_c_rc_invalid_argument	loyalty_information is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_information is not of type loyalty_information.
ta_c_rc_invalid_argument	value is null-pointer.