basket_item.h File Reference

Description

Basket item.

Object type basket_item.

Functions
ta_e_result_code_t	ta_basket_item_create (ta_object_t *item)
	Create object of type basket_item. More...
ta_e_result_code_t	ta_basket_item_copy (ta_object_t *item, const ta_object_t *source_item)
	Create deep copy of object instance of type basket_item. More...
ta_e_result_code_t	ta_basket_item_get_auth_result (ta_object_t item, ta_object_t *auth_result)
	Acquirers result code, which indicates the result of a restriction request. More...
ta_e_result_code_t	ta_basket_item_set_auth_result (ta_object_t item, ta_object_t auth_result)
	Set acquirers result code, which indicates the result of a restriction request. More...
ta_e_result_code_t	ta_basket_item_get_item_id (ta_object_t item, ta_object_t *id)
	Identifies the item. More...
ta_e_result_code_t	ta_basket_item_set_item_id (ta_object_t item, ta_object_t id)
	Set identifies the item. More...
ta_e_result_code_t	ta_basket_item_get_loyalty_id (ta_object_t item, ta_object_t *loyalty_id)
	Identifies the loyalty type. More...
ta_e_result_code_t	ta_basket_item_set_loyalty_id (ta_object_t item, ta_object_t loyalty_id)
	Set identifies the loyalty type. More...
ta_e_result_code_t	ta_basket_item_get_amount (ta_object_t item, ta_object_t *amount)
	Amount. More...
ta_e_result_code_t	ta_basket_item_set_amount (ta_object_t item, ta_object_t amount)
	Set amount. More...
ta_e_result_code_t	ta_basket_item_get_amount_total (ta_object_t item, ta_object_t *amount_total)
	Total amount. More...
ta_e_result_code_t	ta_basket_item_set_amount_total (ta_object_t item, ta_object_t amount_total)
	Set total amount. More...
ta_e_result_code_t	ta_basket_item_get_amount_discount (ta_object_t item, ta_object_t *amount_discount)
	Discount amount or 0 if discount amount is not used. More...
ta_e_result_code_t	ta_basket_item_set_amount_discount (ta_object_t item, ta_object_t amount_discount)
	Set discount amount or 0 if discount amount is not used. More...
ta_e_result_code_t	ta_basket_item_get_amount_tax (ta_object_t item, ta_object_t *amount_tax)
	Tax amount. More...
ta_e_result_code_t	ta_basket_item_set_amount_tax (ta_object_t item, ta_object_t amount_tax)
	Set tax amount. More...
ta_e_result_code_t	ta_basket_item_get_amount_gross (ta_object_t item, ta_object_t *amount_gross)
	Gross amount. More...
ta_e_result_code_t	ta_basket_item_set_amount_gross (ta_object_t item, ta_object_t amount_gross)
	Set gross amount. More...
ta_e_result_code_t	ta_basket_item_get_unit_amount_discount (ta_object_t item, ta_object_t *unit_amount_discount)
	Tax amount. More...
ta_e_result_code_t	ta_basket_item_set_unit_amount_discount (ta_object_t item, ta_object_t unit_amount_discount)
	Set unit_amount_discount amount. More...
ta_e_result_code_t	ta_basket_item_get_unit_amount_gross (ta_object_t item, ta_object_t *unit_amount_gross)
	Tax amount. More...
ta_e_result_code_t	ta_basket_item_set_unit_amount_gross (ta_object_t item, ta_object_t unit_amount_gross)
	Set unit_amount_gross amount. More...
ta_e_result_code_t	ta_basket_item_get_item_quantity (ta_object_t item, ta_object_t *item_quantity)
	Quantity of the product. More...
ta_e_result_code_t	ta_basket_item_set_item_quantity (ta_object_t item, ta_object_t item_quantity)
	Set quantity of the product. More...
ta_e_result_code_t	ta_basket_item_get_prod_description (ta_object_t item, ta_object_t *prod_description)
	Product description. More...
