com.highdeal.pnr.hci
Interface RatingContextDescription

All Known Implementing Classes:

RatingContextDescriptionProvider

public interface RatingContextDescription

RESERVED FOR INTERNAL USE. This interface allows to put/get properties from a rating context.

Field Summary

static java.lang.String	ACTIVATION_DATE Constant for default property activation date, that is the activation date for a recurring rate.
static java.lang.String	AGREEMENT_CANCELLATION_DATE Constant for default property agreement cancellation date.
static java.lang.String	AGREEMENT_ENDCOMMITMENT_DATE Constant for default property agreement resumption date.
static java.lang.String	AGREEMENT_RESUMPTION_DATE Constant for default property agreement resumption date.
static java.lang.String	AGREEMENT_SUBSCRIPTION_DATE Constant for default property agreement subscription date.
static java.lang.String	AGREEMENT_SUSPENSION_DATE Constant for default property agreement suspension date.
static java.lang.String	BASE_AMOUNT Constant for the property that represents the amount from a previous rating.
static java.lang.String	CHARGE_DESCRIPTION Constant for the property that represents the description of the charge.
static java.lang.String	CI_NAME Constant for name of the chargeable item.
static java.lang.String	CONSUMPTION_DATE Constant for default property consumption date.
static java.lang.String	DEPENDENT_TYPE Constant for dependent relation type.
static java.lang.String	MASTER_TYPE Constant for master relation type.
static java.lang.String	PRICE_PLAN_NAME Constant for name of the price plan.
static java.lang.String	PRICING_MACRO_TYPE Constant for pricing macro relation type.
static java.lang.String	PRODUCT_CODE Constant for name of the product.
static java.lang.String	RECURRING_PRORATA Constant for the property that tells if the amount was prorated or not.
static java.lang.String	RECURRING_REFUND Constant for the property that tells if the amount was refunded or not.
static java.lang.String	RECURRING_START Constant for the property that represents the period start in case of a recurring rate.
static java.lang.String	RECURRING_START_REF Constant for the property that represents the reference period start in case of a recurring rate.
static java.lang.String	RECURRING_STOP Constant for the property that represents the period end in case of a recurring rate.
static java.lang.String	RECURRING_STOP_REF Constant for the property that represents the reference period end in case of a recurring rate.
static java.lang.String	SERVICE_ID Constant for default property service id.
static java.lang.String	UNROUNDED_AMOUNT Constant for the property that represents the unrounded amount of a transaction.
static java.lang.String	USER_SERVICE_ID Constant for default property user service id.

Method Summary

java.util.List<QualifiedChargeableItemDescription>	availableCINamesForCharging(java.lang.String ciName) Returns all available Chargeable item description of the context.
java.util.List<QualifiedChargeableItemDescription>	availableCINamesForRating(java.lang.String ciName) Returns all available Chargeable item description of the context.
void	clean() Clean the context.
java.util.List<PropertyDescriptionModel>	getAllAvailableFullNamedProperties() Gets all properties from all categories.
java.util.List<QualifiedChargeableItemDescription>	getAllCIDescriptions()
java.util.List<java.lang.String>	getAvailableEventNames() Returns all available event names of the context.
java.util.List<java.lang.String>	getAvailablePropertyNames(int propertyType) Gets all properties of the specified type.
java.util.List<java.lang.String>	getAvailablePropertyNames(java.lang.String category) Gets all property names from a category.
java.lang.String	getCurrencyCode() Gets the currency code.
java.lang.String	getRelationType() Gets the relation type.
SharedObjectsRetriever	getSharedObjectsRetriever()
boolean	isCIValid(java.lang.String ciName) Returns true if the Chargeable item is a valid one.
boolean	isEventValid(java.lang.String eventName) Returns true if the event name is a valid one.
boolean	isPropagationSensitive()
boolean	isPropertyValid(java.lang.String propertyName, DetailCategory category) Tests if a property from a category is valid.
boolean	isPropertyValid(java.lang.String longPropertyName, int type) Test if a property from a category is valid.
void	setCurrencyCode(java.lang.String code) Sets the currency code.
void	setPropertyDescription(PropertyDescriptionModel pd, DetailCategory category) Adds a property with its description to the context.
void	setPropertyDescription(java.lang.String name, int type, DetailCategory category) Adds a property with its description to the context.
void	setRelationType(java.lang.String type) Sets the relation type.
void	setSharedObjectsRetriever(SharedObjectsRetriever retriever)

