Package com.highdeal.pnr.hci

Interface RatingContextDescription

All Known Implementing Classes:
RatingContextDescriptionProvider
public interface RatingContextDescription
FOR INTERNAL USE ONLY - This Java interface allows to put/get properties from a rating context.

  • Field Details

    • MASTER_TYPE

      static final String MASTER_TYPE
      Constant for master relation type
      See Also:

    • DEPENDENT_TYPE

      static final String DEPENDENT_TYPE
      Constant for dependent relation type
      See Also:

    • PRICING_MACRO_TYPE

      static final String PRICING_MACRO_TYPE
      Constant for pricing macro relation type
      See Also:

    • AGREEMENT_EFFECTIVE_DATE

      static final String AGREEMENT_EFFECTIVE_DATE
      Constant for default property agreement subscription date
      See Also:

    • AGREEMENT_CANCELLATION_DATE

      static final String AGREEMENT_CANCELLATION_DATE
      Constant for default property agreement cancellation date
      See Also:

    • AGREEMENT_SUSPENSION_DATE

      static final String AGREEMENT_SUSPENSION_DATE
      Constant for default property agreement suspension date
      See Also:

    • AGREEMENT_RESUMPTION_DATE

      static final String AGREEMENT_RESUMPTION_DATE
      Constant for default property agreement resumption date
      See Also:

    • AGREEMENT_ENDCOMMITMENT_DATE

      static final String AGREEMENT_ENDCOMMITMENT_DATE
      Constant for default property agreement resumption date
      See Also:

    • PRICE_PLAN_NAME

      static final String PRICE_PLAN_NAME
      Constant for name of the price plan
      See Also:

    • CHARGE_DESCRIPTION

      static final String CHARGE_DESCRIPTION
      Constant for the property that represents the description of the charge
      See Also:

    • BASE_AMOUNT

      static final String BASE_AMOUNT
      Constant for the property that represents the amount from a previous rating
      See Also:

    • BASE_CURRENCY_CODE

      static final String BASE_CURRENCY_CODE
      Constant for the property that represents the currency code from a previous rating
      See Also:

    • BASE_ISO_CURRENCY_CODE

      static final String BASE_ISO_CURRENCY_CODE
      Constant for the property that represents the currency code from a previous rating
      See Also:

    • PRODUCT_CODE

      static final String PRODUCT_CODE
      Constant for name of the product
      See Also:

    • CI_NAME

      static final String CI_NAME
      Constant for name of the chargeable item
      See Also:

    • CONSUMPTION_DATE

      static final String CONSUMPTION_DATE
      Constant for default property consumption date
      See Also:

    • USER_SERVICE_ID

      static final String USER_SERVICE_ID
      Constant for default property user service ID
      See Also:

    • CONTRACT_ID

      static final String CONTRACT_ID
      Constant for default property contract ID
      See Also:

    • CONTRACT_ITEM_ID

      static final String CONTRACT_ITEM_ID
      Constant for default property contract item ID
      See Also:

    • CONTRACT_ITEM_EXTERNAL_ID

      static final String CONTRACT_ITEM_EXTERNAL_ID
      Constant for default property contract item external ID
      See Also:

    • TRIGGERING_CONTRACT_ID

      static final String TRIGGERING_CONTRACT_ID
      Constant for default property triggering contract ID
      See Also:

    • TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID

      static final String TRIGGERING_CONTRACT_ITEM_EXTERNAL_ID
      Constant for default property triggering contract item external ID
      See Also:

    • SERVICE_ID

      static final String SERVICE_ID
      Constant for default property service ID
      See Also:

    • RECURRING_START

      static final String RECURRING_START
      Constant for the property that represents the period start in case of a recurring rate
      See Also:

    • RECURRING_STOP

      static final String RECURRING_STOP
      Constant for the property that represents the period end in case of a recurring rate.
      See Also:

    • RECURRING_START_REF

      static final String RECURRING_START_REF
      Constant for the property that represents the reference period start in case of a recurring rate
      See Also:

    • RECURRING_STOP_REF

      static final String RECURRING_STOP_REF
      Constant for the property that represents the reference period end in case of a recurring rate
      See Also:

    • RECURRING_PRORATA

      static final String RECURRING_PRORATA
      Constant for the property that tells if the amount was prorated or not
      See Also:

    • RECURRING_PREPAID_TYPE

      static final String RECURRING_PREPAID_TYPE
      See Also:

    • ACTIVATION_DATE

      static final String ACTIVATION_DATE
      Constant for default property activation date, that is the activation date for a recurring rate
      See Also:

    • RECURRING_REFUND

      static final String RECURRING_REFUND
      Constant for the property that tells if the amount was refunded or not
      See Also:

    • UNROUNDED_AMOUNT

      static final String UNROUNDED_AMOUNT
      Constant for the property that represents the unrounded amount of a transaction
      See Also:

    • CURRENCY_CODE

      static final String CURRENCY_CODE
      Constant for the property that represents the currency code of a prepaid account
      See Also:

    • ISO_CURRENCY_CODE

      static final String ISO_CURRENCY_CODE
      Constant for the property that represents the currency code of a prepaid account
      See Also:

    • EMPTY_LIMIT

      static final String EMPTY_LIMIT
      Constant for the property that represents the empty limit amount of a prepaid account
      See Also:

    • BALANCE_AMOUNT

      static final String BALANCE_AMOUNT
      Constant for the property that represents the amount of a prepaid balance
      See Also:

    • ACCOUNT_STATE

      static final String ACCOUNT_STATE
      Constant for the property that represents the state of a prepaid account
      See Also:

    • RESTRICTION

      static final 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:

    • ENUMERATION

      static final String ENUMERATION
      A possible value for RESTRICTION
      See Also:

    • ENUMERATION_CLASS

      static final String ENUMERATION_CLASS
      The enum class that represents allowed values in ENUMERATION
      See Also:

    • ENUMERATION_TYPE

      static final 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:

    • INTERNAL_ENUMERATION

      static final String INTERNAL_ENUMERATION
      A possible value for ENUMERATION_TYPE
      See Also:

    • REFILL_DATE

      static final String REFILL_DATE
      Constant for default property refill date
      See Also:

    • ACCOUNT_EVENT_DATE

      static final String ACCOUNT_EVENT_DATE
      Constant for default property account event date
      See Also:

    • THRESHOLD_AMOUNT

      static final String THRESHOLD_AMOUNT
      Constant for the property that represents the threshold amount of an account event
      See Also:

    • REFILL_AMOUNT_PROPERTY_NAME

      static final String REFILL_AMOUNT_PROPERTY_NAME
      Constant for the property describing the amount of the refill process
      See Also:

    • REFILL_CURRENCY_PROPERTY_NAME

      static final String REFILL_CURRENCY_PROPERTY_NAME
      Constant for the property describing the currency code of the refill logic
      See Also:

    • REFILL_ISO_CURRENCY_PROPERTY_NAME

      static final String REFILL_ISO_CURRENCY_PROPERTY_NAME
      Constant for the property describing the ISO currency code of the refill process
      See Also:

    • LOCKED_DATE

      static final String LOCKED_DATE
      Constant for the property that represents the locked date of a prepaid balance
      See Also:

    • BLOCKED_DATE

      static final String BLOCKED_DATE
      Constant for the property that represents the blocked date of a prepaid balance
      See Also:

    • CLOSED_DATE

      static final String CLOSED_DATE
      Constant for the property that represents the closed date of a prepaid balance
      See Also:

    • ALLOWANCE_START_DATE

      static final String ALLOWANCE_START_DATE
      Constant for the property that represents the start date of an allowance.
      See Also:

    • ALLOWANCE_END_DATE

      static final String ALLOWANCE_END_DATE
      Constant for the property that represents the end date of an allowance.
      See Also:

    • ALLOWANCE_PRE_START_DATE

      static final String ALLOWANCE_PRE_START_DATE
      Constant for the property that represents the start date of an allowance.
      See Also:

    • ALLOWANCE_PRE_END_DATE

      static final String ALLOWANCE_PRE_END_DATE
      Constant for the property that represents the end date of an allowance.
      See Also:

    • ALLOWANCE_UNIQUE_IDENTIFIER

      static final String ALLOWANCE_UNIQUE_IDENTIFIER
      Constant for the property that represents the unique identifier of an allowance.
      See Also:

    • ALLOWANCE_SHARE_IDENTIFIER

      static final String ALLOWANCE_SHARE_IDENTIFIER
      Constant for the property that represents the share identifier of an allowance.
      See Also:

    • ALLOWANCE_CREATION_DATE

      static final String ALLOWANCE_CREATION_DATE
      Constant for the property that represents the unique identifier of an allowance.
      See Also:

    • DATE_MAX_VALUE

      static final Date DATE_MAX_VALUE
      Constant for the maximum usable date in the system: 9999-01-01T00:00:00.000 UTC.

    • PRORATED

      static final String PRORATED
      Constant for when a recurring rate is prorated.
      See Also:

    • NOT_PRORATED

      static final String NOT_PRORATED
      Constant for when a recurring rate is not prorated.
      See Also:

    • REFUNDED

      static final String REFUNDED
      Constant for when a recurring rate is refunded.
      See Also:

    • NOT_REFUNDED

      static final String NOT_REFUNDED
      Constant for when a recurring rate is not refunded.
      See Also:

  • Method Details

    • clean

      void clean()
      Cleans the context.

    • getCurrencyCode

      String getCurrencyCode()
      Gets the currency code.
      Returns:
      The currency code

    • setCurrencyCode

      void setCurrencyCode(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(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(String name, int type, DetailCategory category, 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
      • Parameters:
      name - The property name
      type - The property type
      category - The category of the property
      additionalInfo - The additional information of the property. Passing in null is equivalent to passing in an empty list.

    • 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

      List<String> getAvailablePropertyNames(RatingContextDescription.IPropertyFilter filter)
      Gets all property names that matches the filter.
      Parameters:
      filter - The filter that describes the constraints to check
      Returns:
      A list of property name

    • getAvailableFullNamedProperties

      List<PropertyDescriptionModel> getAvailableFullNamedProperties(RatingContextDescription.IPropertyFilter filter)
      Gets all property descriptions that matches the filter.
      Parameters:
      filter - The filter that describes the constraints to check
      Returns:
      A list of property descriptions

    • getAvailablePropertyNames

      List<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

      List<String> getAvailablePropertyNames(int propertyType, List<AdditionalInfoModel> criteria)
      Gets all properties of the specified type and matching the given criteria. See setPropertyDescription for allowed types.
      Parameters:
      propertyType - The type of the property
      criteria - The additional information that must be present in the returned property description models
      Returns:
      A list of String

    • getAvailablePropertyNames

      List<String> getAvailablePropertyNames(int propertyType, boolean strict)
      Gets all properties of the specified type. see setPropertyDescription for allowed types.
      Parameters:
      propertyType - the type of the property.
      strict - true if the types must be strictly equal.
      Returns:
      a list of String.

    • getAvailablePropertyNames

      List<String> getAvailablePropertyNames(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.

    • getAvailablePropertyNames

      List<String> getAvailablePropertyNames(int propertyType, String category)
      Gets all properties of the specified type and category. see setPropertyDescription for allowed types. see setPropertyDescription for allowed categories.
      Parameters:
      propertyType - the type of the property.
      category - the category of the property.
      Returns:
      a list of String.

    • getAvailablePropertyNames

      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. see setPropertyDescription for allowed types. see setPropertyDescription for allowed categories.
      Parameters:
      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.
      Returns:
      a list of names of property description models.

    • getAllAvailableFullNamedProperties

      List<PropertyDescriptionModel> getAllAvailableFullNamedProperties()
      Gets all properties from all categories.
      Returns:
      a List of property description model.

    • isPropertyValid

      boolean isPropertyValid(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(String longPropertyName, int type, boolean strict)
      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.
      strict - true if the types must be strictly equal.
      Returns:
      true if the property is valid, false otherwise.

    • isPropertyValid

      boolean isPropertyValid(String longPropertyName, int type)
      Test if a property from a category is valid, without taking any restriction into account. 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.

    • getPropertyByName

      PropertyDescriptionModel getPropertyByName(String longPropertyName)
      Returns the description of the property by this full name. Only one occurrence can be found, since each new declaration overwrites the previous one. null is returned if there is no property by this name.
      Parameters:
      longPropertyName - full name of the property looked for
      Returns:
      the description of the property whose name is specified, or null if there is none

    • availableCINamesForRating

      List<QualifiedChargeableItemDescription> availableCINamesForRating(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

      List<QualifiedChargeableItemDescription> availableCINamesForCharging(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

      List<String> getAvailableEventNames()
      Returns all available event names of the context.
      Returns:
      a list of event names (string).

    • isEventValid

      boolean isEventValid(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(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.

    • isChargeableItemClassValid

      boolean isChargeableItemClassValid(Object objectCode)
      Returns true if the Chargeable item is a valid one.
      Parameters:
      objectCode - the code of a Chargeable item .
      Returns:
      true if the Chargeable item name is valid, false otherwise.

    • isRefillItemValid

      boolean isRefillItemValid(String riName)
      Returns true if the Refill Item Class exists.
      Parameters:
      riName - a Refill Item Class name.
      Returns:
      true if the Refill Item Class exists, false otherwise.

    • isPropagationSensitive

      boolean isPropagationSensitive()

    • setSharedObjectsRetriever

      void setSharedObjectsRetriever(SharedObjectsRetriever retriever)

    • getSharedObjectsRetriever

      SharedObjectsRetriever getSharedObjectsRetriever()

    • getRelationType

      String getRelationType()
      Gets the relation type. Returned values are :
      Returns:
      the relation type.

    • setRelationType

      void setRelationType(String type)
      Sets the relation type.
      Parameters:
      type - the relation type. Allowed values are :

    • getDefaultPropertyDescriptions

      List<PropertyDescriptionModel> getDefaultPropertyDescriptions()
      Returns the descriptions for the default properties used by the rating process. The vector contains PropertyDescriptionModel.
      Returns:
      a list of property description models.

    • getDefaultPropertyDescriptionsForRefill

      List<PropertyDescriptionModel> getDefaultPropertyDescriptionsForRefill()
      Returns the descriptions for the default properties used by the refill process. The vector contains PropertyDescriptionModel.
      Returns:
      a list of property description models.

    • addProductCIDescription

      void addProductCIDescription(QualifiedChargeableItemDescription cid)

    • addUsedCIDescriptionForRating

      void addUsedCIDescriptionForRating(QualifiedChargeableItemDescription cid)

    • addUsedCIDescriptionForCharging

      void addUsedCIDescriptionForCharging(QualifiedChargeableItemDescription cid)

    • isAllowanceEventClassValid

      boolean isAllowanceEventClassValid(String ecName)
      Returns true if the Allowance Event Class exists.
      Parameters:
      ecName - a Allowance Event Class name.
      Returns:
      true if the Allowance Event Class exists, false otherwise.

    • getObjectCodeForCI

      Object getObjectCodeForCI(String ciName, List<ProductModel> products)
      Parameters:
      ciName -
      products -
      Returns:
      an ObjectCode

    • getObjectCodeFor

      Object getObjectCodeFor(UsageRateModel model)
      Parameters:
      model -
      Returns:
      an ObjectCode

    • setObjectCodeFor

      void setObjectCodeFor(UsageRateModel model, Object objectCode)
      Parameters:
      model -
      objectCode - is an ObjectCode

    • getObjectCodeFor

      Object getObjectCodeFor(UsageChargeModel model)
      Parameters:
      model -
      Returns:
      an ObjectCode

    • setObjectCodeFor

      void setObjectCodeFor(UsageChargeModel model, Object objectCode)
      Parameters:
      model -
      objectCode - Is an ObjectCode

    • getCIDescriptionFor

      ChargeableItemDescriptionModel getCIDescriptionFor(Object objectCode)
      Parameters:
      objectCode - Is an ObjectCode (of a Chargeable Item Description or Class)
      Returns:
      A ChargeableItemDescriptionModel

    • getAllChargeableItemClassCodes

      List<? extends Object> getAllChargeableItemClassCodes()
      Returns:
      All the ObjectCode of Chargeable Item Description or Class

    • cleanAllChargeableItemClassCodes

      void cleanAllChargeableItemClassCodes()
      Clean the cache of Chargeable Item Description or Class used by the method getAllChargeableItemClassCodes().

    • getOneShotTriggerName

      String getOneShotTriggerName()

    • setOneShotTriggerName

      void setOneShotTriggerName(String oneShotTriggerName)

    • getAllowanceEventClass

      com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel getAllowanceEventClass(String ecName)
      Parameters:
      ecName - a Allowance Event Class name.
      Returns:
      a AllowanceEventRateModel