curam.waitlist.impl

Interface WaitListEntry

All Superinterfaces:

curam.util.persistence.Entity<java.lang.Long>, curam.util.persistence.Insertable, curam.util.persistence.helper.Lifecycle<curam.codetable.impl.WAITLISTENTRYSTATUSEntry>, curam.util.persistence.OptimisticLockable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.StandardEntity, WaitListEntryAccessor

@AccessLevel(value=EXTERNAL)
public interface WaitListEntry
extends curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, WaitListEntryAccessor

Business interface to maintain the wait list entries. Each entry of client in the wait list forms a 'wait list entry'. Wait list entry can be in the 'open' or 'allocated' or 'removed' or 'expired' state. The position of a wait list entry can change when a new entry is added or an existing entry is either removed, allocated or expired.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WaitListEntry.WaitListEntryAllocateEvents Business interface to maintain events to allow the system to write and attach custom work flows for the allocation of wait list entries.
static interface	WaitListEntry.WaitListEntryCancelEvents Business interface to maintain events to allow the system to write and attach custom work flows for the cancellation of wait list Entries.
static interface	WaitListEntry.WaitListEntryCreateWaitListEntryEvents Business interface to maintain events to allow the system to write and attach custom work flows for the creation of wait list entries.
static interface	WaitListEntry.WaitListEntryDeferReviewEvents Business interface to maintain events to allow the system to write and attach custom work flows for the deferred review of wait list Entries.
static interface	WaitListEntry.WaitListEntryExpireEvents Business interface to maintain events to allow the system to write and attach custom work flows for the expiry of wait list entries.
static interface	WaitListEntry.WaitListEntryInsertEvents Business interface to maintain events to allow the system to write and attach custom work flows for the insertion of wait list Entries.
static interface	WaitListEntry.WaitListEntryModifyEvents Business interface to maintain events to allow the system to write and attach custom work flows for the modification of wait list Entries.
static interface	WaitListEntry.WaitListEntryModifyWaitListEntryEvents Business interface to maintain events to allow the system to write and attach custom work flows for the modification of wait list Entries.

Method Summary

Modifier and Type	Method and Description
void	allocate(int versionNo) Sets the wait list entry's status as allocated only if the wait list entry is in open state.
void	cancel(int versionNo) Cancels the wait list entry only if the wait list entry is in open state.
void	createWaitListEntry(WaitList waitList) Creates a wait list entry.
void	deferReview(int versionNo) Defers the wait list entry review to a future date.
void	expire(int versionNo) Sets the wait list entry's status as expired if the current date crosses the expiry date of the wait list entry only if the wait list entry is in open state.
java.util.Set<curam.waitlist.impl.WaitListEntryStatusHistory>	getHistory() Returns the status history for the wait list entry.
WaitList	getWaitList() Gets the parent wait list details for the wait list entry.
java.util.List<? extends WaitListEntryHistoryAccessor>	getWaitListEntryHistory() Returns the History for the wait list entry.
void	modifyWaitListEntry(int versionNo) Modifies the expiry date, position and priority for the wait list entry only if the wait list entry is in the open state.
void	setClient(long caseParticipantRoleID) Sets the case participant role id for the wait list entry.
void	setComments(java.lang.String comments) Sets the comments for the wait list entry recorded by the user.
void	setExpiryDate(curam.util.type.Date expiryDate) Sets the expiry date for the wait list entry.
void	setPosition(short position) Sets the position for the wait list entry.
void	setPriority(curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority) Sets the priority for the wait list entry.
void	setRemovalReason(curam.codetable.impl.WAITLISTREMOVALREASONEntry removalReason) Sets the removal reason for the wait list entry.
void	setReviewDate(curam.util.type.Date reviewDate) Sets the review date for the wait list entry.
void	setTransactionUser(java.lang.String userName) Sets the transaction user for the wait list entry.

Methods inherited from interface curam.util.persistence.Insertable

insert

Methods inherited from interface curam.util.persistence.OptimisticLockModifiable

modify

Methods inherited from interface curam.util.persistence.OptimisticLockable

getVersionNo

Methods inherited from interface curam.waitlist.impl.WaitListEntryAccessor

getClient, getComments, getDeferredExpiryDate, getDeferredReviewDate, getExpiryDate, getLatestHistory, getPosition, getPriority, getRemovalReason, getReviewDate, getReviewDateFromReminderPeriod

Methods inherited from interface curam.util.persistence.Entity

getContextContainer, getID, getPersistenceEventDispatcher

Methods inherited from interface curam.util.persistence.helper.Lifecycle

getLifecycleState

Method Detail

getWaitList

@AccessLevel(value=EXTERNAL)
WaitList getWaitList()

Gets the parent wait list details for the wait list entry.

Specified by:

getWaitList in interface WaitListEntryAccessor

Returns:

The wait list details.

Business Object Read:

WaitList

setClient

@AccessLevel(value=EXTERNAL)
void setClient(long caseParticipantRoleID)

Sets the case participant role id for the wait list entry.

Parameters:

caseParticipantRoleID - The case participant role id.

Business Object Write:

WaitList

