com.ibm.commerce.giftregistry.registry

Class GiftRegistryRules

java.lang.Object

com.ibm.commerce.giftregistry.registry.GiftRegistryRules

All Implemented Interfaces:

ECGiftRegistryRuleConstants

public class GiftRegistryRules
extends java.lang.Object
implements ECGiftRegistryRuleConstants

Provides a set of helper methods and code logic to retrieve business rule data from the GiftRegistryRuleRegistry Behaviour:

• Searches for a business rule value for a specific store, event type and business rule, then provides input parameters of storeId (Integer), eventTypeName (string), and businessRuleName (Integer).
  

  Searches for a business rule value for a specific store and business rule only, then provides input parameters of storeId (Integer) and businessRuleName (Integer).

  All business rules available are defined as constants in the ECGiftRegistryRuleContstant class.
  

  When looking up a registry rule value, providing input parameters by storeId, eventTypeName, and businessRuleName, the IBM Gift Center rule cache will first check for a perfect match given the values provided. If there is no result found, then it will then check for the default value of the site with storeId of -1 and with the provided eventTypeName and businessRuleName.
  

  Looks up a registry rule value, providing input parameters by only the storeId and businessRuleName, the IBM Gift Center rule cache will first check for a perfect match given the values provided. If there is no result found, then it will then check for the default value of the site with storeId of -1 and default eventTypeName of Default with the provided business rule name.
  

Exception conditions:

• None. If no rule is found, then a null value is returned.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME The name of this class
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.giftregistry.registry.ECGiftRegistryRuleConstants

EC_RULE_DAYS_COMPLETION_PROG_ELIGIBLE_PAST_EVENT, EC_RULE_DAYS_COMPLETION_PROG_INELIGIBLE_PAST_EVENT, EC_RULE_DAYS_EVENT_DATE_VALID_IN_FUTURE, EC_RULE_DAYS_EVENT_DATE_VALID_IN_PAST, EC_RULE_DEFAULT_EVENT_TYPE_NAME, EC_RULE_DEFAULT_STORE_ID, EC_RULE_DISPLAY_ALL_PURCHASE_RECORDS, EC_RULE_EVENT_DATE_IN_PAST, EC_RULE_GR_ITEMS_CAN_BE_REMOVED_WITH_PURCHASE_RECORDS, EC_RULE_MAX_NUM_OF_GIFT_ITEM_QTY, EC_RULE_MAXIMUM_NUM_OF_REGISTRIES, EC_RULE_MAXIMUM_NUM_OF_SEARCH_RESULTS, EC_RULE_NUM_MILLISECONDS_PER_DAY, EC_RULE_TOTAL_NUM_OF_REGISTRY_ITEMS, EC_RULE_UPDATE_QTY_LESS_THAN_QTY_PURCHASED

Constructor Summary

Constructors

Constructor and Description
GiftRegistryRules()

Method Summary

