RatingContextDescription (SAP CC 2022 Java APIs (Core Library))

All Known Implementing Classes:

RatingContextDescriptionProvider
```
public interface RatingContextDescription
```
FOR INTERNAL USE ONLY - This Java interface allows to put/get properties from a rating context.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RatingContextDescription.AllowanceFlag` The allowance flag defined if the charge component is an allowance component, a shared allowance component or not an allowance.
`static interface`	`RatingContextDescription.IPropertyFilter` Allows to filter `PropertyDescriptionModel`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACCOUNT_EVENT_DATE` Constant for default property account event date
`static java.lang.String`	`ACCOUNT_STATE` Constant for the property that represents the state of a prepaid account
`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_EFFECTIVE_DATE` Constant for default property agreement subscription 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_SUSPENSION_DATE` Constant for default property agreement suspension date
`static java.lang.String`	`ALLOWANCE_CREATION_DATE` Constant for the property that represents the unique identifier of an allowance.
`static java.lang.String`	`ALLOWANCE_END_DATE` Constant for the property that represents the end date of an allowance.
`static java.lang.String`	`ALLOWANCE_PRE_END_DATE` Constant for the property that represents the end date of an allowance.
`static java.lang.String`	`ALLOWANCE_PRE_START_DATE` Constant for the property that represents the start date of an allowance.
`static java.lang.String`	`ALLOWANCE_SHARE_IDENTIFIER` Constant for the property that represents the share identifier of an allowance.
`static java.lang.String`	`ALLOWANCE_START_DATE` Constant for the property that represents the start date of an allowance.
`static java.lang.String`	`ALLOWANCE_UNIQUE_IDENTIFIER` Constant for the property that represents the unique identifier of an allowance.
`static java.lang.String`	`BALANCE_AMOUNT` Constant for the property that represents the amount of a prepaid balance
`static java.lang.String`	`BASE_AMOUNT` Constant for the property that represents the amount from a previous rating
`static java.lang.String`	`BASE_CURRENCY_CODE` Constant for the property that represents the currency code from a previous rating
`static java.lang.String`	`BASE_ISO_CURRENCY_CODE` Constant for the property that represents the currency code from a previous rating
`static java.lang.String`	`BLOCKED_DATE` Constant for the property that represents the blocked date of a prepaid balance
`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`	`CLOSED_DATE` Constant for the property that represents the closed date of a prepaid balance
`static java.lang.String`	`CONSUMPTION_DATE` Constant for default property consumption date
`static java.lang.String`	`CONTRACT_ID` Constant for default property contract ID
`static java.lang.String`	`CONTRACT_ITEM_EXTERNAL_ID` Constant for default property contract item external ID
`static java.lang.String`	`CONTRACT_ITEM_ID` Constant for default property contract item ID
`static java.lang.String`	`CURRENCY_CODE` Constant for the property that represents the currency code of a prepaid account
`static java.util.Date`	`DATE_MAX_VALUE` Constant for the maximum usable date in the system: `9999-01-01T00:00:00.000 UTC`.
`static java.lang.String`	`DEPENDENT_TYPE` Constant for dependent relation type
`static java.lang.String`	`EMPTY_LIMIT` Constant for the property that represents the empty limit amount of a prepaid account
`static java.lang.String`	`ENUMERATION` A possible value for `RESTRICTION`
`static java.lang.String`	`ENUMERATION_CLASS` The `enum` class that represents allowed values in `ENUMERATION`
`static java.lang.String`	`ENUMERATION_TYPE` The name of additional info that defines the type of enumeration applied on a Property.
`static java.lang.String`	`INTERNAL_ENUMERATION` A possible value for `ENUMERATION_TYPE`
`static java.lang.String`	`ISO_CURRENCY_CODE` Constant for the property that represents the currency code of a prepaid account
`static java.lang.String`	`LOCKED_DATE` Constant for the property that represents the locked date of a prepaid balance
`static java.lang.String`	`MASTER_TYPE` Constant for master relation type
`static java.lang.String`	`NOT_PRORATED` Constant for when a recurring rate is not prorated.
`static java.lang.String`	`NOT_REFUNDED` Constant for when a recurring rate is not refunded.
`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`	`PRORATED` Constant for when a recurring rate is prorated.
`static java.lang.String`	`RECURRING_PREPAID_TYPE`
`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`	`REFILL_AMOUNT_PROPERTY_NAME` Constant for the property describing the amount of the refill process
`static java.lang.String`	`REFILL_CURRENCY_PROPERTY_NAME` Constant for the property describing the currency code of the refill logic
`static java.lang.String`	`REFILL_DATE` Constant for default property refill date
`static java.lang.String`	`REFILL_ISO_CURRENCY_PROPERTY_NAME` Constant for the property describing the ISO currency code of the refill process
`static java.lang.String`	`REFUNDED` Constant for when a recurring rate is refunded.
`static java.lang.String`	`RESTRICTION` The name of additional info that defines the type of restriction applied on a Property.
`static java.lang.String`	`SERVICE_ID` Constant for default property service ID
`static java.lang.String`	`THRESHOLD_AMOUNT` Constant for the property that represents the threshold amount of an account event
`static java.lang.String`	`TRIGGERING_CONTRACT_ID` Constant for default property triggering contract ID
`static java.lang.String`	`TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID` Constant for default property triggering contract item external 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addProductCIDescription(QualifiedChargeableItemDescription cid)`
`void`	`addUsedCIDescriptionForCharging(QualifiedChargeableItemDescription cid)`
`void`	`addUsedCIDescriptionForRating(QualifiedChargeableItemDescription cid)`
`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()` Cleans the context.
`void`	`cleanAllChargeableItemClassCodes()` Clean the cache of Chargeable Item Description or Class used by the method `getAllChargeableItemClassCodes()`.
`java.util.List<PropertyDescriptionModel>`	`getAllAvailableFullNamedProperties()` Gets all properties from all categories.
`java.util.List<? extends java.lang.Object>`	`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 all available event names of the context.
`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.List<java.lang.String>`	`getAvailablePropertyNames(java.lang.String category)` Gets all property names from a category.
`ChargeableItemDescriptionModel`	`getCIDescriptionFor(java.lang.Object objectCode)`
`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 refill process.
`boolean`	`getIsAllowanceFlag()` Returns true if charge component is an allowance logic (shared or not).
`boolean`	`getIsContractFlag()` Returns true if charge component uses charging contract.
`java.lang.Object`	`getObjectCodeFor(UsageChargeModel model)`
`java.lang.Object`	`getObjectCodeFor(UsageRateModel model)`
`java.lang.Object`	`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()`
`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`	`isManagedByCockpit()` Returns true if the charge component is managed by Cockpit.
`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.
`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`	`setManagedByCockpit(boolean isManagedByCockpit)` Sets the managed by cockpit 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)`

