com.ibm.commerce.contract.beans

Class ReferralDataBean

  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, ReferralInputDataBean, ReferralSmartDataBean, com.ibm.commerce.security.Delegator, java.io.Serializable

    public class ReferralDataBean
extends ReferralDataBeanBase
implements ReferralInputDataBean, ReferralSmartDataBean
    This data bean represents a term and condition object. It refers to the terms and conditions used in trading agreements.

    Prerequisite parameters:
  • storeId: the store id

  • contractId: the contract id


    • It is used when getting the referral terms and conditions data from the database.
See Also:
Serialized Form

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values

      • POLICY_COMMAND_BATCH_AVAILABILITY

        public static final java.lang.String POLICY_COMMAND_BATCH_AVAILABILITY
        batch availability request policy command
        See Also:
        Constant Field Values

      • POLICY_COMMAND_ORDER_TRANSFER

        public static final java.lang.String POLICY_COMMAND_ORDER_TRANSFER
        order transfer request policy command
        See Also:
        Constant Field Values

      • POLICY_COMMAND_QUOTATION

        public static final java.lang.String POLICY_COMMAND_QUOTATION
        quotation request policy command
        See Also:
        Constant Field Values

      • POLICY_COMMAND_SHOPCART_TRANSFER

        public static final java.lang.String POLICY_COMMAND_SHOPCART_TRANSFER
        shopcart transfer request policy command
        See Also:
        Constant Field Values

      • POLICY_PARAMETER_AUTHENTICATION

        public static final java.lang.String POLICY_PARAMETER_AUTHENTICATION
        a string that indicates whether userid and password are required
        See Also:
        Constant Field Values

      • POLICY_PARAMETER_BACKORDERS

        public static final java.lang.String POLICY_PARAMETER_BACKORDERS
        are orders with items not in inventory allowed
        See Also:
        Constant Field Values

      • POLICY_PARAMETER_ENABLED

        public static final java.lang.String POLICY_PARAMETER_ENABLED
        a string that indicates whether this request is supported
        See Also:
        Constant Field Values

      • POLICY_PARAMETER_IDENTITY

        public static final java.lang.String POLICY_PARAMETER_IDENTITY
        the unique identifier
        See Also:
        Constant Field Values

      • POLICY_PARAMETER_TIMEOUT

        public static final java.lang.String POLICY_PARAMETER_TIMEOUT
        the maximum time to wait for the request to return
        See Also:
        Constant Field Values

      • POLICY_PARAMETER_UOMSTANDARD

        public static final java.lang.String POLICY_PARAMETER_UOMSTANDARD
        the UOM standard supported
        See Also:
        Constant Field Values

    • Constructor Detail

      • ReferralDataBean

        public ReferralDataBean()

    • Method Detail

      • getBackOrders

        public boolean getBackOrders()
        Returns whether orders with items which are not in inventory are allowed.
        Specified by:
        getBackOrders in interface ReferralSmartDataBean
        Returns:
        boolean true if orders with items not in inventory are allowed; false otherwise.

      • getBatchAvailabilityRequestAuthenticationRequired

        public boolean getBatchAvailabilityRequestAuthenticationRequired()
        Returns whether userid and password are required for batch availability requests.
        Specified by:
        getBatchAvailabilityRequestAuthenticationRequired in interface ReferralSmartDataBean
        Returns:
        boolean true if userid and password are required for batch availability requests; false otherwise.

      • getBatchAvailabilityRequestEnabled

        public boolean getBatchAvailabilityRequestEnabled()
        Returns whether the batch availability request is available in this store.
        Specified by:
        getBatchAvailabilityRequestEnabled in interface ReferralSmartDataBean
        Returns:
        boolean true if the batch availability request is available in this store; false otherwise.

      • getBatchAvailabilityRequestTimeout

        public int getBatchAvailabilityRequestTimeout()
        Returns the maximum amount of time to wait for a response to a batch availability request.
        Specified by:
        getBatchAvailabilityRequestTimeout in interface ReferralSmartDataBean
        Returns:
        int Time value in seconds

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Gets the command context set within this bean.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        The command context set within this bean.

      • getIdentifier

        public java.lang.String getIdentifier()
        Gets the store interface ID.
        Specified by:
        getIdentifier in interface ReferralSmartDataBean
        Returns:
        The store interface ID.

      • getOrderRequestAuthenticationRequired

        public boolean getOrderRequestAuthenticationRequired()
        Returns whether userid and password are required for order transfer requests.
        Specified by:
        getOrderRequestAuthenticationRequired in interface ReferralSmartDataBean
        Returns:
        boolean true if userid and password are required for order transfer requests; false otherwise.

      • getOrderRequestEnabled

        public boolean getOrderRequestEnabled()
        Returns whether the order transfer request is available in this store.
        Specified by:
        getOrderRequestEnabled in interface ReferralSmartDataBean
        Returns:
        boolean true if the order transfer request is available in this store; false otherwise.

      • getOrderRequestTimeout

        public int getOrderRequestTimeout()
        Returns the maximum amount of time to wait for a response to an order transfer request.
        Specified by:
        getOrderRequestTimeout in interface ReferralSmartDataBean
        Returns:
        int Time value in seconds

      • getQuoteRequestAuthenticationRequired

        public boolean getQuoteRequestAuthenticationRequired()
        Returns whether userid and password are required for quotation requests.
        Specified by:
        getQuoteRequestAuthenticationRequired in interface ReferralSmartDataBean
        Returns:
        boolean true if userid and password are required for quotation requests; false otherwise.

      • getQuoteRequestEnabled

        public boolean getQuoteRequestEnabled()
        Returns whether the quotation request is available in this store.
        Specified by:
        getQuoteRequestEnabled in interface ReferralSmartDataBean
        Returns:
        boolean true if the quotation request is available in this store; false otherwise.

      • getQuoteRequestTimeout

        public int getQuoteRequestTimeout()
        Returns the maximum amount of time to wait for a response to a quotation request.
        Specified by:
        getQuoteRequestTimeout in interface ReferralSmartDataBean
        Returns:
        int Time value in seconds.

      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Gets the request property set within this bean.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        The request property set within this bean.

      • getRequestTimeout

        public int getRequestTimeout()
        Returns the maximum amount of time to wait for a response to a request.
        Specified by:
        getRequestTimeout in interface ReferralSmartDataBean
        Returns:
        int Time value in seconds.

      • getShopcartRequestAuthenticationRequired

        public boolean getShopcartRequestAuthenticationRequired()
        Returns whether userid and password are required for shopcart transfer requests.
        Specified by:
        getShopcartRequestAuthenticationRequired in interface ReferralSmartDataBean
        Returns:
        boolean, true if userid and password are required for shopcart transfer requests; false otherwise.

      • getShopcartRequestEnabled

        public boolean getShopcartRequestEnabled()
        Returns whether the shopcart transfer request is available in this store.
        Specified by:
        getShopcartRequestEnabled in interface ReferralSmartDataBean
        Returns:
        boolean true if the shopcart transfer request is available in this store; false otherwise.

      • getShopcartRequestTimeout

        public int getShopcartRequestTimeout()
        Returns the maximum amount of time to wait for a response to a shopcart transfer request.
        Specified by:
        getShopcartRequestTimeout in interface ReferralSmartDataBean
        Returns:
        int Time value in seconds

      • getUomStandard

        public java.lang.String getUomStandard()
        Returns the UOM standard.
        Specified by:
        getUomStandard in interface ReferralSmartDataBean
        Returns:
        The UOM standard.

      • populate

        public void populate()
              throws java.lang.Exception
        Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception - The java.lang.Exception exception.

      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
        Sets the command context within this bean.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        aCommandContext - The command context set within this bean.

      • setDataBeanKeyContractId

        public void setDataBeanKeyContractId(java.lang.Long aContractId)
        Sets the contract in which to find the ReferralInterfaceTC information.
        Specified by:
        setDataBeanKeyContractId in interface ReferralInputDataBean
        Parameters:
        aContractId - The contract ID.

      • setDataBeanKeyStoreId

        public void setDataBeanKeyStoreId(java.lang.Integer aStoreId)
        Set the store in which to find the ReferralInterfaceTC information.
        Specified by:
        setDataBeanKeyStoreId in interface ReferralInputDataBean
        Parameters:
        aStoreId - The store ID.

      • setDataBeanKeyStoreId

        public void setDataBeanKeyStoreId(java.lang.String aStoreId)
        Set the store in which to find the ReferralInterfaceTC information.
        Specified by:
        setDataBeanKeyStoreId in interface ReferralInputDataBean
        Parameters:
        aStoreId - The store ID.

      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
        Sets the request property within this bean.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        aRequestProperty - The request property set within this bean.