Modifier and Type	Method and Description
static GiftRegistryRuleRegistry.GiftRegistryRuleEntry	getRuleEntryByStoreIdByEventTypeNameByName(java.lang.Integer storeId, java.lang.String eventTypeName, java.lang.Integer ruleName) Private method that returns the grRuleValue value associated with a business rule given storeId, eventTypeName, and the businessRuleName.
static GiftRegistryRuleRegistry.GiftRegistryRuleEntry	getRuleEntryByStoreIdByName(java.lang.Integer storeId, java.lang.Integer ruleName) Private method that returns the grRuleValue value associated with a business rule given storeId and the business rule name
static boolean	getRuleValueAsBoolean(java.lang.Integer storeId, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a boolean given storeId, and the business rule name returns true if registry value = "1", else returns false.
static boolean	getRuleValueAsBoolean(java.lang.Integer storeId, java.lang.String eventTypeName, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a boolean given storeId, eventTypeName, and the business rule name returns true if registry value = "1", else returns false.
static java.sql.Date	getRuleValueAsDate(java.lang.Integer storeId, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a Date given storeId, and the business rule name
static java.sql.Date	getRuleValueAsDate(java.lang.Integer storeId, java.lang.String eventTypeName, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a Date given storeId, eventTypeName, and the business rule name
static java.lang.Integer	getRuleValueAsInteger(java.lang.Integer storeId, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a String given storeId and the business rule name
static java.lang.Integer	getRuleValueAsInteger(java.lang.Integer storeId, java.lang.String eventTypeName, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as an Integer given storeId, eventTypeName, and the business rule name
static java.lang.Long	getRuleValueAsLong(java.lang.Integer storeId, java.lang.Integer ruleName) public method that returns the grRuleValue value associated with a business rule as a Long given storeId and the business rule name
static java.lang.Long	getRuleValueAsLong(java.lang.Integer storeId, java.lang.String eventTypeName, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a Long given storeId, eventTypeName, and the business rule name
static java.lang.String	getRuleValueAsString(java.lang.Integer storeId, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a String given storeId and the business rule name
static java.lang.String	getRuleValueAsString(java.lang.Integer storeId, java.lang.String eventTypeName, java.lang.Integer ruleName) Public method that returns the grRuleValue value associated with a business rule as a String given storeId, eventTypeName, and the business rule name

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static java.lang.String CLASS_NAME

The name of this class

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

GiftRegistryRules

public GiftRegistryRules()

Method Detail

getRuleEntryByStoreIdByEventTypeNameByName

public static GiftRegistryRuleRegistry.GiftRegistryRuleEntry getRuleEntryByStoreIdByEventTypeNameByName(java.lang.Integer storeId,
                                                                                                        java.lang.String eventTypeName,
                                                                                                        java.lang.Integer ruleName)

Private method that returns the grRuleValue value associated with a business rule given storeId, eventTypeName, and the businessRuleName.

Parameters:

storeId -

eventTypeName -

name -

Returns:

GiftRegistryRuleEntry ruleEntry

getRuleEntryByStoreIdByName

public static GiftRegistryRuleRegistry.GiftRegistryRuleEntry getRuleEntryByStoreIdByName(java.lang.Integer storeId,
                                                                                         java.lang.Integer ruleName)

Private method that returns the grRuleValue value associated with a business rule given storeId and the business rule name

Parameters:

storeId -

name -

Returns:

GiftRegistryRuleEntry ruleEntry

getRuleValueAsString

public static java.lang.String getRuleValueAsString(java.lang.Integer storeId,
                                                    java.lang.String eventTypeName,
                                                    java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a String given storeId, eventTypeName, and the business rule name

Parameters:

storeId -

eventTypeName -

name -

Returns:

grRuleVal string

getRuleValueAsString

public static java.lang.String getRuleValueAsString(java.lang.Integer storeId,
                                                    java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a String given storeId and the business rule name

Parameters:

storeId -

name -

Returns:

grRuleVal string

getRuleValueAsInteger

public static java.lang.Integer getRuleValueAsInteger(java.lang.Integer storeId,
                                                      java.lang.String eventTypeName,
                                                      java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as an Integer given storeId, eventTypeName, and the business rule name

Parameters:

storeId -

eventTypeName -

name -

Returns:

grRuleVal string

getRuleValueAsInteger

public static java.lang.Integer getRuleValueAsInteger(java.lang.Integer storeId,
                                                      java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a String given storeId and the business rule name

Parameters:

storeId -

name -

Returns:

grRuleVal string

getRuleValueAsLong

public static java.lang.Long getRuleValueAsLong(java.lang.Integer storeId,
                                                java.lang.String eventTypeName,
                                                java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a Long given storeId, eventTypeName, and the business rule name

Parameters:

storeId -

eventTypeName -

name -

Returns:

grRuleVal string

getRuleValueAsLong

public static java.lang.Long getRuleValueAsLong(java.lang.Integer storeId,
                                                java.lang.Integer ruleName)

public method that returns the grRuleValue value associated with a business rule as a Long given storeId and the business rule name

Parameters:

storeId -

name -

Returns:

grRuleVal string

getRuleValueAsDate

public static java.sql.Date getRuleValueAsDate(java.lang.Integer storeId,
                                               java.lang.String eventTypeName,
                                               java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a Date given storeId, eventTypeName, and the business rule name

Parameters:

storeId -

eventTypeName -

name -

Returns:

grRuleVal string

getRuleValueAsDate

public static java.sql.Date getRuleValueAsDate(java.lang.Integer storeId,
                                               java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a Date given storeId, and the business rule name

Parameters:

storeId -

name -

Returns:

grRuleVal string

getRuleValueAsBoolean

public static boolean getRuleValueAsBoolean(java.lang.Integer storeId,
                                            java.lang.String eventTypeName,
                                            java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a boolean given storeId, eventTypeName, and the business rule name returns true if registry value = "1", else returns false.

Parameters:

storeId -

eventTypeName -

name -

Returns:

grRuleVal string

getRuleValueAsBoolean

public static boolean getRuleValueAsBoolean(java.lang.Integer storeId,
                                            java.lang.Integer ruleName)

Public method that returns the grRuleValue value associated with a business rule as a boolean given storeId, and the business rule name returns true if registry value = "1", else returns false.

Parameters:

storeId -

name -

Returns:

grRuleVal string