com.ibm.commerce.messaging.outboundservice

Class RecipientInfo

  • java.lang.Object
    • com.ibm.commerce.messaging.outboundservice.RecipientInfo
  • All Implemented Interfaces:
    java.io.Serializable


    public class RecipientInfo
    extends java.lang.Object
    implements java.io.Serializable
    A recipient information object that represents the recipient of a message.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      RecipientInfo()
      Default RecipientInfo constructor that calls its parents constructor.
      RecipientInfo(java.lang.Object a_recipientID, int a_recipientType)
      Constructs the RecipientInfo object with a recipient ID and recipient type.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Object getRecipientId()
      This method returns the recipient ID.
      int getRecipientType()
      This method returns the recipient type.
      boolean isMember()
      This method determines whether the recipient type is a member (not an organization or store).
      boolean isOrganization()
      This method determines whether the recipient type is an organization (not a member or store).
      boolean isSecureMember()
      This method determines whether the recipient is a member with non-public address information or not.
      boolean isSecureOrganization()
      This method determines whether the recipient is an organization with non-public address information or not.
      boolean isSecureStore()
      Determines whether the recipient is a store with non-public address information or not.
      boolean isStore()
      Determines whether the recipient type is a store(not a member or organization).
      void setRecipientId(java.lang.Object newRecipientId)
      This method sets the recipient ID.
      void setRecipientType(int newRecipientType)
      This method sets the recipient type.
      java.lang.String toString()
      This method returns a String that represents the value of this object.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • RecipientInfo

        public RecipientInfo()
        Default RecipientInfo constructor that calls its parents constructor.
      • RecipientInfo

        public RecipientInfo(java.lang.Object a_recipientID,
                             int a_recipientType)
        Constructs the RecipientInfo object with a recipient ID and recipient type.
        Parameters:
        a_recipientID - java.lang.Object The recipient Id.
        a_recipientType - int The recipient type.
    • Method Detail

      • getRecipientId

        public java.lang.Object getRecipientId()
        This method returns the recipient ID.
        Returns:
        The recipient ID.
      • getRecipientType

        public int getRecipientType()
        This method returns the recipient type.
        Returns:
        The recipient type.
      • isMember

        public boolean isMember()
        This method determines whether the recipient type is a member (not an organization or store).
        Returns:
        true if the recipient type is a member, otherwise false.
      • isOrganization

        public boolean isOrganization()
        This method determines whether the recipient type is an organization (not a member or store).
        Returns:
        true if the recipient type is an organization, otherwise false.
      • isSecureMember

        public boolean isSecureMember()
        This method determines whether the recipient is a member with non-public address information or not.
        Returns:
        true if the recipient type is a secure member, otherwise false.
      • isSecureOrganization

        public boolean isSecureOrganization()
        This method determines whether the recipient is an organization with non-public address information or not.
        Returns:
        true if the recipient type is a secure organization, otherwise false.
      • isSecureStore

        public boolean isSecureStore()
        Determines whether the recipient is a store with non-public address information or not.
        Returns:
        true if the recipient type is a secure store, otherwise false.
      • isStore

        public boolean isStore()
        Determines whether the recipient type is a store(not a member or organization).
        Returns:
        true if the recipient type is a store, otherwise false.
      • setRecipientId

        public void setRecipientId(java.lang.Object newRecipientId)
        This method sets the recipient ID.
        Parameters:
        newRecipientId - The recipient ID.
      • setRecipientType

        public void setRecipientType(int newRecipientType)
        This method sets the recipient type.
        Parameters:
        newRecipientType - The recipient type.
      • toString

        public java.lang.String toString()
        This method returns a String that represents the value of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the receiver