com.highdeal.pnr.hci

Class RatingContextDescriptionProvider

java.lang.Object

com.highdeal.pnr.hci.RatingContextDescriptionProvider

All Implemented Interfaces:

RatingContextDescription

public class RatingContextDescriptionProvider
extends java.lang.Object
implements RatingContextDescription

FOR INTERNAL USE ONLY - This class implements the rating context description interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RatingContextDescriptionProvider.ParameterFilter

Nested classes/interfaces inherited from interface com.highdeal.pnr.hci.RatingContextDescription

RatingContextDescription.AllowanceFlag, RatingContextDescription.IPropertyFilter

Field Summary

Fields inherited from interface com.highdeal.pnr.hci.RatingContextDescription

ACCOUNT_EVENT_DATE, ACCOUNT_STATE, ACTIVATION_DATE, AGREEMENT_CANCELLATION_DATE, AGREEMENT_EFFECTIVE_DATE, AGREEMENT_ENDCOMMITMENT_DATE, AGREEMENT_RESUMPTION_DATE, AGREEMENT_SUSPENSION_DATE, ALLOWANCE_CREATION_DATE, ALLOWANCE_END_DATE, ALLOWANCE_PRE_END_DATE, ALLOWANCE_PRE_START_DATE, ALLOWANCE_SHARE_IDENTIFIER, ALLOWANCE_START_DATE, ALLOWANCE_UNIQUE_IDENTIFIER, BALANCE_AMOUNT, BASE_AMOUNT, BASE_CURRENCY_CODE, BASE_ISO_CURRENCY_CODE, BLOCKED_DATE, CHARGE_DESCRIPTION, CI_NAME, CLOSED_DATE, CONSUMPTION_DATE, CONTRACT_ID, CONTRACT_ITEM_EXTERNAL_ID, CONTRACT_ITEM_ID, CURRENCY_CODE, DATE_MAX_VALUE, DEPENDENT_TYPE, EMPTY_LIMIT, ENUMERATION, ENUMERATION_CLASS, ENUMERATION_TYPE, INTERNAL_ENUMERATION, ISO_CURRENCY_CODE, LOCKED_DATE, MASTER_TYPE, NOT_PRORATED, NOT_REFUNDED, PRICE_PLAN_NAME, PRICING_MACRO_TYPE, PRODUCT_CODE, PRORATED, RECURRING_PREPAID_TYPE, RECURRING_PRORATA, RECURRING_REFUND, RECURRING_START, RECURRING_START_REF, RECURRING_STOP, RECURRING_STOP_REF, REFILL_AMOUNT_PROPERTY_NAME, REFILL_CURRENCY_PROPERTY_NAME, REFILL_DATE, REFILL_ISO_CURRENCY_PROPERTY_NAME, REFUNDED, RESTRICTION, SERVICE_ID, THRESHOLD_AMOUNT, TRIGGERING_CONTRACT_ID, TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID, UNROUNDED_AMOUNT, USER_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
RatingContextDescriptionProvider()
RatingContextDescriptionProvider(java.lang.String relationType) Constructs a rating context description provider with a specified business relationship type.

Method Summary