ta_e_result_code_t	ta_basket_item_set_prod_description (ta_object_t item, ta_object_t prod_description)
	Set product description. More...
ta_e_result_code_t	ta_basket_item_get_discount_id (ta_object_t item, ta_object_t *discount_id)
	Discount ID if AmountDiscount. More...
ta_e_result_code_t	ta_basket_item_get_petrol_pump_number (ta_object_t item, ta_object_t *petrol_pump_number)
	Specifies the used petrol pump number used in a sixml:Item as part of a sixml:Basket. More...
ta_e_result_code_t	ta_basket_item_set_petrol_pump_number (ta_object_t item, ta_object_t petrol_pump_number)
	Specifies the used petrol pump number used in a sixml:Item as part of a sixml:Basket. More...

Function Documentation

ta_basket_item_copy()

ta_e_result_code_t ta_basket_item_copy	(	ta_object_t *	item,
		const ta_object_t *	source_item
	)

Create deep copy of object instance of type basket_item.

Parameters

[out]	item	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	source_item	Object of type basket_item to create copy of.

Return values

ta_c_rc_ok	Object instance has been created and written to item.
ta_c_rc_invalid_argument	item is null-pointer.
ta_c_rc_invalid_argument	source_item is ta_object_invalid.
ta_c_rc_invalid_argument	source_item is not of type basket_item.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_basket_item_create()

ta_e_result_code_t ta_basket_item_create

(

ta_object_t *

item

)

Create object of type basket_item.

Parameters

[out]

item

Pointer to variable to write created object instance to. Created object instance is retained.

Return values

ta_c_rc_ok	Object instance has been created and written to item.
ta_c_rc_invalid_argument	item is null-pointer.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_basket_item_get_amount()

ta_e_result_code_t ta_basket_item_get_amount	(	ta_object_t	item,
		ta_object_t *	amount
	)

Amount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	amount	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to amount.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount is null-pointer.

ta_basket_item_get_amount_discount()

ta_e_result_code_t ta_basket_item_get_amount_discount	(	ta_object_t	item,
		ta_object_t *	amount_discount
	)

Discount amount or 0 if discount amount is not used.

Parameters

[in]	item	Object instance of type basket_item.
[out]	amount_discount	Pointer to variable to write object instance to. Object instance is of type amount_discount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to amount_discount.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_discount is null-pointer.

ta_basket_item_get_amount_gross()

ta_e_result_code_t ta_basket_item_get_amount_gross	(	ta_object_t	item,
		ta_object_t *	amount_gross
	)

Gross amount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	amount_gross	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to amount_gross.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_gross is null-pointer.

ta_basket_item_get_amount_tax()

ta_e_result_code_t ta_basket_item_get_amount_tax	(	ta_object_t	item,
		ta_object_t *	amount_tax
	)

Tax amount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	amount_tax	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to amount_tax.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_tax is null-pointer.

ta_basket_item_get_amount_total()

ta_e_result_code_t ta_basket_item_get_amount_total	(	ta_object_t	item,
		ta_object_t *	amount_total
	)

Total amount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	amount_total	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to amount_total.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_total is null-pointer.

ta_basket_item_get_auth_result()

ta_e_result_code_t ta_basket_item_get_auth_result	(	ta_object_t	item,
		ta_object_t *	auth_result
	)

Acquirers result code, which indicates the result of a restriction request.

Parameters

[in]	item	Object instance of type basket_item.
[out]	auth_result	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in basket_item.

Return values

ta_c_rc_ok	Object instance written to auth_result.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	auth_result is null-pointer.

ta_basket_item_get_discount_id()

ta_e_result_code_t ta_basket_item_get_discount_id	(	ta_object_t	item,
		ta_object_t *	discount_id
	)

Discount ID if AmountDiscount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	discount_id	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if amount discount is not set or discount item in amount discount is not set.

