com.highdeal.pnr.hci
Class RatingContextDescriptionProvider

java.lang.Object
  extended by 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
static class RatingContextDescriptionProvider.ParameterFilter
           
 
Nested classes/interfaces inherited from interface com.highdeal.pnr.hci.RatingContextDescription
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_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, 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, UNROUNDED_AMOUNT, USER_SERVICE_ID
 
Constructor Summary
RatingContextDescriptionProvider()
           
RatingContextDescriptionProvider(java.lang.String relationType)
          Constructs a rating context description provider with a specified business relationship type.
 
Method Summary
 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)
           
 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 component.
 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 getRelationType()
          Gets the relation type.
 SharedObjectsRetriever getSharedObjectsRetriever()
           
static java.lang.String getUnprefixedName(java.lang.String propertyFullName)
           
protected static boolean hasGivenAdditionalInfos(PropertyDescriptionModel property, java.util.List<AdditionalInfoModel> criteria)
          Checks that a property description has all the expected criteria (additional info fields)
 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.
 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 setCurrencyCode(java.lang.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, java.lang.Object objectCode)
           
 void setObjectCodeFor(UsageRateModel model, java.lang.Object objectCode)
           
 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
clone, equals, finalize, 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 fleg 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 component.

Specified by:
getIsAllowanceFlag in interface RatingContextDescription
Returns:
true if charge component is an allowance component, false otherwise.

setIsAllowanceFlag

public void setIsAllowanceFlag(boolean flag)
Description copied from interface: RatingContextDescription
Sets the use allowance flag.