- 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_EFFECTIVE_DATE
```
static final java.lang.String AGREEMENT_EFFECTIVE_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
  - BASE_CURRENCY_CODE
```
static final java.lang.String BASE_CURRENCY_CODE
```
    Constant for the property that represents the currency code from a previous rating
    
    See Also:
    
    Constant Field Values
  - BASE_ISO_CURRENCY_CODE
```
static final java.lang.String BASE_ISO_CURRENCY_CODE
```
    Constant for the property that represents the currency code 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
  - CONTRACT_ID
```
static final java.lang.String CONTRACT_ID
```
    Constant for default property contract ID
    
    See Also:
    
    Constant Field Values
  - CONTRACT_ITEM_ID
```
static final java.lang.String CONTRACT_ITEM_ID
```
    Constant for default property contract item ID
    
    See Also:
    
    Constant Field Values
  - CONTRACT_ITEM_EXTERNAL_ID
```
static final java.lang.String CONTRACT_ITEM_EXTERNAL_ID
```
    Constant for default property contract item external ID
    
    See Also:
    
    Constant Field Values
  - TRIGGERING_CONTRACT_ID
```
static final java.lang.String TRIGGERING_CONTRACT_ID
```
    Constant for default property triggering contract ID
    
    See Also:
    
    Constant Field Values
  - TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID
```
static final java.lang.String TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID
```
    Constant for default property triggering contract item external 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
  - RECURRING_PREPAID_TYPE
```
static final java.lang.String RECURRING_PREPAID_TYPE
```
    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
  - CURRENCY_CODE
```
static final java.lang.String CURRENCY_CODE
```
    Constant for the property that represents the currency code of a prepaid account
    
    See Also:
    
    Constant Field Values
  - ISO_CURRENCY_CODE
```
static final java.lang.String ISO_CURRENCY_CODE
```
    Constant for the property that represents the currency code of a prepaid account
    
    See Also:
    
    Constant Field Values
  - EMPTY_LIMIT
```
static final java.lang.String EMPTY_LIMIT
```
    Constant for the property that represents the empty limit amount of a prepaid account
    
    See Also:
    
    Constant Field Values
  - BALANCE_AMOUNT
```
static final java.lang.String BALANCE_AMOUNT
```
    Constant for the property that represents the amount of a prepaid balance
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_STATE
```
static final java.lang.String ACCOUNT_STATE
```
    Constant for the property that represents the state of a prepaid account
    
    See Also:
    
    Constant Field Values
  - RESTRICTION
```
static final java.lang.String RESTRICTION
```
    The name of additional info that defines the type of restriction applied on a Property. Currently (version 3.0 of SAP CC) restriction is used only with property ACCOUNT_STATE.
    
    See Also:
    
    Constant Field Values
  - ENUMERATION
```
static final java.lang.String ENUMERATION
```
    A possible value for RESTRICTION
    
    See Also:
    
    Constant Field Values
  - ENUMERATION_CLASS
```
static final java.lang.String ENUMERATION_CLASS
```
    The enum class that represents allowed values in ENUMERATION
    
    See Also:
    
    Constant Field Values
  - ENUMERATION_TYPE
```
static final java.lang.String ENUMERATION_TYPE
```
    The name of additional info that defines the type of enumeration applied on a Property. Currently (version 5.0 of SAP CC) restriction is used only with property ACCOUNT_STATE.
    
    See Also:
    
    Constant Field Values
  - INTERNAL_ENUMERATION
```
static final java.lang.String INTERNAL_ENUMERATION
```
    A possible value for ENUMERATION_TYPE
    
    See Also:
    
    Constant Field Values
  - REFILL_DATE
```
static final java.lang.String REFILL_DATE
```
    Constant for default property refill date
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_EVENT_DATE
```
static final java.lang.String ACCOUNT_EVENT_DATE
```
    Constant for default property account event date
    
    See Also:
    
    Constant Field Values
  - THRESHOLD_AMOUNT
```
static final java.lang.String THRESHOLD_AMOUNT
```
    Constant for the property that represents the threshold amount of an account event
    
    See Also:
    
    Constant Field Values
  - REFILL_AMOUNT_PROPERTY_NAME
```
static final java.lang.String REFILL_AMOUNT_PROPERTY_NAME
```
    Constant for the property describing the amount of the refill process
    
    See Also:
    
    Constant Field Values
  - REFILL_CURRENCY_PROPERTY_NAME
```
static final java.lang.String REFILL_CURRENCY_PROPERTY_NAME
```
    Constant for the property describing the currency code of the refill logic
    
    See Also:
    
    Constant Field Values
  - REFILL_ISO_CURRENCY_PROPERTY_NAME
```
static final java.lang.String REFILL_ISO_CURRENCY_PROPERTY_NAME
```
    Constant for the property describing the ISO currency code of the refill process
    
    See Also:
    
    Constant Field Values
  - LOCKED_DATE
```
static final java.lang.String LOCKED_DATE
```
    Constant for the property that represents the locked date of a prepaid balance
    
    See Also:
    
    Constant Field Values
  - BLOCKED_DATE
```
static final java.lang.String BLOCKED_DATE
```
    Constant for the property that represents the blocked date of a prepaid balance
    
    See Also:
    
    Constant Field Values
  - CLOSED_DATE
```
static final java.lang.String CLOSED_DATE
```
    Constant for the property that represents the closed date of a prepaid balance
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_START_DATE
```
static final java.lang.String ALLOWANCE_START_DATE
```
    Constant for the property that represents the start date of an allowance.
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_END_DATE
```
static final java.lang.String ALLOWANCE_END_DATE
```
    Constant for the property that represents the end date of an allowance.
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_PRE_START_DATE
```
static final java.lang.String ALLOWANCE_PRE_START_DATE
```
    Constant for the property that represents the start date of an allowance.
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_PRE_END_DATE
```
static final java.lang.String ALLOWANCE_PRE_END_DATE
```
    Constant for the property that represents the end date of an allowance.
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_UNIQUE_IDENTIFIER
```
static final java.lang.String ALLOWANCE_UNIQUE_IDENTIFIER
```
    Constant for the property that represents the unique identifier of an allowance.
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_SHARE_IDENTIFIER
```
static final java.lang.String ALLOWANCE_SHARE_IDENTIFIER
```
    Constant for the property that represents the share identifier of an allowance.
    
    See Also:
    
    Constant Field Values
  - ALLOWANCE_CREATION_DATE
```
static final java.lang.String ALLOWANCE_CREATION_DATE
```
    Constant for the property that represents the unique identifier of an allowance.
    
    See Also:
    
    Constant Field Values
  - DATE_MAX_VALUE
```
static final java.util.Date DATE_MAX_VALUE
```
    Constant for the maximum usable date in the system: 9999-01-01T00:00:00.000 UTC.
  - PRORATED
```
static final java.lang.String PRORATED
```
    Constant for when a recurring rate is prorated.
    
    See Also:
    
    Constant Field Values
  - NOT_PRORATED
```
static final java.lang.String NOT_PRORATED
```
    Constant for when a recurring rate is not prorated.
    
    See Also:
    
    Constant Field Values
  - REFUNDED
```
static final java.lang.String REFUNDED
```
    Constant for when a recurring rate is refunded.
    
    See Also:
    
    Constant Field Values
  - NOT_REFUNDED
```
static final java.lang.String NOT_REFUNDED
```
    Constant for when a recurring rate is not refunded.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - clean
```
void clean()
```
    Cleans 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
  - getIsContractFlag
```
boolean getIsContractFlag()
```
    Returns true if charge component uses charging contract.
    
    Returns:
    
    true if charge component uses charging contract, false otherwise.
  - setIsContractFlag
```
void setIsContractFlag(boolean flag)
```
    Sets the use charging contract flag.
    
    Parameters:
    
    flag - The flag to define if charge component uses charging contract
  - getIsAllowanceFlag
```
boolean getIsAllowanceFlag()
```
    Returns true if charge component is an allowance logic (shared or not).
    
    Returns:
    
    true if charge component is an allowance logic (shared or not), false otherwise.
  - setAllowanceFlag
```
void setAllowanceFlag(RatingContextDescription.AllowanceFlag flag)
```
    Sets the use allowance flag.
    
    Parameters:
    
    flag - the flag to define if charge component is an allowance component.
  - setManagedByCockpit
```
void setManagedByCockpit(boolean isManagedByCockpit)
```
    Sets the managed by cockpit flag.
    
    Parameters:
    
    isManagedByCockpit - the flag to define if the charge component is managed by Cockpit or not
  - isManagedByCockpit
```
boolean isManagedByCockpit()
```
    Returns true if the charge component is managed by Cockpit.
    
    Returns:
    
    true if the charge component is managed by Cockpit, false otherwise
  - getAllowanceFlag
```
RatingContextDescription.AllowanceFlag getAllowanceFlag()
```
    Gets the use allowance flag.
    
    Returns:
    
    the flag that define if charge component is an allowance component, a shared allowance component or not an allowance.
  - 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, 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

Parameters:: name - The property name; type - The property type; category - The category of the property

setPropertyDescription

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

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

Interface RatingContextDescription

Nested Class Summary

Field Summary

Method Summary

Field Detail

MASTER_TYPE

DEPENDENT_TYPE

PRICING_MACRO_TYPE

AGREEMENT_EFFECTIVE_DATE

AGREEMENT_CANCELLATION_DATE

AGREEMENT_SUSPENSION_DATE

AGREEMENT_RESUMPTION_DATE

AGREEMENT_ENDCOMMITMENT_DATE

PRICE_PLAN_NAME

CHARGE_DESCRIPTION

BASE_AMOUNT

BASE_CURRENCY_CODE

BASE_ISO_CURRENCY_CODE

PRODUCT_CODE

CI_NAME

CONSUMPTION_DATE

USER_SERVICE_ID

CONTRACT_ID

CONTRACT_ITEM_ID

CONTRACT_ITEM_EXTERNAL_ID

TRIGGERING_CONTRACT_ID

TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID

SERVICE_ID

RECURRING_START

RECURRING_STOP

RECURRING_START_REF

RECURRING_STOP_REF

RECURRING_PRORATA

RECURRING_PREPAID_TYPE

ACTIVATION_DATE

RECURRING_REFUND

UNROUNDED_AMOUNT

CURRENCY_CODE

ISO_CURRENCY_CODE

EMPTY_LIMIT

BALANCE_AMOUNT

ACCOUNT_STATE

RESTRICTION

ENUMERATION

ENUMERATION_CLASS

ENUMERATION_TYPE

INTERNAL_ENUMERATION

REFILL_DATE

ACCOUNT_EVENT_DATE

THRESHOLD_AMOUNT

REFILL_AMOUNT_PROPERTY_NAME

REFILL_CURRENCY_PROPERTY_NAME

REFILL_ISO_CURRENCY_PROPERTY_NAME

LOCKED_DATE

BLOCKED_DATE

CLOSED_DATE

ALLOWANCE_START_DATE

ALLOWANCE_END_DATE

ALLOWANCE_PRE_START_DATE

ALLOWANCE_PRE_END_DATE

ALLOWANCE_UNIQUE_IDENTIFIER

ALLOWANCE_SHARE_IDENTIFIER

ALLOWANCE_CREATION_DATE

DATE_MAX_VALUE

PRORATED

NOT_PRORATED

REFUNDED

NOT_REFUNDED

Method Detail

clean

getCurrencyCode

setCurrencyCode

getIsContractFlag

setIsContractFlag

getIsAllowanceFlag

setAllowanceFlag

setManagedByCockpit

isManagedByCockpit

getAllowanceFlag

setPropertyDescription