org.kuali.rice.kcb.bo
Class MessageDelivery

java.lang.Object
  extended by org.kuali.rice.kcb.bo.BaseLockable
      extended by org.kuali.rice.kcb.bo.MessageDelivery
All Implemented Interfaces:
Lockable

public class MessageDelivery
extends BaseLockable

This class represents an instance of a MessageDelivery. A Message gets delivered to recipients, possibly in various ways. For each delivery type that a recipient gets sent to them, they have an instance of this entity.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Field Summary
private  String delivererSystemId
           
private  String delivererTypeName
           
static String DELIVERY_STATUS
           
private  String deliveryStatus
           
private  Long id
           
static String ID_FIELD
          Field names
private  Integer lockVerNbr
          Lock column for OJB optimistic locking
private  Message message
          This delivery's message
static String MESSAGEID_FIELD
           
static String PROCESS_COUNT
           
private  Integer processCount
           
static String SYSTEMID_FIELD
           
private static Integer ZERO
           
 
Fields inherited from class org.kuali.rice.kcb.bo.BaseLockable
LOCKED_DATE, lockedDate
 
Constructor Summary
MessageDelivery()
          Constructs a MessageDelivery instance.
MessageDelivery(MessageDelivery md)
          Shallow-copy constructor
 
Method Summary
 String getDelivererSystemId()
          Gets the delivererSystemId attribute.
 String getDelivererTypeName()
          Gets the delivererTypeName attribute.
 String getDeliveryStatus()
          Gets the deliveryStatus attribute.
 Long getId()
          Gets the id attribute.
 Integer getLockVerNbr()
          Return value of lock column for OJB optimistic locking
 Message getMessage()
           
 Integer getProcessCount()
           
 void setDelivererSystemId(String delivererSystemId)
          Sets the delivererSystemId attribute value.
 void setDelivererTypeName(String delivererTypeName)
          Sets the delivererTypeName attribute value.
 void setDeliveryStatus(MessageDeliveryStatus deliveryStatus)
          Convenience method that sets the delivery status in a typesafe manner.
 void setDeliveryStatus(String deliveryStatus)
          Sets the deliveryStatus attribute value.
 void setId(Long id)
          Sets the id attribute value.
 void setLockVerNbr(Integer lockVerNbr)
          Set value of lock column for OJB optimistic locking
 void setMessage(Message message)
          Sets this delivery's message
 void setProcessCount(Integer processCount)
          Sets the number of times processing has been attempted for this message
 String toString()
           
 
Methods inherited from class org.kuali.rice.kcb.bo.BaseLockable
getLockedDate, setLockedDate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ZERO

private static final Integer ZERO

ID_FIELD

public static final String ID_FIELD
Field names

See Also:
Constant Field Values

SYSTEMID_FIELD

public static final String SYSTEMID_FIELD
See Also:
Constant Field Values

MESSAGEID_FIELD

public static final String MESSAGEID_FIELD
See Also:
Constant Field Values

DELIVERY_STATUS

public static final String DELIVERY_STATUS
See Also:
Constant Field Values

PROCESS_COUNT

public static final String PROCESS_COUNT
See Also:
Constant Field Values

id

private Long id

delivererTypeName

private String delivererTypeName

delivererSystemId

private String delivererSystemId

deliveryStatus

private String deliveryStatus

processCount

private Integer processCount

message

private Message message
This delivery's message


lockVerNbr

private Integer lockVerNbr
Lock column for OJB optimistic locking

Constructor Detail

MessageDelivery

public MessageDelivery()
Constructs a MessageDelivery instance.


MessageDelivery

public MessageDelivery(MessageDelivery md)
Shallow-copy constructor

Parameters:
md - MessageDelivery to (shallow) copy
Method Detail

getId

public Long getId()
Gets the id attribute.

Returns:
Returns the id.

setId

public void setId(Long id)
Sets the id attribute value.

Parameters:
id - The id to set.

getLockVerNbr

public Integer getLockVerNbr()
Return value of lock column for OJB optimistic locking

Returns:
value of lock column for OJB optimistic locking

setLockVerNbr

public void setLockVerNbr(Integer lockVerNbr)
Set value of lock column for OJB optimistic locking

Parameters:
lockVerNbr - value of lock column for OJB optimistic locking

getDeliveryStatus

public String getDeliveryStatus()
Gets the deliveryStatus attribute.

Returns:
Returns the deliveryStatus.

setDeliveryStatus

public void setDeliveryStatus(MessageDeliveryStatus deliveryStatus)
Convenience method that sets the delivery status in a typesafe manner. This method is preferred to setDeliveryStatus(String)

Parameters:
deliveryStatus - the MessageDeliveryStatus enum constant

setDeliveryStatus

public void setDeliveryStatus(String deliveryStatus)
Sets the deliveryStatus attribute value.

Parameters:
deliveryStatus - The deliveryStatus to set.

getProcessCount

public Integer getProcessCount()
Returns:
the number of times processing has been attempted for this message

setProcessCount

public void setProcessCount(Integer processCount)
Sets the number of times processing has been attempted for this message

Parameters:
processCount - the number of times processing has been attempted for this message

getDelivererTypeName

public String getDelivererTypeName()
Gets the delivererTypeName attribute.

Returns:
Returns the delivererTypeName.

setDelivererTypeName

public void setDelivererTypeName(String delivererTypeName)
Sets the delivererTypeName attribute value.

Parameters:
delivererTypeName - The delivererTypeName to set.

getDelivererSystemId

public String getDelivererSystemId()
Gets the delivererSystemId attribute.

Returns:
Returns the delivererSystemId.

setDelivererSystemId

public void setDelivererSystemId(String delivererSystemId)
Sets the delivererSystemId attribute value.

Parameters:
delivererSystemId - The delivererSystemId to set.

getMessage

public Message getMessage()
Returns:
this delivery's message

setMessage

public void setMessage(Message message)
Sets this delivery's message

Parameters:
message - the message to set

toString

public String toString()
Overrides:
toString in class Object
See Also:
Object.toString()


Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.