Return values

ta_c_rc_ok	Object instance written to prod_description.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	discount_id is null-pointer.

ta_basket_item_get_item_id()

ta_e_result_code_t ta_basket_item_get_item_id	(	ta_object_t	item,
		ta_object_t *	id
	)

Identifies the item.

Parameters

[in]	item	Object instance of type basket_item.
[out]	id	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to id.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	id is null-pointer.

ta_basket_item_get_item_quantity()

ta_e_result_code_t ta_basket_item_get_item_quantity	(	ta_object_t	item,
		ta_object_t *	item_quantity
	)

Quantity of the product.

Parameters

[in]	item	Object instance of type basket_item.
[out]	item_quantity	Pointer to variable to write object instance to. Object instance is of type item_quantity and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to item_quantity.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	item_quantity is null-pointer.

ta_basket_item_get_loyalty_id()

ta_e_result_code_t ta_basket_item_get_loyalty_id	(	ta_object_t	item,
		ta_object_t *	loyalty_id
	)

Identifies the loyalty type.

Parameters

[in]	item	Object instance of type basket_item.
[out]	loyalty_id	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to loyalty_id.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	loyalty_id is null-pointer.

ta_basket_item_get_petrol_pump_number()

ta_e_result_code_t ta_basket_item_get_petrol_pump_number	(	ta_object_t	item,
		ta_object_t *	petrol_pump_number
	)

Specifies the used petrol pump number used in a sixml:Item as part of a sixml:Basket.

Parameters

[in]	item	Object instance of type basket_item.
[out]	petrol_pump_number	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to petrol_pump_number.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	petrol_pump_number is null-pointer.

ta_basket_item_get_prod_description()

ta_e_result_code_t ta_basket_item_get_prod_description	(	ta_object_t	item,
		ta_object_t *	prod_description
	)

Product description.

Parameters

[in]	item	Object instance of type basket_item.
[out]	prod_description	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to prod_description.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	prod_description is null-pointer.

ta_basket_item_get_unit_amount_discount()

ta_e_result_code_t ta_basket_item_get_unit_amount_discount	(	ta_object_t	item,
		ta_object_t *	unit_amount_discount
	)

Tax amount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	unit_amount_discount	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to unit_amount_discount.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	unit_amount_discount is null-pointer.

ta_basket_item_get_unit_amount_gross()

ta_e_result_code_t ta_basket_item_get_unit_amount_gross	(	ta_object_t	item,
		ta_object_t *	unit_amount_gross
	)

Tax amount.

Parameters

[in]	item	Object instance of type basket_item.
[out]	unit_amount_gross	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_object_invalid if value is not set in item.

Return values

ta_c_rc_ok	Object instance written to unit_amount_gross.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	unit_amount_gross is null-pointer.

ta_basket_item_set_amount()

ta_e_result_code_t ta_basket_item_set_amount	(	ta_object_t	item,
		ta_object_t	amount
	)

Set amount.

Parameters

[in]	item	Object instance of type basket_item.
[in]	amount	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.

ta_basket_item_set_amount_discount()

ta_e_result_code_t ta_basket_item_set_amount_discount	(	ta_object_t	item,
		ta_object_t	amount_discount
	)

Set discount amount or 0 if discount amount is not used.

Parameters

[in]	item	Object instance of type basket_item.
[in]	amount_discount	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount_discount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_discount is not ta_object_invalid and is not of type amount_discount.

ta_basket_item_set_amount_gross()

ta_e_result_code_t ta_basket_item_set_amount_gross	(	ta_object_t	item,
		ta_object_t	amount_gross
	)

Set gross amount.

Parameters

[in]	item	Object instance of type basket_item.
[in]	amount_gross	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_gross is not ta_object_invalid and is not of type amount.

ta_basket_item_set_amount_tax()

ta_e_result_code_t ta_basket_item_set_amount_tax	(	ta_object_t	item,
		ta_object_t	amount_tax
	)

