com.ibm.commerce.subscription.facade

Class SubscriptionFacadeConstants

  • java.lang.Object
    • com.ibm.commerce.subscription.facade.SubscriptionFacadeConstants


  • public class SubscriptionFacadeConstants
    extends java.lang.Object
    This class defines the constants used to interact with the Subscription service.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ACCESS_PROFILE_ALL_INFORMATION
      This constants represents an access profile that returns all information about the noun being returned.
      static java.lang.String ACCESS_PROFILE_DEFAULT
      This constants if the default access profile when one is not specified.
      static java.lang.String ACCESS_PROFILE_DETAILS_INFORMATION
      This constants represents an access profile that returns detail information about the noun.
      static java.lang.String ACCESS_PROFILE_ID_RESOLVE
      Access profile for resolving a noun's ID
      static java.lang.String ACCESS_PROFILE_SUMMARY_INFORMATION
      This constants represents an access profile that returns summary information about the noun being returned.
      static java.lang.String ACCESS_PROFILE_UPDATE
      Access profile for updating a noun
      static java.lang.String CLOSE_XPATH
      The constant for closing XPath with a bracket.
      static java.lang.String COMPONENT_NAME
      The name for the Subscription service module.
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
      static java.lang.String DATE_FORMAT
      Constant for the date time format used in the Subscription noun.
      static java.lang.String DOUBLE_CLOSE_XPATH
      The constant for closing XPath with two brackets.
      static java.lang.String EC_AMOUNT_TO_CHARGE
      Constant for the URL parameter name which denotes the amount to charge for each fulfillment cycle of the Subscription entity.
      static java.lang.String EC_CATALOG_ENTRY_ID
      Constant representing the catalog entry ID of the subscription item.
      static java.lang.String EC_CURRENCY
      Constant for the URL parameter name which denotes the currency with which the Subscription entity was purchased.
      static java.lang.String EC_DESCRIPTION
      Constant for the URL parameter which denotes the description of the Subscription entity.
      static java.lang.String EC_END_DATE
      Constant for the URL parameter which denotes the end date for the Subscription entity.
      static java.lang.String EC_FULFILLMENT_FREQUENCY
      Constant for the URL parameter name which denotes the fulfillment frequency of the Subscription entity.
      static java.lang.String EC_FULFILLMENT_FREQUENCY_UOM
      Constant representing the unit of measure for the fulfillment frequency.
      static java.lang.String EC_FULFILLMENT_SCHEDULE
      Constant representing the fulfillment schedule input map parameter.
      static java.lang.String EC_ITEM_QUANTITY
      Constant representing the quantity of the subscription item.
      static java.lang.String EC_NEXT_FULFILLMENT_DATE
      Constant representing the next fulfillment date.
      static java.lang.String EC_NUM_OF_FULFILLMENTS
      Constant for the URL parameter which denotes the number of fulfillments.
      static java.lang.String EC_ORDER_ID
      Constant for the order ID URL parameter name.
      static java.lang.String EC_ORDER_ITEM_ID
      Constant representing the order item ID parameter name.
      static java.lang.String EC_PAYMENT_FREQUENCY
      Constant for the URL parameter name which denotes the payment frequency for the Subscription entity.
      static java.lang.String EC_PAYMENT_FREQUENCY_UOM
      Constant representing the unit of measure for the payment frequency.
      static java.lang.String EC_PAYMENT_SCHEDULE
      Constant representing the payment schedule input map parameter.
      static java.lang.String EC_START_DATE
      Constant for the URL parameter which denotes the start date for the Subscription entity.
      static java.lang.String EC_STATE
      Constant for the URL parameter which denotes the state of the Subscription entity.
      static java.lang.String EC_STORE_ID
      Constant for the URL parameter which denotes the store identifier.
      static java.lang.String EC_SUBSCRIPTION_ID
      Constant for the subscription ID.
      static java.lang.String EC_SUBSCRIPTION_ITEMS_LIST
      Constant to indicate the parameter name which holds the list of subscription items to be created.
      static java.lang.String EC_SUBSCRIPTION_TYPE
      Constant which denotes the subscription type of the Subscription entity.
      static java.lang.String EC_SUSPEND_START_DATE
      Constant representing the the suspend start date.
      static java.lang.String EC_TIME_PERIOD
      Constant for the URL parameter name which denotes the time period of the Subscription entity.
      static java.lang.String EC_TIME_PERIOD_UOM
      Constant representing the unit of measure of the time period.
      static java.lang.String EC_TOTAL_COST
      Constant for the URL parameter name which denotes the total cost for the Subscription entity.
      static java.lang.String MAXIMUM_DATE
      Constant for the maximum date supported in the component.
      static java.lang.String NOUN_ATTRIBUTE_NAME_SUBSCRIPTION_UID
      The attribute name of a unique ID in a noun Subscription.
      static java.lang.String PROCESS_VERB_ACTION_ACTIVATE_SUBSCRIPTION
      Constant for the Process Activate action on Subscription.
      static java.lang.String PROCESS_VERB_ACTION_CANCEL_SUBSCRIPTION
      Constant for the Process Cancel action on Subscription
      static java.lang.String PROCESS_VERB_ACTION_CREATE_SUBSCRIPTION
      Constant for the Process Create action on Subscription
      static java.lang.String PROCESS_VERB_ACTION_DELETE_SUBSCRIPTION
      Constant for the Process Delete action on Subscription
      static java.lang.String SUBSCRIPTION_ACTION_EXPRESSION
      The action expression for Process Subscription.
      static java.lang.String SUBSCRIPTION_STATE_ACTIVE
      Constant to represent the active state of the subscription.
      static java.lang.String SUBSCRIPTION_STATE_CANCELLED
      Constant to represent the cancelled state of the subscription.
      static java.lang.String SUBSCRIPTION_STATE_EXPIRED
      Constant to represent the expired state of the subscription.
      static java.lang.String SUBSCRIPTION_STATE_INACTIVE
      Constant to represent the inactive state of the subscription.
      static java.lang.String SUBSCRIPTION_STATE_PENDING_CANCEL
      Constant to represent the pending cancel state of the subscription.
      static java.lang.String SUBSCRIPTION_TYPE_ALL
      The subscription type code for all subscriptions.
      static java.lang.String SUBSCRIPTION_TYPE_RECURRING_ORDER
      The subscription type code for the recurring order.
      static java.lang.String SUBSCRIPTION_TYPE_TIME_BASED_SUBSCRIPTION
      Constant to indicate the time based subscription type code.
      static java.lang.String XPATH_SUBSCRIPTION
      The XPath selection of Subscription with Name.
      static java.lang.String XPATH_SUBSCRIPTION_UID
      The XPath selection of Subscription with by unique ID.
    • Method Summary

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
      • COMPONENT_NAME

        public static final java.lang.String COMPONENT_NAME
        The name for the Subscription service module.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_DETAILS_INFORMATION

        public static final java.lang.String ACCESS_PROFILE_DETAILS_INFORMATION
        This constants represents an access profile that returns detail information about the noun. Generally this includes summary information plus the common information associated with the specified noun.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_SUMMARY_INFORMATION

        public static final java.lang.String ACCESS_PROFILE_SUMMARY_INFORMATION
        This constants represents an access profile that returns summary information about the noun being returned. This includes enough information to display a list of nouns and does not include much detail about that noun.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_ALL_INFORMATION

        public static final java.lang.String ACCESS_PROFILE_ALL_INFORMATION
        This constants represents an access profile that returns all information about the noun being returned. Generally this includes detail information plus any additional information about the noun.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_DEFAULT

        public static final java.lang.String ACCESS_PROFILE_DEFAULT
        This constants if the default access profile when one is not specified. The default access profile is the summary access profile.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_UPDATE

        public static final java.lang.String ACCESS_PROFILE_UPDATE
        Access profile for updating a noun
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_ID_RESOLVE

        public static final java.lang.String ACCESS_PROFILE_ID_RESOLVE
        Access profile for resolving a noun's ID
        See Also:
        Constant Field Values
      • CLOSE_XPATH

        public static final java.lang.String CLOSE_XPATH
        The constant for closing XPath with a bracket.
        See Also:
        Constant Field Values
      • DOUBLE_CLOSE_XPATH

        public static final java.lang.String DOUBLE_CLOSE_XPATH
        The constant for closing XPath with two brackets.
        See Also:
        Constant Field Values
      • NOUN_ATTRIBUTE_NAME_SUBSCRIPTION_UID

        public static final java.lang.String NOUN_ATTRIBUTE_NAME_SUBSCRIPTION_UID
        The attribute name of a unique ID in a noun Subscription.
        See Also:
        Constant Field Values
      • XPATH_SUBSCRIPTION_UID

        public static final java.lang.String XPATH_SUBSCRIPTION_UID
        The XPath selection of Subscription with by unique ID.
        See Also:
        Constant Field Values
      • XPATH_SUBSCRIPTION

        public static final java.lang.String XPATH_SUBSCRIPTION
        The XPath selection of Subscription with Name.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_ACTION_EXPRESSION

        public static final java.lang.String SUBSCRIPTION_ACTION_EXPRESSION
        The action expression for Process Subscription.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CREATE_SUBSCRIPTION

        public static final java.lang.String PROCESS_VERB_ACTION_CREATE_SUBSCRIPTION
        Constant for the Process Create action on Subscription
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_DELETE_SUBSCRIPTION

        public static final java.lang.String PROCESS_VERB_ACTION_DELETE_SUBSCRIPTION
        Constant for the Process Delete action on Subscription
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_ACTIVATE_SUBSCRIPTION

        public static final java.lang.String PROCESS_VERB_ACTION_ACTIVATE_SUBSCRIPTION
        Constant for the Process Activate action on Subscription.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CANCEL_SUBSCRIPTION

        public static final java.lang.String PROCESS_VERB_ACTION_CANCEL_SUBSCRIPTION
        Constant for the Process Cancel action on Subscription
        See Also:
        Constant Field Values
      • EC_SUBSCRIPTION_ID

        public static final java.lang.String EC_SUBSCRIPTION_ID
        Constant for the subscription ID. This corresponds to the UniqueID of the SubscriptionType
        See Also:
        Constant Field Values
      • EC_ORDER_ID

        public static final java.lang.String EC_ORDER_ID
        Constant for the order ID URL parameter name.
        See Also:
        Constant Field Values
      • EC_FULFILLMENT_FREQUENCY

        public static final java.lang.String EC_FULFILLMENT_FREQUENCY
        Constant for the URL parameter name which denotes the fulfillment frequency of the Subscription entity.
        See Also:
        Constant Field Values
      • EC_AMOUNT_TO_CHARGE

        public static final java.lang.String EC_AMOUNT_TO_CHARGE
        Constant for the URL parameter name which denotes the amount to charge for each fulfillment cycle of the Subscription entity.
        See Also:
        Constant Field Values
      • EC_TOTAL_COST

        public static final java.lang.String EC_TOTAL_COST
        Constant for the URL parameter name which denotes the total cost for the Subscription entity.
        See Also:
        Constant Field Values
      • EC_CURRENCY

        public static final java.lang.String EC_CURRENCY
        Constant for the URL parameter name which denotes the currency with which the Subscription entity was purchased.
        See Also:
        Constant Field Values
      • EC_PAYMENT_FREQUENCY

        public static final java.lang.String EC_PAYMENT_FREQUENCY
        Constant for the URL parameter name which denotes the payment frequency for the Subscription entity.
        See Also:
        Constant Field Values
      • EC_TIME_PERIOD

        public static final java.lang.String EC_TIME_PERIOD
        Constant for the URL parameter name which denotes the time period of the Subscription entity.
        See Also:
        Constant Field Values
      • EC_START_DATE

        public static final java.lang.String EC_START_DATE
        Constant for the URL parameter which denotes the start date for the Subscription entity.
        See Also:
        Constant Field Values
      • EC_END_DATE

        public static final java.lang.String EC_END_DATE
        Constant for the URL parameter which denotes the end date for the Subscription entity.
        See Also:
        Constant Field Values
      • EC_SUBSCRIPTION_TYPE

        public static final java.lang.String EC_SUBSCRIPTION_TYPE
        Constant which denotes the subscription type of the Subscription entity.
        See Also:
        Constant Field Values
      • EC_DESCRIPTION

        public static final java.lang.String EC_DESCRIPTION
        Constant for the URL parameter which denotes the description of the Subscription entity.
        See Also:
        Constant Field Values
      • EC_STATE

        public static final java.lang.String EC_STATE
        Constant for the URL parameter which denotes the state of the Subscription entity.
        See Also:
        Constant Field Values
      • DATE_FORMAT

        public static final java.lang.String DATE_FORMAT
        Constant for the date time format used in the Subscription noun.
        See Also:
        Constant Field Values
      • MAXIMUM_DATE

        public static final java.lang.String MAXIMUM_DATE
        Constant for the maximum date supported in the component.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_TYPE_RECURRING_ORDER

        public static final java.lang.String SUBSCRIPTION_TYPE_RECURRING_ORDER
        The subscription type code for the recurring order.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_TYPE_TIME_BASED_SUBSCRIPTION

        public static final java.lang.String SUBSCRIPTION_TYPE_TIME_BASED_SUBSCRIPTION
        Constant to indicate the time based subscription type code.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_STATE_ACTIVE

        public static final java.lang.String SUBSCRIPTION_STATE_ACTIVE
        Constant to represent the active state of the subscription.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_STATE_INACTIVE

        public static final java.lang.String SUBSCRIPTION_STATE_INACTIVE
        Constant to represent the inactive state of the subscription.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_STATE_CANCELLED

        public static final java.lang.String SUBSCRIPTION_STATE_CANCELLED
        Constant to represent the cancelled state of the subscription.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_STATE_PENDING_CANCEL

        public static final java.lang.String SUBSCRIPTION_STATE_PENDING_CANCEL
        Constant to represent the pending cancel state of the subscription.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_STATE_EXPIRED

        public static final java.lang.String SUBSCRIPTION_STATE_EXPIRED
        Constant to represent the expired state of the subscription.
        See Also:
        Constant Field Values
      • SUBSCRIPTION_TYPE_ALL

        public static final java.lang.String SUBSCRIPTION_TYPE_ALL
        The subscription type code for all subscriptions.
        See Also:
        Constant Field Values
      • EC_STORE_ID

        public static final java.lang.String EC_STORE_ID
        Constant for the URL parameter which denotes the store identifier.
        See Also:
        Constant Field Values
      • EC_NUM_OF_FULFILLMENTS

        public static final java.lang.String EC_NUM_OF_FULFILLMENTS
        Constant for the URL parameter which denotes the number of fulfillments.
        See Also:
        Constant Field Values
      • EC_SUBSCRIPTION_ITEMS_LIST

        public static final java.lang.String EC_SUBSCRIPTION_ITEMS_LIST
        Constant to indicate the parameter name which holds the list of subscription items to be created.
        See Also:
        Constant Field Values
      • EC_ORDER_ITEM_ID

        public static final java.lang.String EC_ORDER_ITEM_ID
        Constant representing the order item ID parameter name.
        See Also:
        Constant Field Values
      • EC_CATALOG_ENTRY_ID

        public static final java.lang.String EC_CATALOG_ENTRY_ID
        Constant representing the catalog entry ID of the subscription item.
        See Also:
        Constant Field Values
      • EC_ITEM_QUANTITY

        public static final java.lang.String EC_ITEM_QUANTITY
        Constant representing the quantity of the subscription item.
        See Also:
        Constant Field Values
      • EC_FULFILLMENT_SCHEDULE

        public static final java.lang.String EC_FULFILLMENT_SCHEDULE
        Constant representing the fulfillment schedule input map parameter.
        See Also:
        Constant Field Values
      • EC_PAYMENT_SCHEDULE

        public static final java.lang.String EC_PAYMENT_SCHEDULE
        Constant representing the payment schedule input map parameter.
        See Also:
        Constant Field Values
      • EC_PAYMENT_FREQUENCY_UOM

        public static final java.lang.String EC_PAYMENT_FREQUENCY_UOM
        Constant representing the unit of measure for the payment frequency.
        See Also:
        Constant Field Values
      • EC_FULFILLMENT_FREQUENCY_UOM

        public static final java.lang.String EC_FULFILLMENT_FREQUENCY_UOM
        Constant representing the unit of measure for the fulfillment frequency.
        See Also:
        Constant Field Values
      • EC_TIME_PERIOD_UOM

        public static final java.lang.String EC_TIME_PERIOD_UOM
        Constant representing the unit of measure of the time period.
        See Also:
        Constant Field Values
      • EC_SUSPEND_START_DATE

        public static final java.lang.String EC_SUSPEND_START_DATE
        Constant representing the the suspend start date.
        See Also:
        Constant Field Values
      • EC_NEXT_FULFILLMENT_DATE

        public static final java.lang.String EC_NEXT_FULFILLMENT_DATE
        Constant representing the next fulfillment date.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SubscriptionFacadeConstants

        public SubscriptionFacadeConstants()