public interface RatingContextDescription
Java interface allows to put/get properties from a rating context.| Modifier and Type | Interface and Description |
|---|---|
static interface |
RatingContextDescription.IPropertyFilter
Allows to filter
PropertyDescriptionModel |
| Modifier and Type | Field and Description |
|---|---|
static String |
ACCOUNT_EVENT_DATE
Constant for default property account event date
|
static String |
ACCOUNT_STATE
Constant for the property that represents the state of a prepaid account
|
static String |
ACTIVATION_DATE
Constant for default property activation date, that is
the activation date for a recurring rate
|
static String |
AGREEMENT_CANCELLATION_DATE
Constant for default property agreement cancellation date
|
static String |
AGREEMENT_EFFECTIVE_DATE
Constant for default property agreement subscription date
|
static String |
AGREEMENT_ENDCOMMITMENT_DATE
Constant for default property agreement resumption date
|
static String |
AGREEMENT_RESUMPTION_DATE
Constant for default property agreement resumption date
|
static String |
AGREEMENT_SUSPENSION_DATE
Constant for default property agreement suspension date
|
static String |
ALLOWANCE_CREATION_DATE
Constant for the property that represents the unique identifier of an allowance.
|
static String |
ALLOWANCE_END_DATE
Constant for the property that represents the end date of an allowance.
|
static String |
ALLOWANCE_PRE_END_DATE
Constant for the property that represents the end date of an allowance.
|
static String |
ALLOWANCE_PRE_START_DATE
Constant for the property that represents the start date of an allowance.
|
static String |
ALLOWANCE_START_DATE
Constant for the property that represents the start date of an allowance.
|
static String |
ALLOWANCE_UNIQUE_IDENTIFIER
Constant for the property that represents the unique identifier of an allowance.
|
static String |
BALANCE_AMOUNT
Constant for the property that represents the amount of a prepaid balance
|
static String |
BASE_AMOUNT
Constant for the property that represents the amount from a previous rating
|
static String |
BASE_CURRENCY_CODE
Constant for the property that represents the currency code from a previous rating
|
static String |
BASE_ISO_CURRENCY_CODE
Constant for the property that represents the currency code from a previous rating
|
static String |
BLOCKED_DATE
Constant for the property that represents the blocked date of a prepaid balance
|
static String |
CHARGE_DESCRIPTION
Constant for the property that represents the description of the charge
|
static String |
CI_NAME
Constant for name of the chargeable item
|
static String |
CLOSED_DATE
Constant for the property that represents the closed date of a prepaid balance
|
static String |
CONSUMPTION_DATE
Constant for default property consumption date
|
static String |
CONTRACT_ID
Constant for default property contract ID
|
static String |
CONTRACT_ITEM_EXTERNAL_ID
Constant for default property contract item external ID
|
static String |
CONTRACT_ITEM_ID
Constant for default property contract item ID
|
static String |
CURRENCY_CODE
Constant for the property that represents the currency code of a prepaid account
|
static Date |
DATE_MAX_VALUE
Constant for the maximum usable date in the system:
9999-01-01T00:00:00.000 UTC. |
static String |
DEPENDENT_TYPE
Constant for dependent relation type
|
static String |
EMPTY_LIMIT
Constant for the property that represents the empty limit amount of a prepaid account
|
static String |
ENUMERATION
A possible value for
RESTRICTION |
static String |
ENUMERATION_CLASS
The
enum class that represents allowed values in ENUMERATION |
static String |
ISO_CURRENCY_CODE
Constant for the property that represents the currency code of a prepaid account
|
static String |
LOCKED_DATE
Constant for the property that represents the locked date of a prepaid balance
|
static String |
MASTER_TYPE
Constant for master relation type
|
static String |
NOT_PRORATED
Constant for when a recurring rate is not prorated.
|
static String |
NOT_REFUNDED
Constant for when a recurring rate is not refunded.
|
static String |
PRICE_PLAN_NAME
Constant for name of the price plan
|
static String |
PRICING_MACRO_TYPE
Constant for pricing macro relation type
|
static String |
PRODUCT_CODE
Constant for name of the product
|
static String |
PRORATED
Constant for when a recurring rate is prorated.
|
static String |
RECURRING_PREPAID_TYPE |
static String |
RECURRING_PRORATA
Constant for the property that tells if the amount was prorated or not
|
static String |
RECURRING_REFUND
Constant for the property that tells if the amount was refunded or not
|
static String |
RECURRING_START
Constant for the property that represents the period start in case of a recurring rate
|
static String |
RECURRING_START_REF
Constant for the property that represents the reference period start in case of a recurring rate
|
static String |
RECURRING_STOP
Constant for the property that represents the period end in case of a recurring rate.
|
static String |
RECURRING_STOP_REF
Constant for the property that represents the reference period end in case of a recurring rate
|
static String |
REFILL_AMOUNT_PROPERTY_NAME
Constant for the property describing the amount of the refill process
|
static String |
REFILL_CURRENCY_PROPERTY_NAME
Constant for the property describing the currency code of the refill logic
|
static String |
REFILL_DATE
Constant for default property refill date
|
static String |
REFILL_ISO_CURRENCY_PROPERTY_NAME
Constant for the property describing the ISO currency code of the refill process
|
static String |
REFUNDED
Constant for when a recurring rate is refunded.
|
static String |
RESTRICTION
The name of additional info that defines the type of restriction applied on a Property.
|
static String |
SERVICE_ID
Constant for default property service ID
|
static String |
THRESHOLD_AMOUNT
Constant for the property that represents the threshold amount of an account event
|
static String |
TRIGGERING_CONTRACT_ID
Constant for default property triggering contract ID
|
static String |
TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID
Constant for default property triggering contract item external ID
|
static String |
UNROUNDED_AMOUNT
Constant for the property that represents the unrounded amount of a transaction
|
static String |
USER_SERVICE_ID
Constant for default property user service ID
|
| Modifier and Type | Method and Description |
|---|---|
void |
addProductCIDescription(QualifiedChargeableItemDescription cid) |
void |
addUsedCIDescriptionForCharging(QualifiedChargeableItemDescription cid) |
void |
addUsedCIDescriptionForRating(QualifiedChargeableItemDescription cid) |
List<QualifiedChargeableItemDescription> |
availableCINamesForCharging(String ciName)
Returns all available Chargeable item description of the context.
|
List<QualifiedChargeableItemDescription> |
availableCINamesForRating(String ciName)
Returns all available Chargeable item description of the context.
|
void |
clean()
Cleans the context.
|
void |
cleanAllChargeableItemClassCodes()
Clean the cache of Chargeable Item Description or Class used by the method
getAllChargeableItemClassCodes(). |
List<PropertyDescriptionModel> |
getAllAvailableFullNamedProperties()
Gets all properties from all categories.
|
List<? extends Object> |
getAllChargeableItemClassCodes() |
com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel |
getAllowanceEventClass(String ecName) |
List<String> |
getAvailableEventNames()
Returns all available event names of the context.
|
List<PropertyDescriptionModel> |
getAvailableFullNamedProperties(RatingContextDescription.IPropertyFilter filter)
Gets all property descriptions that matches the filter.
|
List<String> |
getAvailablePropertyNames(int propertyType)
Gets all properties of the specified type.
|
List<String> |
getAvailablePropertyNames(int propertyType,
boolean strict)
Gets all properties of the specified type.
|
List<String> |
getAvailablePropertyNames(int propertyType,
List<AdditionalInfoModel> criteria)
Gets all properties of the specified type and matching the given criteria.
|
List<String> |
getAvailablePropertyNames(int propertyType,
String category)
Gets all properties of the specified type and category.
|
List<String> |
getAvailablePropertyNames(int propertyType,
String category,
List<AdditionalInfoModel> criteria)
Gets the name of all properties of the specified type and category
of which the additional information matches the given one.
|
List<String> |
getAvailablePropertyNames(RatingContextDescription.IPropertyFilter filter)
Gets all property names that matches the filter.
|
List<String> |
getAvailablePropertyNames(String category)
Gets all property names from a category.
|
ChargeableItemDescriptionModel |
getCIDescriptionFor(Object objectCode) |
String |
getCurrencyCode()
Gets the currency code.
|
List<PropertyDescriptionModel> |
getDefaultPropertyDescriptions()
Returns the descriptions for the default properties used by the rating process.
|
List<PropertyDescriptionModel> |
getDefaultPropertyDescriptionsForRefill()
Returns the descriptions for the default properties used by the refill process.
|
boolean |
getIsAllowanceFlag()
Returns true if charge component is an allowance component.
|
boolean |
getIsContractFlag()
Returns true if charge component uses charging contract.
|
Object |
getObjectCodeFor(UsageChargeModel model) |
Object |
getObjectCodeFor(UsageRateModel model) |
Object |
getObjectCodeForCI(String ciName,
List<ProductModel> products) |
String |
getRelationType()
Gets the relation type.
|
SharedObjectsRetriever |
getSharedObjectsRetriever() |
boolean |
isAllowanceEventClassValid(String ecName)
Returns true if the Allowance Event Class exists.
|
boolean |
isChargeableItemClassValid(Object objectCode)
Returns true if the Chargeable item is a valid one.
|
boolean |
isCIValid(String ciName)
Returns true if the Chargeable item is a valid one.
|
boolean |
isEventValid(String eventName)
Returns true if the event name is a valid one.
|
boolean |
isPropagationSensitive() |
boolean |
isPropertyValid(String propertyName,
DetailCategory category)
Tests if a property from a category is valid.
|
boolean |
isPropertyValid(String longPropertyName,
int type)
Test if a property from a category is valid.
|
boolean |
isRefillItemValid(String riName)
Returns true if the Refill Item Class exists.
|
void |
setCurrencyCode(String code)
Sets the currency code.
|
void |
setIsAllowanceFlag(boolean flag)
Sets the use allowance flag.
|
void |
setIsContractFlag(boolean flag)
Sets the use charging contract flag.
|
void |
setObjectCodeFor(UsageChargeModel model,
Object objectCode) |
void |
setObjectCodeFor(UsageRateModel model,
Object objectCode) |
void |
setPropertyDescription(PropertyDescriptionModel pd,
DetailCategory category)
Adds a property with its description to the context.
|
void |
setPropertyDescription(String name,
int type,
DetailCategory category)
Adds a property with its description to the context.
|
void |
setPropertyDescription(String name,
int type,
DetailCategory category,
List<AdditionalInfoModel> additionalInfo)
Adds a property with its description to the context.
|
void |
setRelationType(String type)
Sets the relation type.
|
void |
setSharedObjectsRetriever(SharedObjectsRetriever retriever) |
static final String MASTER_TYPE
static final String DEPENDENT_TYPE
static final String PRICING_MACRO_TYPE
static final String AGREEMENT_EFFECTIVE_DATE
static final String AGREEMENT_CANCELLATION_DATE
static final String AGREEMENT_SUSPENSION_DATE
static final String AGREEMENT_RESUMPTION_DATE
static final String AGREEMENT_ENDCOMMITMENT_DATE
static final String PRICE_PLAN_NAME
static final String CHARGE_DESCRIPTION
static final String BASE_AMOUNT
static final String BASE_CURRENCY_CODE
static final String BASE_ISO_CURRENCY_CODE
static final String PRODUCT_CODE
static final String CI_NAME
static final String CONSUMPTION_DATE
static final String USER_SERVICE_ID
static final String CONTRACT_ID
static final String CONTRACT_ITEM_ID
static final String CONTRACT_ITEM_EXTERNAL_ID
static final String TRIGGERING_CONTRACT_ID
static final String TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID
static final String SERVICE_ID
static final String RECURRING_START
static final String RECURRING_STOP
static final String RECURRING_START_REF
static final String RECURRING_STOP_REF
static final String RECURRING_PRORATA
static final String RECURRING_PREPAID_TYPE
static final String ACTIVATION_DATE
static final String RECURRING_REFUND
static final String UNROUNDED_AMOUNT
static final String CURRENCY_CODE
static final String ISO_CURRENCY_CODE
static final String EMPTY_LIMIT
static final String BALANCE_AMOUNT
static final String ACCOUNT_STATE
static final String RESTRICTION
ACCOUNT_STATE.static final String ENUMERATION
RESTRICTIONstatic final String ENUMERATION_CLASS
enum class that represents allowed values in ENUMERATIONstatic final String REFILL_DATE
static final String ACCOUNT_EVENT_DATE
static final String THRESHOLD_AMOUNT
static final String REFILL_AMOUNT_PROPERTY_NAME
static final String REFILL_CURRENCY_PROPERTY_NAME
static final String REFILL_ISO_CURRENCY_PROPERTY_NAME
static final String LOCKED_DATE
static final String BLOCKED_DATE
static final String CLOSED_DATE
static final String ALLOWANCE_START_DATE
static final String ALLOWANCE_END_DATE
static final String ALLOWANCE_PRE_START_DATE
static final String ALLOWANCE_PRE_END_DATE
static final String ALLOWANCE_UNIQUE_IDENTIFIER
static final String ALLOWANCE_CREATION_DATE
static final Date DATE_MAX_VALUE
9999-01-01T00:00:00.000 UTC.static final String PRORATED
static final String NOT_PRORATED
static final String REFUNDED
static final String NOT_REFUNDED
void clean()
String getCurrencyCode()
void setCurrencyCode(String code)
code - The currency codeboolean getIsContractFlag()
true if charge component uses charging contract, false otherwise.void setIsContractFlag(boolean flag)
flag - The fleg to define if charge component uses charging contractboolean getIsAllowanceFlag()
void setIsAllowanceFlag(boolean flag)
flag - the fleg to define if charge component is an allowance component.void setPropertyDescription(String name, int type, DetailCategory category)
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_amountnumber,
string,
datename - The property nametype - The property typecategory - The category of the propertyvoid setPropertyDescription(String name, int type, DetailCategory category, List<AdditionalInfoModel> additionalInfo)
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_amountnumber,
string,
datename - The property nametype - The property typecategory - The category of the propertyadditionalInfo - The additional information of the property.
Passing in null is equivalent to passing in an empty list.void setPropertyDescription(PropertyDescriptionModel pd, DetailCategory category)
setPropertyDescription for allowed categories.pd - The property descriptioncategory - The category of the propertyList<String> getAvailablePropertyNames(RatingContextDescription.IPropertyFilter filter)
filter - The filter that describes the constraints to checkList<PropertyDescriptionModel> getAvailableFullNamedProperties(RatingContextDescription.IPropertyFilter filter)
filter - The filter that describes the constraints to checkList<String> getAvailablePropertyNames(int propertyType)
setPropertyDescription for allowed types.propertyType - The type of the propertyList<String> getAvailablePropertyNames(int propertyType, List<AdditionalInfoModel> criteria)
setPropertyDescription for allowed types.propertyType - The type of the propertycriteria - The additional information that must be present in the returned property description modelsList<String> getAvailablePropertyNames(int propertyType, boolean strict)
setPropertyDescription for allowed types.propertyType - the type of the property.strict - true if the types must be strictly equal.List<String> getAvailablePropertyNames(String category)
setPropertyDescription for allowed categories.category - the category of the property.List<String> getAvailablePropertyNames(int propertyType, String category)
setPropertyDescription for allowed types.
see setPropertyDescription for allowed categories.propertyType - the type of the property.category - the category of the property.List<String> getAvailablePropertyNames(int propertyType, String category, List<AdditionalInfoModel> criteria)
setPropertyDescription for allowed types.
see setPropertyDescription for allowed categories.propertyType - the type of the property.category - the category of the property.criteria - the additional information that must be present in the returned property description models.property description models.List<PropertyDescriptionModel> getAllAvailableFullNamedProperties()
property description model.boolean isPropertyValid(String propertyName, DetailCategory category)
setPropertyDescription for allowed categories and names.propertyName - the property name.category - the category of the property.boolean isPropertyValid(String longPropertyName, int type)
setPropertyDescription for allowed types and names.longPropertyName - the property name.type - the property type.List<QualifiedChargeableItemDescription> availableCINamesForRating(String ciName)
ciName - a Chargeable item name if filtering is desired.Chargeable item description.List<QualifiedChargeableItemDescription> availableCINamesForCharging(String ciName)
ciName - a Chargeable item name if filtering is desired.Chargeable item description.List<String> getAvailableEventNames()
boolean isEventValid(String eventName)
eventName - the name of the event.boolean isCIValid(String ciName)
ciName - a Chargeable item name.boolean isChargeableItemClassValid(Object objectCode)
objectCode - the code of a Chargeable item .boolean isRefillItemValid(String riName)
riName - a Refill Item Class name.boolean isPropagationSensitive()
void setSharedObjectsRetriever(SharedObjectsRetriever retriever)
SharedObjectsRetriever getSharedObjectsRetriever()
String getRelationType()
void setRelationType(String type)
type - the relation type.
Allowed values are :
List<PropertyDescriptionModel> getDefaultPropertyDescriptions()
PropertyDescriptionModel.property description models.List<PropertyDescriptionModel> getDefaultPropertyDescriptionsForRefill()
PropertyDescriptionModel.property description models.void addProductCIDescription(QualifiedChargeableItemDescription cid)
void addUsedCIDescriptionForRating(QualifiedChargeableItemDescription cid)
void addUsedCIDescriptionForCharging(QualifiedChargeableItemDescription cid)
boolean isAllowanceEventClassValid(String ecName)
ecName - a Allowance Event Class name.Object getObjectCodeForCI(String ciName, List<ProductModel> products)
ciName - products - Object getObjectCodeFor(UsageRateModel model)
model - void setObjectCodeFor(UsageRateModel model, Object objectCode)
model - objectCode - is an ObjectCodeObject getObjectCodeFor(UsageChargeModel model)
model - void setObjectCodeFor(UsageChargeModel model, Object objectCode)
model - objectCode - Is an ObjectCodeChargeableItemDescriptionModel getCIDescriptionFor(Object objectCode)
objectCode - Is an ObjectCode (of a Chargeable Item Description or Class)List<? extends Object> getAllChargeableItemClassCodes()
void cleanAllChargeableItemClassCodes()
getAllChargeableItemClassCodes().com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel getAllowanceEventClass(String ecName)
ecName - a Allowance Event Class name.