Set tax amount.

Parameters

[in]	item	Object instance of type basket_item.
[in]	amount_tax	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_tax is not ta_object_invalid and is not of type amount.

ta_basket_item_set_amount_total()

ta_e_result_code_t ta_basket_item_set_amount_total	(	ta_object_t	item,
		ta_object_t	amount_total
	)

Set total amount.

Parameters

[in]	item	Object instance of type basket_item.
[in]	amount_total	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	amount_total is not ta_object_invalid and is not of type amount.

ta_basket_item_set_auth_result()

ta_e_result_code_t ta_basket_item_set_auth_result	(	ta_object_t	item,
		ta_object_t	auth_result
	)

Set acquirers result code, which indicates the result of a restriction request.

Parameters

[in]	item	Object instance of type basket_item.
[in]	auth_result	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type integer.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	auth_result is not ta_object_invalid and is not of type integer.

ta_basket_item_set_item_id()

ta_e_result_code_t ta_basket_item_set_item_id	(	ta_object_t	item,
		ta_object_t	id
	)

Set identifies the item.

Parameters

[in]	item	Object instance of type basket_item.
[in]	id	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type string.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	id is not ta_object_invalid and is not of type string.

ta_basket_item_set_item_quantity()

ta_e_result_code_t ta_basket_item_set_item_quantity	(	ta_object_t	item,
		ta_object_t	item_quantity
	)

Set quantity of the product.

Parameters

[in]	item	Object instance of type basket_item.
[in]	item_quantity	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type item_quantity.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	item_quantity is not ta_object_invalid and is not of type item_quantity.

ta_basket_item_set_loyalty_id()

ta_e_result_code_t ta_basket_item_set_loyalty_id	(	ta_object_t	item,
		ta_object_t	loyalty_id
	)

Set identifies the loyalty type.

Parameters

[in]	item	Object instance of type basket_item.
[in]	loyalty_id	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type string.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	loyalty_id is not ta_object_invalid and is not of type string.

ta_basket_item_set_petrol_pump_number()

ta_e_result_code_t ta_basket_item_set_petrol_pump_number	(	ta_object_t	item,
		ta_object_t	petrol_pump_number
	)

Specifies the used petrol pump number used in a sixml:Item as part of a sixml:Basket.

Parameters

[in]	item	Object instance of type basket_item.
[in]	petrol_pump_number	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type integer.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	petrol_pump_number is not ta_object_invalid and is not of type integer.

ta_basket_item_set_prod_description()

ta_e_result_code_t ta_basket_item_set_prod_description	(	ta_object_t	item,
		ta_object_t	prod_description
	)

Set product description.

Parameters

[in]	item	Object instance of type basket_item.
[in]	prod_description	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type string.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	prod_description is not ta_object_invalid and is not of type string.

ta_basket_item_set_unit_amount_discount()

ta_e_result_code_t ta_basket_item_set_unit_amount_discount	(	ta_object_t	item,
		ta_object_t	unit_amount_discount
	)

Set unit_amount_discount amount.

Parameters

[in]	item	Object instance of type basket_item.
[in]	unit_amount_discount	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	unit_amount_discount is not ta_object_invalid and is not of type amount.

ta_basket_item_set_unit_amount_gross()

ta_e_result_code_t ta_basket_item_set_unit_amount_gross	(	ta_object_t	item,
		ta_object_t	unit_amount_gross
	)

Set unit_amount_gross amount.

Parameters

[in]	item	Object instance of type basket_item.
[in]	unit_amount_gross	Object instance to set. Object instance can be ta_object_invalid to clear the value in item. If object instance is not ta_object_invalid is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to item.
ta_c_rc_invalid_argument	item is ta_object_invalid.
ta_c_rc_invalid_argument	item is not of type basket_item.
ta_c_rc_invalid_argument	unit_amount_gross is not ta_object_invalid and is not of type amount.