Modifier and Type	Method and Description
void	addProductCIDescription(QualifiedChargeableItemDescription cid)
void	addUsedCIDescriptionForCharging(QualifiedChargeableItemDescription cid)
void	addUsedCIDescriptionForRating(QualifiedChargeableItemDescription cid)
static boolean	areTypesEqual(PropertyDescriptionModel pd, int type, boolean strict) Returns whether a specified property description type is equal to a specified type.
java.util.List<QualifiedChargeableItemDescription>	availableCINamesForCharging(java.lang.String ciName) Returns a list of QualifiedChargeableItemDescription.
java.util.Vector<QualifiedChargeableItemDescription>	availableCINamesForRating(java.lang.String ciName) Returns a list of QualifiedChargeableItemDescription.
void	clean() Cleans the context.
void	cleanAllChargeableItemClassCodes() Clean the cache of Chargeable Item Description or Class used by the method RatingContextDescription.getAllChargeableItemClassCodes().
java.util.Vector<PropertyDescriptionModel>	getAllAvailableFullNamedProperties() Gets all properties from all categories.
java.util.List<SearchCodeResult.ObjectCode>	getAllChargeableItemClassCodes()
com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel	getAllowanceEventClass(java.lang.String ecName)
RatingContextDescription.AllowanceFlag	getAllowanceFlag() Gets the use allowance flag.
java.util.List<java.lang.String>	getAvailableEventNames() Returns a vector of strings representing the default events that a type of relationship can produce.
java.util.List<PropertyDescriptionModel>	getAvailableFullNamedProperties(RatingContextDescription.IPropertyFilter filter) Gets all property descriptions that matches the filter.
java.util.List<java.lang.String>	getAvailablePropertyNames(int propertyType) Gets all properties of the specified type.
java.util.List<java.lang.String>	getAvailablePropertyNames(int propertyType, boolean strict) Gets all properties of the specified type.
java.util.List<java.lang.String>	getAvailablePropertyNames(int propertyType, java.util.List<AdditionalInfoModel> criteria) Gets all properties of the specified type and matching the given criteria.
java.util.List<java.lang.String>	getAvailablePropertyNames(int propertyType, java.lang.String category) Gets all properties of the specified type and category.
java.util.List<java.lang.String>	getAvailablePropertyNames(int propertyType, java.lang.String category, java.util.List<AdditionalInfoModel> criteria) Gets the name of all properties of the specified type and category of which the additional information matches the given one.
java.util.List<java.lang.String>	getAvailablePropertyNames(RatingContextDescription.IPropertyFilter filter) Gets all property names that matches the filter.
java.util.Vector<java.lang.String>	getAvailablePropertyNames(java.lang.String category) Gets all property names from a category.
ChargeableItemDescriptionModel	getCIDescriptionFor(java.lang.Object objectCodeParam)
java.lang.String	getCurrencyCode() Gets the currency code.
java.util.List<PropertyDescriptionModel>	getDefaultPropertyDescriptions() Returns the descriptions for the default properties used by the rating process.
java.util.List<PropertyDescriptionModel>	getDefaultPropertyDescriptionsForRefill() Returns the descriptions for the default properties used by the refilling process.
static java.util.List<PropertyDescriptionModel>	getDefaultStaticPropertyDescriptions()
static java.util.List<PropertyDescriptionModel>	getDefaultStaticPropertyDescriptionsForRefill()
static DetailCategory	getInitialPrefixedName(DetailCategory fromCategory)
static DetailCategory	getInitialPrefixedName(java.lang.String propertyFullName)
boolean	getIsAllowanceFlag() Returns true if charge component is an allowance logic (shared or not).
boolean	getIsContractFlag() Returns true if charge component uses charging contract.
SearchCodeResult.ObjectCode	getObjectCodeFor(UsageChargeModel model)
SearchCodeResult.ObjectCode	getObjectCodeFor(UsageRateModel model)
SearchCodeResult.ObjectCode	getObjectCodeForCI(java.lang.String ciName, java.util.List<ProductModel> products)
java.lang.String	getOneShotTriggerName()
PropertyDescriptionModel	getPropertyByName(java.lang.String longPropertyName) Returns the description of the property by this full name.
java.lang.String	getRelationType() Gets the relation type.
SharedObjectsRetriever	getSharedObjectsRetriever()
static java.lang.String	getUnprefixedName(java.lang.String propertyFullName)
boolean	isAllowanceEventClassValid(java.lang.String ecName) Returns true if the Allowance Event Class exists.
boolean	isChargeableItemClassValid(java.lang.Object objectCode) Returns true if the Chargeable item is a valid one.
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, without taking any restriction into account.
boolean	isPropertyValid(java.lang.String longPropertyName, int type, boolean strict) Test if a property from a category is valid.
boolean	isRefillItemValid(java.lang.String riName) Returns true if the Refill Item Class exists.
static boolean	isVisible(java.lang.String propertyName) Returns whether a specified property name is linked to a visible property.
void	setAllowanceFlag(RatingContextDescription.AllowanceFlag flag) Sets the use allowance flag.
void	setCurrencyCode(java.lang.String code) Sets the currency code.
void	setIsContractFlag(boolean flag) Sets the use charging contract flag.
void	setObjectCodeFor(UsageChargeModel model, java.lang.Object objectCode)
void	setObjectCodeFor(UsageRateModel model, java.lang.Object objectCode)
void	setOneShotTriggerName(java.lang.String oneShotTriggerName)
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	setPropertyDescription(java.lang.String name, int type, DetailCategory category, java.util.List<AdditionalInfoModel> additionalInfo) Adds a property with its description to the context.
void	setRelationType(java.lang.String type) Sets the relation type.
void	setSharedObjectsRetriever(SharedObjectsRetriever retriever)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RatingContextDescriptionProvider

