Package org.kuali.rice.kcb.bo
Class MessageDelivery
java.lang.Object
org.kuali.rice.kcb.bo.BaseLockable
org.kuali.rice.kcb.bo.MessageDelivery
- All Implemented Interfaces:
Lockable
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
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringField namesstatic final Stringstatic final Stringstatic final StringFields inherited from class org.kuali.rice.kcb.bo.BaseLockable
LOCKED_DATE, lockedDate -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a MessageDelivery instance.Shallow-copy constructor -
Method Summary
Modifier and TypeMethodDescriptionGets the delivererSystemId attribute.Gets the delivererTypeName attribute.Gets the deliveryStatus attribute.getId()Gets the id attribute.Return value of lock column for OJB optimistic lockingvoidsetDelivererSystemId(String delivererSystemId) Sets the delivererSystemId attribute value.voidsetDelivererTypeName(String delivererTypeName) Sets the delivererTypeName attribute value.voidsetDeliveryStatus(String deliveryStatus) Sets the deliveryStatus attribute value.voidsetDeliveryStatus(MessageDeliveryStatus deliveryStatus) Convenience method that sets the delivery status in a typesafe manner.voidSets the id attribute value.voidsetLockVerNbr(Integer lockVerNbr) Set value of lock column for OJB optimistic lockingvoidsetMessage(Message message) Sets this delivery's messagevoidsetProcessCount(Integer processCount) Sets the number of times processing has been attempted for this messagetoString()Methods inherited from class org.kuali.rice.kcb.bo.BaseLockable
getLockedDate, setLockedDate
-
Field Details
-
ID_FIELD
Field names- See Also:
-
SYSTEMID_FIELD
- See Also:
-
MESSAGEID_FIELD
- See Also:
-
DELIVERY_STATUS
- See Also:
-
PROCESS_COUNT
- See Also:
-
-
Constructor Details
-
MessageDelivery
public MessageDelivery()Constructs a MessageDelivery instance. -
MessageDelivery
Shallow-copy constructor- Parameters:
md- MessageDelivery to (shallow) copy
-
-
Method Details
-
getId
Gets the id attribute.- Returns:
- Returns the id.
-
setId
Sets the id attribute value.- Parameters:
id- The id to set.
-
getLockVerNbr
Return value of lock column for OJB optimistic locking- Returns:
- value of lock column for OJB optimistic locking
-
setLockVerNbr
Set value of lock column for OJB optimistic locking- Parameters:
lockVerNbr- value of lock column for OJB optimistic locking
-
getDeliveryStatus
Gets the deliveryStatus attribute.- Returns:
- Returns the deliveryStatus.
-
setDeliveryStatus
Convenience method that sets the delivery status in a typesafe manner. This method is preferred tosetDeliveryStatus(String)- Parameters:
deliveryStatus- the MessageDeliveryStatus enum constant
-
setDeliveryStatus
Sets the deliveryStatus attribute value.- Parameters:
deliveryStatus- The deliveryStatus to set.
-
getProcessCount
- Returns:
- the number of times processing has been attempted for this message
-
setProcessCount
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
Gets the delivererTypeName attribute.- Returns:
- Returns the delivererTypeName.
-
setDelivererTypeName
Sets the delivererTypeName attribute value.- Parameters:
delivererTypeName- The delivererTypeName to set.
-
getDelivererSystemId
Gets the delivererSystemId attribute.- Returns:
- Returns the delivererSystemId.
-
setDelivererSystemId
Sets the delivererSystemId attribute value.- Parameters:
delivererSystemId- The delivererSystemId to set.
-
getMessage
- Returns:
- this delivery's message
-
setMessage
Sets this delivery's message- Parameters:
message- the message to set
-
toString
-