setPosition

@AccessLevel(value=EXTERNAL)
void setPosition(short position)

Sets the position for the wait list entry.

Parameters:

position - The actual position of the wait list entry in the wait list.

Business Object Write:

WaitList

setPriority

@AccessLevel(value=EXTERNAL)
void setPriority(curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority)

Sets the priority for the wait list entry. The priority of the wait list entry can be high or medium or low. Priority of wait list entry is only for informational purposes and is not considered when deciding the order of the wait list entry.

Parameters:

priority - The priority of the wait list entry.

Business Object Write:

WaitList

setExpiryDate

@AccessLevel(value=EXTERNAL)
void setExpiryDate(curam.util.type.Date expiryDate)

Sets the expiry date for the wait list entry. After this date, the client will no longer be considered for allocation to the resource.

Parameters:

expiryDate - The date on which the wait list entry expires.

Business Object Write:

WaitList

setRemovalReason

@AccessLevel(value=EXTERNAL)
void setRemovalReason(curam.codetable.impl.WAITLISTREMOVALREASONEntry removalReason)

Sets the removal reason for the wait list entry.

Parameters:

removalReason - The reason for removal of the wait list entry.

Business Object Write:

WaitList

setReviewDate

@AccessLevel(value=EXTERNAL)
void setReviewDate(curam.util.type.Date reviewDate)

Sets the review date for the wait list entry.

Parameters:

reviewDate - The date on which the wait list entry needs to be reviewed by the user.

Business Object Write:

WaitList

setComments

@AccessLevel(value=EXTERNAL)
void setComments(java.lang.String comments)

Sets the comments for the wait list entry recorded by the user.

Parameters:

comments - The comments recorded by the user relating to the wait list entry.

Business Object Write:

WaitList

setTransactionUser

@AccessLevel(value=EXTERNAL)
void setTransactionUser(java.lang.String userName)
                                              throws curam.util.exception.InformationalException

Sets the transaction user for the wait list entry.

Parameters:

username - The user name of the wait list entry.

Throws:

curam.util.exception.InformationalException

Business Object Write:

WaitList

createWaitListEntry

@AccessLevel(value=EXTERNAL)
void createWaitListEntry(WaitList waitList)
                                               throws curam.util.exception.InformationalException,
                                                      curam.util.exception.AppException

Creates a wait list entry. If a wait list already exists for the requested resource and type, system uses the existing wait list itself. Otherwise, system creates a new wait list and adds a wait list entry to it.

Parameters:

waitList - The details of wait list.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

allocate

@AccessLevel(value=EXTERNAL)
void allocate(int versionNo)
                                    throws curam.util.exception.InformationalException,
                                           curam.util.exception.AppException

Sets the wait list entry's status as allocated only if the wait list entry is in open state.

Parameters:

versionNo - The version number of the wait list entry.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

cancel

@AccessLevel(value=EXTERNAL)
void cancel(int versionNo)
                                  throws curam.util.exception.InformationalException,
                                         curam.util.exception.AppException

Cancels the wait list entry only if the wait list entry is in open state.

Parameters:

versionNo - The version number of the wait list entry.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

expire

@AccessLevel(value=EXTERNAL)
void expire(int versionNo)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Sets the wait list entry's status as expired if the current date crosses the expiry date of the wait list entry only if the wait list entry is in open state. The system then renumbers the wait list, decrementing the position by 1 for all the remaining wait list entries having a position higher than or equal to the former position of the expired entry.

Parameters:

versionNo - The version number of the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitList

deferReview

@AccessLevel(value=EXTERNAL)
void deferReview(int versionNo)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Defers the wait list entry review to a future date.

Parameters:

versionNo - The version number of the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitList

modifyWaitListEntry

@AccessLevel(value=EXTERNAL)
void modifyWaitListEntry(int versionNo)
                                               throws curam.util.exception.InformationalException,
                                                      curam.util.exception.AppException

Modifies the expiry date, position and priority for the wait list entry only if the wait list entry is in the open state. The system then renumbers the wait list by incrementing the position by 1 for all the remaining wait list entries having a position less than the original position but greater than or equal to the new position and raises a work flow event.

Parameters:

versionNo - The version number of the wait list entry.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

getHistory

@AccessLevel(value=EXTERNAL)
java.util.Set<curam.waitlist.impl.WaitListEntryStatusHistory> getHistory()
                                                                                               throws curam.util.exception.InformationalException,
                                                                                                      curam.util.exception.AppException

Returns the status history for the wait list entry.

Specified by:

getHistory in interface WaitListEntryAccessor

Returns:

WaitListEntryStatusHistory The list of wait list entry Status History records.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Read:

WaitList

getWaitListEntryHistory

@AccessLevel(value=EXTERNAL)
java.util.List<? extends WaitListEntryHistoryAccessor> getWaitListEntryHistory()
                                                                                                     throws curam.util.exception.InformationalException,
                                                                                                            curam.util.exception.AppException

Returns the History for the wait list entry.

Specified by:

getWaitListEntryHistory in interface WaitListEntryAccessor

Returns:

The list of wait list entry History.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Read:

WaitList