Field Detail

MASTER_TYPE

static final java.lang.String MASTER_TYPE

Constant for master relation type.

See Also:

Constant Field Values

DEPENDENT_TYPE

static final java.lang.String DEPENDENT_TYPE

Constant for dependent relation type.

See Also:

Constant Field Values

PRICING_MACRO_TYPE

static final java.lang.String PRICING_MACRO_TYPE

Constant for pricing macro relation type.

See Also:

Constant Field Values

AGREEMENT_SUBSCRIPTION_DATE

static final java.lang.String AGREEMENT_SUBSCRIPTION_DATE

Constant for default property agreement subscription date.

See Also:

Constant Field Values

AGREEMENT_CANCELLATION_DATE

static final java.lang.String AGREEMENT_CANCELLATION_DATE

Constant for default property agreement cancellation date.

See Also:

Constant Field Values

AGREEMENT_SUSPENSION_DATE

static final java.lang.String AGREEMENT_SUSPENSION_DATE

Constant for default property agreement suspension date.

See Also:

Constant Field Values

AGREEMENT_RESUMPTION_DATE

static final java.lang.String AGREEMENT_RESUMPTION_DATE

Constant for default property agreement resumption date.

See Also:

Constant Field Values

AGREEMENT_ENDCOMMITMENT_DATE

static final java.lang.String AGREEMENT_ENDCOMMITMENT_DATE

Constant for default property agreement resumption date.

See Also:

Constant Field Values

PRICE_PLAN_NAME

static final java.lang.String PRICE_PLAN_NAME

Constant for name of the price plan.

See Also:

Constant Field Values

CHARGE_DESCRIPTION

static final java.lang.String CHARGE_DESCRIPTION

Constant for the property that represents the description of the charge.

See Also:

Constant Field Values

BASE_AMOUNT

static final java.lang.String BASE_AMOUNT

Constant for the property that represents the amount from a previous rating.

See Also:

Constant Field Values

PRODUCT_CODE

static final java.lang.String PRODUCT_CODE

Constant for name of the product.

See Also:

Constant Field Values

CI_NAME

static final java.lang.String CI_NAME

Constant for name of the chargeable item.

See Also:

Constant Field Values

CONSUMPTION_DATE

static final java.lang.String CONSUMPTION_DATE

Constant for default property consumption date.

See Also:

Constant Field Values

USER_SERVICE_ID

static final java.lang.String USER_SERVICE_ID

Constant for default property user service id.

See Also:

Constant Field Values

SERVICE_ID

static final java.lang.String SERVICE_ID

Constant for default property service id.

See Also:

Constant Field Values

RECURRING_START

static final java.lang.String RECURRING_START

Constant for the property that represents the period start in case of a recurring rate.

See Also:

Constant Field Values

RECURRING_STOP

static final java.lang.String RECURRING_STOP

Constant for the property that represents the period end in case of a recurring rate.

See Also:

Constant Field Values

RECURRING_START_REF

static final java.lang.String RECURRING_START_REF

Constant for the property that represents the reference period start in case of a recurring rate.

See Also:

Constant Field Values

RECURRING_STOP_REF

static final java.lang.String RECURRING_STOP_REF

Constant for the property that represents the reference period end in case of a recurring rate.

See Also:

Constant Field Values

RECURRING_PRORATA

static final java.lang.String RECURRING_PRORATA

Constant for the property that tells if the amount was prorated or not.

See Also:

Constant Field Values

ACTIVATION_DATE

static final java.lang.String ACTIVATION_DATE

Constant for default property activation date, that is the activation date for a recurring rate.

See Also:

Constant Field Values

RECURRING_REFUND

static final java.lang.String RECURRING_REFUND

Constant for the property that tells if the amount was refunded or not.

See Also:

Constant Field Values

UNROUNDED_AMOUNT

static final java.lang.String UNROUNDED_AMOUNT

Constant for the property that represents the unrounded amount of a transaction.

See Also:

Constant Field Values

Method Detail

clean

void clean()

Clean the context.

getCurrencyCode