public RatingContextDescriptionProvider()

RatingContextDescriptionProvider

public RatingContextDescriptionProvider(java.lang.String relationType)

Constructs a rating context description provider with a specified business relationship type.

Parameters:

relationType - the type of the business relationship.

Method Detail

clean

public void clean()

Description copied from interface: RatingContextDescription

Cleans the context.

Specified by:

clean in interface RatingContextDescription

getCurrencyCode

public java.lang.String getCurrencyCode()

Description copied from interface: RatingContextDescription

Gets the currency code.

Specified by:

getCurrencyCode in interface RatingContextDescription

Returns:

The currency code

setCurrencyCode

public void setCurrencyCode(java.lang.String code)

Description copied from interface: RatingContextDescription

Sets the currency code.

Specified by:

setCurrencyCode in interface RatingContextDescription

Parameters:

code - The currency code

getIsContractFlag

public boolean getIsContractFlag()

Description copied from interface: RatingContextDescription

Returns true if charge component uses charging contract.

Specified by:

getIsContractFlag in interface RatingContextDescription

Returns:

true if charge component uses charging contract, false otherwise.

setIsContractFlag

public void setIsContractFlag(boolean flag)

Description copied from interface: RatingContextDescription

Sets the use charging contract flag.

Specified by:

setIsContractFlag in interface RatingContextDescription

Parameters:

flag - The flag to define if charge component uses charging contract

getIsAllowanceFlag

public boolean getIsAllowanceFlag()

Description copied from interface: RatingContextDescription

Returns true if charge component is an allowance logic (shared or not).

Specified by:

getIsAllowanceFlag in interface RatingContextDescription

Returns:

true if charge component is an allowance logic (shared or not), false otherwise.

setAllowanceFlag

public void setAllowanceFlag(RatingContextDescription.AllowanceFlag flag)

Description copied from interface: RatingContextDescription

Sets the use allowance flag.

Specified by:

setAllowanceFlag in interface RatingContextDescription

Parameters:

flag - the flag to define if charge component is an allowance component.

getAllowanceFlag

public RatingContextDescription.AllowanceFlag getAllowanceFlag()

Description copied from interface: RatingContextDescription

Gets the use allowance flag.

Specified by:

getAllowanceFlag in interface RatingContextDescription

Returns:

the flag that define if charge component is an allowance component, a shared allowance component or not an allowance.

setPropertyDescription

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

Description copied from interface: RatingContextDescription

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, base_currency_code, 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

Specified by:

setPropertyDescription in interface RatingContextDescription

Parameters:

name - The property name

type - The property type

category - The category of the property

setPropertyDescription

public void setPropertyDescription(java.lang.String name,
                                   int type,
                                   DetailCategory category,
                                   java.util.List<AdditionalInfoModel> additionalInfo)

Description copied from interface: RatingContextDescription

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, base_currency_code, 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