com.ibm.commerce.payments.plugin

Interface PluginContext

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    PluginContextImpl


    public interface PluginContext
    extends java.io.Serializable

    This interface is the request context used in financial transactions and queries.

    See Also:
    Plugin., QueryablePlugin.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Method Detail

      • getConfiguration

        PluginConfiguration getConfiguration()

        This method gets the plug-in configuration.

        Returns:
        The plug-in configuration.
      • getLocale

        java.util.Locale getLocale()

        This method gets the locale to be used in the financial transaction or query.

        Returns:
        The locale to be used in the financial transaction or query .
      • toString

        java.lang.String toString()

        This method obtains a human-readable representation of the PluginContext.

        Overrides:
        toString in class java.lang.Object
        Returns:
        A human-readable representation of the PluginContext.
      • getPaymentConfigurationGroupId

        java.lang.String getPaymentConfigurationGroupId()

        This method gets the PaymentConfigurationGroupId to be used in the financial transaction or query.

        Returns:
        PaymentConfigurationGroupId.
      • getOrderChannelId

        java.lang.String getOrderChannelId()

        This method gets the channel identifier of the order.

        Returns:
        The channel identifier for the order.