com.ibm.commerce.subscription.facade.server.config

Interface SubscriptionComponentConfigurationType

All Known Implementing Classes:

SubscriptionComponentConfigurationTypeImpl

public interface SubscriptionComponentConfigurationType

This interface defines the component configuration for subscription.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SubscriptionComponentConfigurationType.NoticePeriodType This interface is used to define the notice period for the subscription action.
static interface	SubscriptionComponentConfigurationType.ScheduledActionConfigurationType This interface is used to define the scheduled action configuration for the subscription scheduled action.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME_FULFILLMENT_FREQUENCY_ATTRIBUTE Constant to indicate the fulfillment frequency attribute name in the catalog entry configuration.
static java.lang.String	ATTRIBUTE_NAME_PAYMENT_FREQUENCY_ATTRIBUTE Constant to indicate the payment frequency attribute name in the catalog entry configuration.
static java.lang.String	ATTRIBUTE_NAME_RECALCULATE_CHILD_ORDER_FOR_RECURRING_ORDER Constant to indicate the recalculate child order for recurring order attribute name.
static java.lang.String	ATTRIBUTE_NAME_TIME_PERIOD_ATTRIBUTE Constant to indicate the time period attribute name in the catalog entry configuration.
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	ELEMENT_NAME_NOTICE_PERIOD_CONFIGURATION Constant to indicate the notice period configuration group element name in the configuration.
static java.lang.String	ELEMENT_NAME_SCHEDULED_ACTION_RETRY_CONFIGURATION Constant to indicate the scheduled action retry configuration group element name in the configuration.
static java.lang.String	ELEMENT_NAME_SCHEDULER_LOOKUP_INTERVAL Constant to indicate the scheduler look up interval element name in the configuration.
static java.lang.String	ELEMENT_NAME_SUBSCRIPTION_CATALOG_ENTRY_CONFIGURATION Constant to indicate the element name of the catalog entry configuration parameters.
static java.lang.String	ELEMENT_NAME_SUBSCRIPTION_CHILD_ORDER_CONFIGURATION Constant to indicate the element name of the child order configuration parameters.
static java.lang.String	ELEMENT_NAME_SUBSCRIPTION_COMPONENT_CONFIGURATION Constant to indicate the SubscriptionComponentConfiguration element name.
static java.lang.String	SUBSCRIPTION_CONFIGURATION_NAMESPACE_PREFIX Constant to indicate the name space prefix used in the configuration.

Method Summary

Modifier and Type	Method and Description
java.util.List<SubscriptionComponentConfigurationType.NoticePeriodType>	getAllNoticePeriods() This method returns all the notice period configurations in this instance of the configuration.
java.util.List<SubscriptionComponentConfigurationType.ScheduledActionConfigurationType>	getAllScheduledActionConfigurations() This method returns all the scheduled configurations in this instance of the configuration.
java.lang.String	getFulfillmentFrequencyAttributeName() This method returns the name of the attribute name which is used for fulfillment frequency in the catalog entry.
java.lang.Integer	getMaximumRetriesForScheduledAction(java.lang.String scheduledActionName) This method returns the maximum retries for a scheduled action.
SubscriptionComponentConfigurationType.NoticePeriodType	getNoticePeriodForAction(java.lang.String actionName) This method returns the notice period for the action specified.
java.lang.String	getPaymentFrequencyAttributeName() This method returns the name of the attribute name which is used for payment frequency in the catalog entry.
SubscriptionComponentConfigurationType.ScheduledActionConfigurationType	getScheduledActionConfigurationForScheduledAction(java.lang.String scheduledActionName) This method returns the scheduled action configuration for the scheduled action name specified.
java.lang.Long	getSchedulerLookUpInterval() This method returns the scheduler look up interval in terms of seconds.
java.lang.String	getTimePeriodAttributeName() This method returns the name of the attribute name which is used for time period in the catalog entry.
boolean	initialize(org.w3c.dom.Node node) This method initializes the configuration type instance by parsing the node.
void	mergeConfigurations(SubscriptionComponentConfigurationType toMerge, boolean overWrite) This method merges this instance of the configuration with the parameter specified.
boolean	recalculateChildOrderForRecurringOrder() This method indicates if the child order for a recurring order needs to be recalculated or not.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

ELEMENT_NAME_SUBSCRIPTION_COMPONENT_CONFIGURATION

static final java.lang.String ELEMENT_NAME_SUBSCRIPTION_COMPONENT_CONFIGURATION

Constant to indicate the SubscriptionComponentConfiguration element name.

See Also:

Constant Field Values

ELEMENT_NAME_SUBSCRIPTION_CATALOG_ENTRY_CONFIGURATION

static final java.lang.String ELEMENT_NAME_SUBSCRIPTION_CATALOG_ENTRY_CONFIGURATION

Constant to indicate the element name of the catalog entry configuration parameters.

See Also:

Constant Field Values

ELEMENT_NAME_SUBSCRIPTION_CHILD_ORDER_CONFIGURATION

static final java.lang.String ELEMENT_NAME_SUBSCRIPTION_CHILD_ORDER_CONFIGURATION

Constant to indicate the element name of the child order configuration parameters.

See Also:

Constant Field Values

ATTRIBUTE_NAME_FULFILLMENT_FREQUENCY_ATTRIBUTE

static final java.lang.String ATTRIBUTE_NAME_FULFILLMENT_FREQUENCY_ATTRIBUTE

Constant to indicate the fulfillment frequency attribute name in the catalog entry configuration.

