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
          The member
static int ORGANIZATION
          The organization
static int SECUREMASK
          The secure mask
static int SECUREMEMBER
          The secure member
static int SECUREORGANIZATION
          The secure organization
static int SECURESTORE
          The secure store
static int STORE
          The 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 isOrganization()
          Determines whether the recipient type is an organization.
 boolean isSecureMember()
          Determines whether the recipient's address info is secure or not.
 boolean isSecureOrganization()
          Determines whether the recipient's address info of an organization is secure or not.
 boolean isSecureStore()
          Determines whether the recipient's address info of a store 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

SECUREMASK

public static final int SECUREMASK
The secure mask
See Also:
Constant Field Values

STORE

public static final int STORE
The store
See Also:
Constant Field Values

SECURESTORE

public static final int SECURESTORE
The secure store
See Also:
Constant Field Values

ORGANIZATION

public static final int ORGANIZATION
The organization
See Also:
Constant Field Values

SECUREORGANIZATION

public static final int SECUREORGANIZATION
The secure organization
See Also:
Constant Field Values

MEMBER

public static final int MEMBER
The member
See Also:
Constant Field Values

SECUREMEMBER

public static final int SECUREMEMBER
The secure member
See Also:
Constant Field Values
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:
The recipient Id.

getRecipientType

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

isMember

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

isOrganization

public boolean isOrganization()
Determines whether the recipient type is an organization.
Returns:
if the recipient type is an organization, return true, otherwise false.

isSecureMember

public boolean isSecureMember()
Determines whether the recipient's address info is secure or not.
Returns:
If the recipient type is a secure member, return true, otherwise false.

isSecureOrganization

public boolean isSecureOrganization()
Determines whether the recipient's address info of an organization is secure or not.
Returns:
If the recipient type is a secure organization, return true, otherwise false.

isSecureStore

public boolean isSecureStore()
Determines whether the recipient's address info of a store is secure or not.
Returns:
if the recipient type is a secure store, return true, otherwise false.

isStore

public boolean isStore()
Determines whether the recipient type is a store.
Returns:
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 - The recipient Id.

setRecipientType

public void setRecipientType(int newRecipientType)
Sets the recipient type.
Parameters:
newRecipientType - 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