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 to represent a recipient that a message is being sent to.

See Also:
Serialized Form

Field Summary
static int MEMBER
           
static int SECUREMASK
           
static int SECUREMEMBER
           
static int STORE
           
 
Constructor Summary
RecipientInfo()
          Constructs the RecipientInfo object.
RecipientInfo(java.lang.Object a_recipientID, int a_recipientType)
          Constructs the RecipientInfo object.
 
Method Summary
 java.lang.Object getRecipientId()
          Returns the recipient Id.
 int getRecipientType()
          Returns the recipient type.
 boolean isMember()
          Determines whether the recipient type is a member.
 boolean isSecureMember()
          Determines whether the recipient's address info is secure or not.
 boolean isStore()
          Determines whether the recipient type is a store.
 void setRecipientId(java.lang.Object newRecipientId)
          Sets the recipient Id.
 void setRecipientType(int newRecipientType)
          Sets the recipient type.
 java.lang.String toString()
          Returns a String that represents the value of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MEMBER

public static int MEMBER

SECUREMASK

public static int SECUREMASK

SECUREMEMBER

public static int SECUREMEMBER

STORE

public static int STORE
Constructor Detail

RecipientInfo

public RecipientInfo()
Constructs the RecipientInfo object.

RecipientInfo

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

getRecipientId

public java.lang.Object getRecipientId()
Returns the recipient Id.
Returns:
java.lang.Long The recipient Id.

getRecipientType

public int getRecipientType()
Returns the recipient type.
Returns:
int The recipient type.

isMember

public boolean isMember()
Determines whether the recipient type is a member.
Returns:
boolean If the recipient type is a member, return true, otherwise false.

isSecureMember

public boolean isSecureMember()
Determines whether the recipient's address info is secure or not.
Returns:
boolean

isStore

public boolean isStore()
Determines whether the recipient type is a store.
Returns:
boolean If the recipient type is a store, return true, otherwise false.

setRecipientId

public void setRecipientId(java.lang.Object newRecipientId)
Sets the recipient Id.
Parameters:
newRecipientId - java.lang.Long The recipient Id.

setRecipientType

public void setRecipientType(int newRecipientType)
Sets the recipient type.
Parameters:
newRecipientType - int The recipient type.

toString

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