See Also:

Constant Field Values

ATTRIBUTE_NAME_PAYMENT_FREQUENCY_ATTRIBUTE

static final java.lang.String ATTRIBUTE_NAME_PAYMENT_FREQUENCY_ATTRIBUTE

Constant to indicate the payment frequency attribute name in the catalog entry configuration.

See Also:

Constant Field Values

ATTRIBUTE_NAME_TIME_PERIOD_ATTRIBUTE

static final java.lang.String ATTRIBUTE_NAME_TIME_PERIOD_ATTRIBUTE

Constant to indicate the time period attribute name in the catalog entry configuration.

See Also:

Constant Field Values

ATTRIBUTE_NAME_RECALCULATE_CHILD_ORDER_FOR_RECURRING_ORDER

static final java.lang.String ATTRIBUTE_NAME_RECALCULATE_CHILD_ORDER_FOR_RECURRING_ORDER

Constant to indicate the recalculate child order for recurring order attribute name.

See Also:

Constant Field Values

ELEMENT_NAME_SCHEDULER_LOOKUP_INTERVAL

static final java.lang.String ELEMENT_NAME_SCHEDULER_LOOKUP_INTERVAL

Constant to indicate the scheduler look up interval element name in the configuration.

See Also:

Constant Field Values

ELEMENT_NAME_NOTICE_PERIOD_CONFIGURATION

static final java.lang.String ELEMENT_NAME_NOTICE_PERIOD_CONFIGURATION

Constant to indicate the notice period configuration group element name in the configuration.

See Also:

Constant Field Values

ELEMENT_NAME_SCHEDULED_ACTION_RETRY_CONFIGURATION

static final java.lang.String ELEMENT_NAME_SCHEDULED_ACTION_RETRY_CONFIGURATION

Constant to indicate the scheduled action retry configuration group element name in the configuration.

See Also:

Constant Field Values

SUBSCRIPTION_CONFIGURATION_NAMESPACE_PREFIX

static final java.lang.String SUBSCRIPTION_CONFIGURATION_NAMESPACE_PREFIX

Constant to indicate the name space prefix used in the configuration.

See Also:

Constant Field Values

Method Detail

getPaymentFrequencyAttributeName

java.lang.String getPaymentFrequencyAttributeName()

This method returns the name of the attribute name which is used for payment frequency in the catalog entry.

Returns:

The name of the payment frequency attribute.

getFulfillmentFrequencyAttributeName

java.lang.String getFulfillmentFrequencyAttributeName()

This method returns the name of the attribute name which is used for fulfillment frequency in the catalog entry.

Returns:

The name of the fulfillment frequency attribute.

getTimePeriodAttributeName

java.lang.String getTimePeriodAttributeName()

This method returns the name of the attribute name which is used for time period in the catalog entry.

Returns:

The name of the time period attribute.

recalculateChildOrderForRecurringOrder

boolean recalculateChildOrderForRecurringOrder()

This method indicates if the child order for a recurring order needs to be recalculated or not.

Returns:

Boolean indicating if the child order is to be recalculated.

getSchedulerLookUpInterval

java.lang.Long getSchedulerLookUpInterval()

This method returns the scheduler look up interval in terms of seconds.

Returns:

The look up interval for the scheduler in terms of seconds.

getNoticePeriodForAction

SubscriptionComponentConfigurationType.NoticePeriodType getNoticePeriodForAction(java.lang.String actionName)

This method returns the notice period for the action specified.

Parameters:

actionName - The subscription action name.

Returns:

The notice period for the subscription action.

getMaximumRetriesForScheduledAction

java.lang.Integer getMaximumRetriesForScheduledAction(java.lang.String scheduledActionName)

This method returns the maximum retries for a scheduled action.

Parameters:

scheduledActionName - The scheduled action for which the retries are to be fetched.

Returns:

The maximum number of retries.

getScheduledActionConfigurationForScheduledAction

SubscriptionComponentConfigurationType.ScheduledActionConfigurationType getScheduledActionConfigurationForScheduledAction(java.lang.String scheduledActionName)

This method returns the scheduled action configuration for the scheduled action name specified.

Parameters:

scheduledActionName - The scheduled action name.

Returns:

The scheduled action configuration for the scheduled action.

getAllNoticePeriods

java.util.List<SubscriptionComponentConfigurationType.NoticePeriodType> getAllNoticePeriods()

This method returns all the notice period configurations in this instance of the configuration.

Returns:

All the notice period configurations.

getAllScheduledActionConfigurations

java.util.List<SubscriptionComponentConfigurationType.ScheduledActionConfigurationType> getAllScheduledActionConfigurations()

This method returns all the scheduled configurations in this instance of the configuration.

Returns:

All the scheduled action configuration in this instance.

initialize

boolean initialize(org.w3c.dom.Node node)
            throws java.lang.Exception

This method initializes the configuration type instance by parsing the node.

Parameters:

node - The node which contains the SubscriptionComponentConfiguration data.

Returns:

true if the element was successfully initialized. false, otherwise.

Throws:

java.lang.Exception - when the initialization fails with an exception.

mergeConfigurations

void mergeConfigurations(SubscriptionComponentConfigurationType toMerge,
                         boolean overWrite)

This method merges this instance of the configuration with the parameter specified. The merging is performed using deep copy.

Parameters:

toMerge - The configuration to be merged with this.

overWrite - A boolean to indicate if this instance of the configuration can be overwritten by the configuration specified. Overwriting will replace this instance's configuration value with that of the incoming configuration.