com.ibm.commerce.member.dataobjects

Class DOBase

  • java.lang.Object
    • com.ibm.commerce.member.dataobjects.DOBase
  • Direct Known Subclasses:
    AddressDO, BusinessProfileDO, MemberAttributesDO, OrgEntityDO, UserDemographicsDO, UserDO, UserProfileDO, UserRegistryDO

    public abstract class DOBase
extends java.lang.Object
    The abstract base class for the sync helper data object classes. The synchronization beans, for example, UserSyncBean, delegate to multiple sync helper classes. An individual sync helper class is used to read and write a row to a particular database table, for example UserDO is used to read and write from the USERS table. The name of the properties used by the sync helper classes are defined in the concrete data object classes. The names are the same as the property names used in the user and organization registration commands.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The IBM Copyright notice field.

    • Constructor Summary

      Constructors 
      Constructor and Description
      DOBase()
      Constructor
      DOBase(java.lang.String memberId, short shMemberType)
      Constructor

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.persistence.AbstractJpaEntityAccessBean getAccessBean()
      Gets the access bean instance.
      abstract java.lang.String getDOName()
      Gets the synchronization helper name.
      java.lang.String getMemberId()
      Get the memberId.
      short getMemberType()
      Gets the member type.
      abstract TypedProperty read()
      Abstract method to read the data object from the database, and return the result as a typed property.
      void setAccessBean(com.ibm.commerce.persistence.AbstractJpaEntityAccessBean abBean)
      Gets the access bean instance.
      void setMemberId(java.lang.String strMemberId)
      Set the memberId value
      void setMemberType(short shMemberType)
      Sets the member type.
      abstract void write(TypedProperty tpProperties)
      Abstract method to persist the properties to the database.

      • 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
        The IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DOBase

        public DOBase()
        Constructor

      • DOBase

        public DOBase(java.lang.String memberId,
              short shMemberType)
        Constructor
        Parameters:
        memberId - String
        shMemberType - short

    • Method Detail

      • getDOName

        public abstract java.lang.String getDOName()
        Gets the synchronization helper name.
        Returns:
        The synchronization helper name.

      • write

        public abstract void write(TypedProperty tpProperties)
                    throws javax.persistence.NoResultException,
                           ECException
        Abstract method to persist the properties to the database.
        Parameters:
        tpProperties - the properties to persist to the database.
        Throws:
        javax.persistence.NoResultException
        ECException

      • read

        public abstract TypedProperty read()
                            throws javax.persistence.NoResultException,
                                   ECException
        Abstract method to read the data object from the database, and return the result as a typed property.
        Returns:
        the properties.
        Throws:
        javax.persistence.NoResultException
        ECException

      • setAccessBean

        public void setAccessBean(com.ibm.commerce.persistence.AbstractJpaEntityAccessBean abBean)
        Gets the access bean instance.
        Parameters:
        abBean - the access bean instance.

      • getAccessBean

        public com.ibm.commerce.persistence.AbstractJpaEntityAccessBean getAccessBean()
        Gets the access bean instance.
        Returns:
        the cached access bean object

      • setMemberId

        public void setMemberId(java.lang.String strMemberId)
        Set the memberId value
        Parameters:
        strMemberId - String

      • getMemberId

        public java.lang.String getMemberId()
        Get the memberId.
        Returns:
        the string of member id

      • setMemberType

        public void setMemberType(short shMemberType)
        Sets the member type.
        Parameters:
        shMemberType - The member type.

      • getMemberType

        public short getMemberType()
        Gets the member type.
        Returns:
        the member type.
Skip navigation links