com.ibm.commerce.tools.contract.beans

Class PolicyListDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.contract.beans.PolicyListDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable


    public class PolicyListDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean is used to get a list of PolicyDataBean. When listing the business policies in a store, the data bean will be called. The store identifier is prerequisite parameter that need to be set before populate.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      PolicyDataBean[] getPolicyList()
      Gets the list of policies in the store
      void populate()
      This method is used to retrieve the Business Policies in the store.
      void setFindBy(java.lang.String findBy)
      Sets the findBy type of policy to find.
      void setOrderBy(java.lang.String orderBy)
      Sets the orderBy type of policy to find.
      void setPolicyName(java.lang.String policyName)
      Sets the name of the policy to find
      void setPolicyType(java.lang.String policyType)
      Sets the type of the policies to find
      void setStoreId(java.lang.Integer storeId)
      Sets the Store ID for which the list of usable Policies is requested.
      void setTC(java.lang.Long tc)
      Sets the term and condition identifier of the policy to find
      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties
    • Field Detail

      • FIND_BY_NAME_TYPE_STORE

        public static final java.lang.String FIND_BY_NAME_TYPE_STORE
        Find by constants
        See Also:
        Constant Field Values
      • FIND_BY_STORE_ENTITY

        public static final java.lang.String FIND_BY_STORE_ENTITY
        Find by constants
        See Also:
        Constant Field Values
      • FIND_BY_TC

        public static final java.lang.String FIND_BY_TC
        Find by constants
        See Also:
        Constant Field Values
      • FIND_BY_TC_TYPE

        public static final java.lang.String FIND_BY_TC_TYPE
        Find by constants
        See Also:
        Constant Field Values
      • FIND_BY_TYPE_STORE

        public static final java.lang.String FIND_BY_TYPE_STORE
        Find by constants
        See Also:
        Constant Field Values
      • FIND_BY_TYPE_STORE_ENTITY

        public static final java.lang.String FIND_BY_TYPE_STORE_ENTITY
        Find by constants
        See Also:
        Constant Field Values
      • ORDER_BY_NAME

        public static final java.lang.String ORDER_BY_NAME
        Order by constants
        See Also:
        Constant Field Values
      • ORDER_BY_STORE_ENTITY

        public static final java.lang.String ORDER_BY_STORE_ENTITY
        Order by constants
        See Also:
        Constant Field Values
      • ORDER_BY_TYPE

        public static final java.lang.String ORDER_BY_TYPE
        Order by constants
        See Also:
        Constant Field Values
      • PARAMETER_FIND_BY

        public static final java.lang.String PARAMETER_FIND_BY
        NVP constants
        See Also:
        Constant Field Values
      • PARAMETER_ORDER_BY

        public static final java.lang.String PARAMETER_ORDER_BY
        NVP constants
        See Also:
        Constant Field Values
      • TYPE_INVOICE_FORMAT

        public static final java.lang.String TYPE_INVOICE_FORMAT
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_PAYMENT

        public static final java.lang.String TYPE_PAYMENT
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_PRICE

        public static final java.lang.String TYPE_PRICE
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_PRODUCT_SET

        public static final java.lang.String TYPE_PRODUCT_SET
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_RETURN_APPROVAL

        public static final java.lang.String TYPE_RETURN_APPROVAL
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_RETURN_CHARGE

        public static final java.lang.String TYPE_RETURN_CHARGE
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_RETURN_PAYMENT

        public static final java.lang.String TYPE_RETURN_PAYMENT
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_SHIPPING_CHARGE

        public static final java.lang.String TYPE_SHIPPING_CHARGE
        Policy type constants
        See Also:
        Constant Field Values
      • TYPE_SHIPPING_MODE

        public static final java.lang.String TYPE_SHIPPING_MODE
        Policy type constants
        See Also:
        Constant Field Values
    • Constructor Detail

      • PolicyListDataBean

        public PolicyListDataBean()
    • Method Detail

      • getPolicyList

        public PolicyDataBean[] getPolicyList()
        Gets the list of policies in the store
        Returns:
        PolicyDataBean[]
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to retrieve the Business Policies in the store. Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception
      • setFindBy

        public void setFindBy(java.lang.String findBy)
        Sets the findBy type of policy to find. This can either be set explicitly using this setter, or read from the request properties
        Parameters:
        findBy - String
      • setOrderBy

        public void setOrderBy(java.lang.String orderBy)
        Sets the orderBy type of policy to find. This can either be set explicitly using this setter, or read from the request properties
        Parameters:
        orderBy - String
      • setPolicyName

        public void setPolicyName(java.lang.String policyName)
        Sets the name of the policy to find
        Parameters:
        policyName - String
      • setPolicyType

        public void setPolicyType(java.lang.String policyType)
        Sets the type of the policies to find
        Parameters:
        policyType - String
      • setStoreId

        public void setStoreId(java.lang.Integer storeId)
        Sets the Store ID for which the list of usable Policies is requested.
        Parameters:
        storeId - the Store ID.
      • setTC

        public void setTC(java.lang.Long tc)
        Sets the term and condition identifier of the policy to find
        Parameters:
        tc - Long