com.ibm.commerce.tools.contract.beans

Class PolicyDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.contract.beans.PolicyDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable
    Direct Known Subclasses:
    PolicyByNameTypeAndStoreDataBean


    public class PolicyDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean represents a policy object. When retrieving all the data associated with a policy, the data bean will be called. Sets the policy and language identifiers in order to populate the bean. The data bean maps to a database table POLICY
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String FLAG_DEFAULT
      constants
      static java.lang.String FLAG_DONE
      constants
      static java.lang.String FLAG_ENGLISH
      constants
      static java.lang.String FLAG_STORE
      constants
      static java.lang.Integer LANGUAGE_EN_US
      default language constant
      static java.lang.String PARAMETER_LANGUAGE_ID
      constants
      static java.lang.String PARAMETER_POLICY_ID
      constants
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Constructor Summary

      Constructors 
      Constructor and Description
      PolicyDataBean() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.sql.Timestamp getEndDate()
      Gets the end date of the business policy
      java.lang.Long getId()
      Gets the identifier of the business policy
      java.lang.Integer getLanguageId()
      Gets the language identifier of the business policy
      java.lang.String getLongDescription()
      Gets the long description of the business policy
      java.lang.String getPolicyName()
      Gets the name of the business policy
      java.lang.String getPolicyType()
      Gets the type of the business policy
      java.lang.String getProperties()
      Gets the properties of the business policy
      java.lang.String getShortDescription()
      Gets the short description of the business policy
      java.sql.Timestamp getStartDate()
      Gets the start date of the business policy
      java.lang.Integer getStoreEntId()
      Gets the store identifier of the business policy
      java.lang.String getStoreIdentity()
      Gets the store identify of the business policy.
      java.lang.String getStoreMemberId()
      Gets the store member identifier of the business policy
      java.sql.Timestamp getTimeCreated()
      Gets the creation time of the business policy
      java.sql.Timestamp getTimeUpdated()
      Gets the update time of the business policy
      void populate()
      This method is used to retrieve a Business Policy in the store.
      void setEndDate(java.sql.Timestamp endDate)
      Sets the end date of the business policy
      void setId(java.lang.Long id)
      Sets the identifier of the business policy
      void setLanguageId(java.lang.Integer languageId)
      Sets the language identifier for the data of the business policy
      void setLongDescription(java.lang.String longDescription)
      Sets the long description of the business policy
      void setPolicyName(java.lang.String policyName)
      Sets the policy name of the business policy
      void setPolicyType(java.lang.String policyType)
      Sets the policy type of the business policy
      void setProperties(java.lang.String properties)
      Sets the properties of the business policy
      void setShortDescription(java.lang.String shortDescription)
      Sets the short description of the business policy
      void setStartDate(java.sql.Timestamp startDate)
      Sets the start date of the business policy
      void setStoreEntId(java.lang.Integer storeEntId)
      Sets the store entity identifier of the business policy
      void setStoreIdentity(java.lang.String storeIdentity)
      Sets the store identity of the business policy
      void setStoreMemberId(java.lang.Long id)
      Sets the store member identifier of the owner of the business policy
      void setTimeCreated(java.sql.Timestamp timeCreated)
      Sets the creation time of the business policy
      void setTimeUpdated(java.sql.Timestamp timeUpdated)
      Sets the update time of the business policy
      • 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

      • FLAG_DEFAULT

        public static final java.lang.String FLAG_DEFAULT
        constants
        See Also:
        Constant Field Values
      • FLAG_ENGLISH

        public static final java.lang.String FLAG_ENGLISH
        constants
        See Also:
        Constant Field Values
      • LANGUAGE_EN_US

        public static final java.lang.Integer LANGUAGE_EN_US
        default language constant
      • PARAMETER_LANGUAGE_ID

        public static final java.lang.String PARAMETER_LANGUAGE_ID
        constants
        See Also:
        Constant Field Values
      • PARAMETER_POLICY_ID

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

      • PolicyDataBean

        public PolicyDataBean()
    • Method Detail

      • getEndDate

        public java.sql.Timestamp getEndDate()
        Gets the end date of the business policy
        Returns:
        java.sql.Timestamp
      • getId

        public java.lang.Long getId()
        Gets the identifier of the business policy
        Returns:
        Long
      • getLanguageId

        public java.lang.Integer getLanguageId()
        Gets the language identifier of the business policy
        Returns:
        Integer
      • getLongDescription

        public java.lang.String getLongDescription()
        Gets the long description of the business policy
        Returns:
        String
      • getPolicyName

        public java.lang.String getPolicyName()
        Gets the name of the business policy
        Returns:
        String
      • getPolicyType

        public java.lang.String getPolicyType()
        Gets the type of the business policy
        Returns:
        String
      • getProperties

        public java.lang.String getProperties()
        Gets the properties of the business policy
        Returns:
        String
      • getShortDescription

        public java.lang.String getShortDescription()
        Gets the short description of the business policy
        Returns:
        String
      • getStartDate

        public java.sql.Timestamp getStartDate()
        Gets the start date of the business policy
        Returns:
        java.sql.Timestamp
      • getStoreEntId

        public java.lang.Integer getStoreEntId()
        Gets the store identifier of the business policy
        Returns:
        Integer
      • getStoreIdentity

        public java.lang.String getStoreIdentity()
        Gets the store identify of the business policy.
        Returns:
        String
      • getStoreMemberId

        public java.lang.String getStoreMemberId()
        Gets the store member identifier of the business policy
        Returns:
        String
      • getTimeCreated

        public java.sql.Timestamp getTimeCreated()
        Gets the creation time of the business policy
        Returns:
        java.sql.Timestamp
      • getTimeUpdated

        public java.sql.Timestamp getTimeUpdated()
        Gets the update time of the business policy
        Returns:
        java.sql.Timestamp
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to retrieve a Business Policy 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
      • setEndDate

        public void setEndDate(java.sql.Timestamp endDate)
        Sets the end date of the business policy
        Parameters:
        endDate - Timestamp
      • setId

        public void setId(java.lang.Long id)
        Sets the identifier of the business policy
        Parameters:
        id - Long
      • setLanguageId

        public void setLanguageId(java.lang.Integer languageId)
        Sets the language identifier for the data of the business policy
        Parameters:
        languageId - String
      • setLongDescription

        public void setLongDescription(java.lang.String longDescription)
        Sets the long description of the business policy
        Parameters:
        longDescription - String
      • setPolicyName

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

        public void setPolicyType(java.lang.String policyType)
        Sets the policy type of the business policy
        Parameters:
        policyType - String
      • setProperties

        public void setProperties(java.lang.String properties)
        Sets the properties of the business policy
        Parameters:
        properties - String
      • setShortDescription

        public void setShortDescription(java.lang.String shortDescription)
        Sets the short description of the business policy
        Parameters:
        shortDescription - String
      • setStartDate

        public void setStartDate(java.sql.Timestamp startDate)
        Sets the start date of the business policy
        Parameters:
        startDate - Timestamp
      • setStoreEntId

        public void setStoreEntId(java.lang.Integer storeEntId)
        Sets the store entity identifier of the business policy
        Parameters:
        storeEntId - Integer
      • setStoreIdentity

        public void setStoreIdentity(java.lang.String storeIdentity)
        Sets the store identity of the business policy
        Parameters:
        storeIdentity - String
      • setStoreMemberId

        public void setStoreMemberId(java.lang.Long id)
        Sets the store member identifier of the owner of the business policy
        Parameters:
        id - Long
      • setTimeCreated

        public void setTimeCreated(java.sql.Timestamp timeCreated)
        Sets the creation time of the business policy
        Parameters:
        timeCreated - Timestamp
      • setTimeUpdated

        public void setTimeUpdated(java.sql.Timestamp timeUpdated)
        Sets the update time of the business policy
        Parameters:
        timeUpdated - Timestamp