java.lang.String getCurrencyCode()

Gets the currency code.

Returns:

the currency code.

setCurrencyCode

void setCurrencyCode(java.lang.String code)

Sets the currency code.

Parameters:

code - the currency code.

setPropertyDescription

void setPropertyDescription(java.lang.String name,
                            int type,
                            DetailCategory category)

Adds a property with its description to the context.

Property name can be any string or predefined one : agreement_creation_date, agreement_cancellation_date, agreement_suspension_date, agreement_cancellation_date, agreement_end_commitment_date, price_plan_name, charge_description, base_amount, product_code, ci_name, consumption_date, access_login, service_identifier, recurring_start, recurring_stop, recurring_start_ref, recurring_stop_ref, recurring_prorata, activation_date, unrounded_amount

Allowed property types are : number, string, date

Parameters:

name - the property name.

type - the property type.

category - the category of the property.

setPropertyDescription

void setPropertyDescription(PropertyDescriptionModel pd,
                            DetailCategory category)

Adds a property with its description to the context. see setPropertyDescription for allowed categories.

Parameters:

pd - the property description.

category - the category of the property.

getAvailablePropertyNames

java.util.List<java.lang.String> getAvailablePropertyNames(int propertyType)

Gets all properties of the specified type. see setPropertyDescription for allowed types.

Parameters:

propertyType - the type of the property.

Returns:

a list of String.

getAvailablePropertyNames

java.util.List<java.lang.String> getAvailablePropertyNames(java.lang.String category)

Gets all property names from a category. see setPropertyDescription for allowed categories.

Parameters:

category - the category of the property.

Returns:

a list of String.

getAllAvailableFullNamedProperties

java.util.List<PropertyDescriptionModel> getAllAvailableFullNamedProperties()

Gets all properties from all categories.

Returns:

a List of property description model.

isPropertyValid

boolean isPropertyValid(java.lang.String propertyName,
                        DetailCategory category)

Tests if a property from a category is valid. see setPropertyDescription for allowed categories and names.

Parameters:

propertyName - the property name.

category - the category of the property.

Returns:

true if the property is valid, false otherwise.

isPropertyValid

boolean isPropertyValid(java.lang.String longPropertyName,
                        int type)

Test if a property from a category is valid. see setPropertyDescription for allowed types and names.

Parameters:

longPropertyName - the property name.

type - the property type.

Returns:

true if the property is valid, false otherwise.

getAllCIDescriptions

java.util.List<QualifiedChargeableItemDescription> getAllCIDescriptions()

availableCINamesForRating

java.util.List<QualifiedChargeableItemDescription> availableCINamesForRating(java.lang.String ciName)

Returns all available Chargeable item description of the context.

Parameters:

ciName - a Chargeable item name if filtering is desired.

Returns:

a list of Chargeable item description.

availableCINamesForCharging

java.util.List<QualifiedChargeableItemDescription> availableCINamesForCharging(java.lang.String ciName)

Returns all available Chargeable item description of the context.

Parameters:

ciName - a Chargeable item name if filtering is desired.

Returns:

a list of Chargeable item description.

getAvailableEventNames

java.util.List<java.lang.String> getAvailableEventNames()

Returns all available event names of the context.

Returns:

a list of event names (string).

isEventValid

boolean isEventValid(java.lang.String eventName)

Returns true if the event name is a valid one.

Parameters:

eventName - the name of the event.

Returns:

true if the event name is valid, false otherwise.

isCIValid

boolean isCIValid(java.lang.String ciName)

Returns true if the Chargeable item is a valid one.

Parameters:

ciName - a Chargeable item name.

Returns:

true if the Chargeable item name is valid, false otherwise.

isPropagationSensitive

boolean isPropagationSensitive()

setSharedObjectsRetriever

void setSharedObjectsRetriever(SharedObjectsRetriever retriever)

getSharedObjectsRetriever

SharedObjectsRetriever getSharedObjectsRetriever()

getRelationType

java.lang.String getRelationType()

Gets the relation type. Returned values are :

• master
• dependent
• pricing macro

Returns:

the relation type.

setRelationType

void setRelationType(java.lang.String type)

Sets the relation type.

Parameters:

type - the relation type. Allowed values are :

• master
• dependent
• pricing macro