Specified by:
setIsAllowanceFlag in interface RatingContextDescription
Parameters:
flag - the fleg to define if charge component is an allowance component.

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
  • Specified by:
    setPropertyDescription in interface RatingContextDescription
    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

    public void setPropertyDescription(PropertyDescriptionModel pd,
                                       DetailCategory category)
    Description copied from interface: RatingContextDescription
    Adds a property with its description to the context. See setPropertyDescription for allowed categories.

    Specified by:
    setPropertyDescription in interface RatingContextDescription
    Parameters:
    pd - The property description
    category - The category of the property

    getAvailablePropertyNames

    public java.util.List<java.lang.String> getAvailablePropertyNames(RatingContextDescription.IPropertyFilter filter)
    Description copied from interface: RatingContextDescription
    Gets all property names that matches the filter.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    Parameters:
    filter - The filter that describes the constraints to check
    Returns:
    A list of property name

    getAvailablePropertyNames

    public java.util.List<java.lang.String> getAvailablePropertyNames(int propertyType,
                                                                      boolean strict)
    Description copied from interface: RatingContextDescription
    Gets all properties of the specified type. see setPropertyDescription for allowed types.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    Parameters:
    propertyType - the type of the property.
    strict - true if the types must be strictly equal.
    Returns:
    a list of String.

    getAvailablePropertyNames

    public java.util.List<java.lang.String> getAvailablePropertyNames(int propertyType)
    Description copied from interface: RatingContextDescription
    Gets all properties of the specified type. See setPropertyDescription for allowed types.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    Parameters:
    propertyType - The type of the property
    Returns:
    A list of String

    getAvailablePropertyNames

    public java.util.List<java.lang.String> getAvailablePropertyNames(int propertyType,
                                                                      java.util.List<AdditionalInfoModel> criteria)
    Description copied from interface: RatingContextDescription
    Gets all properties of the specified type and matching the given criteria. See setPropertyDescription for allowed types.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    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

    public java.util.Vector<java.lang.String> getAvailablePropertyNames(java.lang.String category)
    Description copied from interface: RatingContextDescription
    Gets all property names from a category. see setPropertyDescription for allowed categories.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    Parameters:
    category - the category of the property.
    Returns:
    a list of String.

    hasGivenAdditionalInfos

    protected static boolean hasGivenAdditionalInfos(PropertyDescriptionModel property,
                                                     java.util.List<AdditionalInfoModel> criteria)
    Checks that a property description has all the expected criteria (additional info fields)

    Parameters:
    property - the property of which the additional info must be checked
    criteria - the criteria to match against the property's additional info
    Returns:
    whether the property description's additional info matches the given criteria

    getAvailablePropertyNames

    public java.util.List<java.lang.String> getAvailablePropertyNames(int propertyType,
                                                                      java.lang.String category,
                                                                      java.util.List<AdditionalInfoModel> criteria)
    Description copied from interface: RatingContextDescription
    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.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    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.

    getAvailablePropertyNames

    public java.util.List<java.lang.String> getAvailablePropertyNames(int propertyType,
                                                                      java.lang.String category)
    Description copied from interface: RatingContextDescription
    Gets all properties of the specified type and category. see setPropertyDescription for allowed types. see setPropertyDescription for allowed categories.

    Specified by:
    getAvailablePropertyNames in interface RatingContextDescription
    Parameters:
    propertyType - the type of the property.
    category - the category of the property.
    Returns:
    a list of String.

    getAvailableFullNamedProperties

    public java.util.List<PropertyDescriptionModel> getAvailableFullNamedProperties(RatingContextDescription.IPropertyFilter filter)
    Description copied from interface: RatingContextDescription
    Gets all property descriptions that matches the filter.

    Specified by:
    getAvailableFullNamedProperties in interface RatingContextDescription
    Parameters:
    filter - The filter that describes the constraints to check
    Returns:
    A list of property descriptions

    getAllAvailableFullNamedProperties

    public java.util.Vector<PropertyDescriptionModel> getAllAvailableFullNamedProperties()
    Description copied from interface: RatingContextDescription
    Gets all properties from all categories.

    Specified by:
    getAllAvailableFullNamedProperties in interface RatingContextDescription
    Returns:
    a List of property description model.

    isPropertyValid

    public boolean isPropertyValid(java.lang.String propertyName,
                                   DetailCategory category)
    Description copied from interface: RatingContextDescription
    Tests if a property from a category is valid. see setPropertyDescription for allowed categories and names.

    Specified by:
    isPropertyValid in interface RatingContextDescription
    Parameters:
    propertyName - the property name.
    category - the category of the property.
    Returns:
    true if the property is valid, false otherwise.

    isPropertyValid

    public boolean isPropertyValid(java.lang.String longPropertyName,
                                   int type)
    Description copied from interface: RatingContextDescription
    Test if a property from a category is valid. see setPropertyDescription for allowed types and names.

    Specified by:
    isPropertyValid in interface RatingContextDescription
    Parameters:
    longPropertyName - the property name.
    type - the property type.
    Returns:
    true if the property is valid, false otherwise.

    getAllChargeableItemClassCodes

    public java.util.List<SearchCodeResult.ObjectCode> getAllChargeableItemClassCodes()
    Specified by:
    getAllChargeableItemClassCodes in interface RatingContextDescription
    Returns:
    Object Codes of all Chargeable Item Classes.

    cleanAllChargeableItemClassCodes

    public void cleanAllChargeableItemClassCodes()
    Description copied from interface: RatingContextDescription
    Clean the cache of Chargeable Item Description or Class used by the method RatingContextDescription.getAllChargeableItemClassCodes().

    Specified by:
    cleanAllChargeableItemClassCodes in interface RatingContextDescription

    getObjectCodeForCI

    public SearchCodeResult.ObjectCode getObjectCodeForCI(java.lang.String ciName,
                                                          java.util.List<ProductModel> products)
    Specified by:
    getObjectCodeForCI in interface RatingContextDescription
    Returns:
    an ObjectCode

    getObjectCodeFor

    public SearchCodeResult.ObjectCode getObjectCodeFor(UsageRateModel model)
    Specified by:
    getObjectCodeFor in interface RatingContextDescription
    Returns:
    an ObjectCode

    setObjectCodeFor

    public void setObjectCodeFor(UsageRateModel model,
                                 java.lang.Object objectCode)
    Specified by:
    setObjectCodeFor in interface RatingContextDescription
    objectCode - is an ObjectCode

    getObjectCodeFor

    public SearchCodeResult.ObjectCode getObjectCodeFor(UsageChargeModel model)
    Specified by:
    getObjectCodeFor in interface RatingContextDescription
    Returns:
    an ObjectCode

    setObjectCodeFor

    public void setObjectCodeFor(UsageChargeModel model,
                                 java.lang.Object objectCode)
    Specified by:
    setObjectCodeFor in interface RatingContextDescription
    objectCode - Is an ObjectCode

    getCIDescriptionFor

    public ChargeableItemDescriptionModel getCIDescriptionFor(java.lang.Object objectCodeParam)
    Specified by:
    getCIDescriptionFor in interface RatingContextDescription
    Parameters:
    objectCodeParam - Is an ObjectCode (of a Chargeable Item Description or Class)
    Returns:
    A ChargeableItemDescriptionModel

    addProductCIDescription

    public void addProductCIDescription(QualifiedChargeableItemDescription cid)
    Specified by:
    addProductCIDescription in interface RatingContextDescription

    addUsedCIDescriptionForRating

    public void addUsedCIDescriptionForRating(QualifiedChargeableItemDescription cid)
    Specified by:
    addUsedCIDescriptionForRating in interface RatingContextDescription

    addUsedCIDescriptionForCharging

    public void addUsedCIDescriptionForCharging(QualifiedChargeableItemDescription cid)
    Specified by:
    addUsedCIDescriptionForCharging in interface RatingContextDescription

    availableCINamesForRating

    public java.util.Vector<QualifiedChargeableItemDescription> availableCINamesForRating(java.lang.String ciName)
    Returns a list of QualifiedChargeableItemDescription.

    Specified by:
    availableCINamesForRating in interface RatingContextDescription
    Parameters:
    ciName -
    Returns:
    a list of QualifiedChargeableItemDescription.

    availableCINamesForCharging

    public java.util.List<QualifiedChargeableItemDescription> availableCINamesForCharging(java.lang.String ciName)
    Returns a list of QualifiedChargeableItemDescription.

    Specified by:
    availableCINamesForCharging in interface RatingContextDescription
    Parameters:
    ciName -
    Returns:
    a list of QualifiedChargeableItemDescription.

    getAvailableEventNames

    public java.util.List<java.lang.String> getAvailableEventNames()
    Returns a vector of strings representing the default events that a type of relationship can produce.

    Specified by:
    getAvailableEventNames in interface RatingContextDescription
    Returns:
    a vector of event names (string).

    isEventValid

    public boolean isEventValid(java.lang.String eventName)
    Description copied from interface: RatingContextDescription
    Returns true if the event name is a valid one.

    Specified by:
    isEventValid in interface RatingContextDescription
    Parameters:
    eventName - the name of the event.
    Returns:
    true if the event name is valid, false otherwise.

    isCIValid

    public boolean isCIValid(java.lang.String ciName)
    Description copied from interface: RatingContextDescription
    Returns true if the Chargeable item is a valid one.

    Specified by:
    isCIValid in interface RatingContextDescription
    Parameters:
    ciName - a Chargeable item name.
    Returns:
    true if the Chargeable item name is valid, false otherwise.

    isChargeableItemClassValid

    public boolean isChargeableItemClassValid(java.lang.Object objectCode)
    Description copied from interface: RatingContextDescription
    Returns true if the Chargeable item is a valid one.

    Specified by:
    isChargeableItemClassValid in interface RatingContextDescription
    Parameters:
    objectCode - the code of a Chargeable item .
    Returns:
    true if the Chargeable item name is valid, false otherwise.

    isRefillItemValid

    public boolean isRefillItemValid(java.lang.String riName)
    Description copied from interface: RatingContextDescription
    Returns true if the Refill Item Class exists.

    Specified by:
    isRefillItemValid in interface RatingContextDescription
    Parameters:
    riName - a Refill Item Class name.
    Returns:
    true if the Refill Item Class exists, false otherwise.

    isPropagationSensitive

    public boolean isPropagationSensitive()
    Specified by:
    isPropagationSensitive in interface RatingContextDescription

    setSharedObjectsRetriever

    public void setSharedObjectsRetriever(SharedObjectsRetriever retriever)
    Specified by:
    setSharedObjectsRetriever in interface RatingContextDescription

    getSharedObjectsRetriever

    public SharedObjectsRetriever getSharedObjectsRetriever()
    Specified by:
    getSharedObjectsRetriever in interface RatingContextDescription

    getRelationType

    public java.lang.String getRelationType()
    Description copied from interface: RatingContextDescription
    Gets the relation type. Returned values are :

    Specified by:
    getRelationType in interface RatingContextDescription
    Returns:
    the relation type.

    setRelationType

    public void setRelationType(java.lang.String type)
    Description copied from interface: RatingContextDescription
    Sets the relation type.

    Specified by:
    setRelationType in interface RatingContextDescription
    Parameters:
    type - the relation type. Allowed values are :

    getUnprefixedName

    public static java.lang.String getUnprefixedName(java.lang.String propertyFullName)

    getInitialPrefixedName

    public static DetailCategory getInitialPrefixedName(java.lang.String propertyFullName)

    getInitialPrefixedName

    public static DetailCategory getInitialPrefixedName(DetailCategory fromCategory)

    getDefaultPropertyDescriptions

    public java.util.List<PropertyDescriptionModel> getDefaultPropertyDescriptions()
    Returns the descriptions for the default properties used by the rating process. The vector contains PropertyDescriptionModel.

    Specified by:
    getDefaultPropertyDescriptions in interface RatingContextDescription
    Returns:
    a list of property description models.

    getDefaultStaticPropertyDescriptions

    public static java.util.List<PropertyDescriptionModel> getDefaultStaticPropertyDescriptions()

    getDefaultPropertyDescriptionsForRefill

    public java.util.List<PropertyDescriptionModel> getDefaultPropertyDescriptionsForRefill()
    Returns the descriptions for the default properties used by the refilling process. The vector contains PropertyDescriptionModel.

    Specified by:
    getDefaultPropertyDescriptionsForRefill in interface RatingContextDescription
    Returns:
    a list of property description models.

    getDefaultStaticPropertyDescriptionsForRefill

    public static java.util.List<PropertyDescriptionModel> getDefaultStaticPropertyDescriptionsForRefill()

    areTypesEqual

    public static boolean areTypesEqual(PropertyDescriptionModel pd,
                                        int type,
                                        boolean strict)
    Returns whether a specified property description type is equal to a specified type.

    Parameters:
    pd - The property description to check.
    type - The type to compare to.
    strict - true if the types must be strictly equal.
    Returns:
    true if the property description type is equal to the type, false otherwise.

    isVisible

    public static boolean isVisible(java.lang.String propertyName)
    Returns whether a specified property name is linked to a visible property.

    Parameters:
    propertyName - The property name to check.
    Returns:
    true if the property is visible, false otherwise.

    isAllowanceEventClassValid

    public boolean isAllowanceEventClassValid(java.lang.String ecName)
    Description copied from interface: RatingContextDescription
    Returns true if the Allowance Event Class exists.

    Specified by:
    isAllowanceEventClassValid in interface RatingContextDescription
    Parameters:
    ecName - a Allowance Event Class name.
    Returns:
    true if the Allowance Event Class exists, false otherwise.

    getAllowanceEventClass

    public com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel getAllowanceEventClass(java.lang.String ecName)
    Specified by:
    getAllowanceEventClass in interface RatingContextDescription
    Parameters:
    ecName - a Allowance Event Class name.
    Returns:
    a AllowanceEventRateModel

    Document Published: October 2015 (SAP CC 4.0 SP10 and Later)