curam.waitlist.impl

Interface WaitList

All Superinterfaces:

curam.util.persistence.Entity<java.lang.Long>, curam.util.persistence.Insertable, curam.util.persistence.StandardEntity, WaitListAccessor

@AccessLevel(value=EXTERNAL)
public interface WaitList
extends curam.util.persistence.Insertable, WaitListAccessor

Business interface to maintain a wait list. Wait list is a queue created for a resource needed by clients. The resources are required for the delivery of a service, such as funds or the availability of a place in a facility.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WaitList.WaitListAddEntryEvents Business interface to maintain events to allow the system to write and attach custom work flows for adding entries to the wait list.
static interface	WaitList.WaitListAddWaitListEntryEvents Business interface to maintain events to allow the system to write and attach custom work flows for adding entries to the wait list.
static interface	WaitList.WaitListInsertEvents Business interface to maintain events to allow the system to write and attach custom work flows for the insertion of wait lists.

Method Summary

Modifier and Type	Method and Description
WaitListEntry	addEntry(long caseParticipantRoleID, short position, curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority, curam.util.type.Date expiryDate) Creates a wait list entry.
WaitListEntry	addEntry(long caseParticipantRoleID, curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority, curam.util.type.Date expiryDate) Creates a wait list entry.
WaitListEntry	addEntry(WaitListEntry waitListEntry) Creates a wait list entry.
java.util.Set<WaitListEntry>	getEntries() Returns the list of all the wait list entries.
java.util.Set<WaitListEntry>	getEntriesForClient(long caseParticipantRoleID) Returns the list of all the wait list entries for a client.
java.util.Set<WaitListEntry>	searchBy(long personID, curam.codetable.impl.WAITLISTENTRYPRIORITYEntry waitListEntryPriority, curam.codetable.impl.WAITLISTENTRYEXPIRYDAYSEntry waitListEntryExpiryDays, curam.codetable.impl.WAITLISTENTRYSTATUSEntry waitListEntryStatus, curam.codetable.impl.WAITLISTTYPEEntry waitListType) Returns the wait list entries for a matching resource type for specific case participant role ID, priority, and number of expiry days and/or status of the wait list entry.
java.util.Set<WaitListEntry>	searchBy(java.lang.String name, curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority, curam.util.type.Date expiryDate, curam.codetable.impl.WAITLISTENTRYSTATUSEntry status, curam.codetable.impl.WAITLISTTYPEEntry type) Returns the wait list entries for matching resource type for specific client name, priority, and number of expiry date and OR or status of the wait list entry.
void	setResource(curam.waitlist.impl.Resource resource) Sets the resource for the wait list.

Methods inherited from interface curam.util.persistence.Insertable

insert

Methods inherited from interface curam.waitlist.impl.WaitListAccessor

getCreatedDateTime, getResourceID, getType

Methods inherited from interface curam.util.persistence.Entity

getContextContainer, getID, getPersistenceEventDispatcher

Method Detail

setResource

@AccessLevel(value=EXTERNAL)
void setResource(curam.waitlist.impl.Resource resource)

Sets the resource for the wait list.

Parameters:

resource - The resource for the wait list.

Business Object Write:

WaitList

addEntry

@AccessLevel(value=EXTERNAL)
WaitListEntry addEntry(long caseParticipantRoleID,
                                                    short position,
                                                    curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority,
                                                    curam.util.type.Date expiryDate)
                                             throws curam.util.exception.InformationalException,
                                                    curam.util.exception.AppException

Creates a wait list entry. Each entry of a client in the wait list forms 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 new creates a wait list and adds an entry to this wait list at the specified position.

Parameters:

caseParticipantRoleID - The case participant role id of the client.

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

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

expiryDate - The date on which the wait list entry expires. After the expiry date, the client will no longer be considered for allocation to the resource.

Returns:

WaitListEntry The wait list entry details.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

addEntry

@AccessLevel(value=EXTERNAL)
WaitListEntry addEntry(long caseParticipantRoleID,
                                                    curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority,
                                                    curam.util.type.Date expiryDate)
                                             throws curam.util.exception.InformationalException,
                                                    curam.util.exception.AppException

Creates a wait list entry. Each entry of a client in the wait list forms 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 an entry to this wait list at the start of the Wait List.

Parameters:

caseParticipantRoleID - The case participant role id of the client.

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

expiryDate - The date on which the wait list entry expires. After the expiry date, the client will no longer be considered for allocation to the resource.

Returns:

WaitListEntry The wait list entry details.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

addEntry

@AccessLevel(value=EXTERNAL)
WaitListEntry addEntry(WaitListEntry waitListEntry)
                                             throws curam.util.exception.InformationalException,
                                                    curam.util.exception.AppException

Creates a wait list entry. Each entry of a client in the wait list forms 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 an entry to wait list.

Parameters:

waitListEntry - The details of wait list entry.

Returns:

WaitListEntry The wait list entry details.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Write:

WaitList

getEntriesForClient

@AccessLevel(value=EXTERNAL)
java.util.Set<WaitListEntry> getEntriesForClient(long caseParticipantRoleID)
                                                                       throws curam.util.exception.InformationalException,
                                                                              curam.util.exception.AppException

Returns the list of all the wait list entries for a client. Also validates if the client details passed are valid. If there are no wait list entries for the client, an error is returned to the calling system.

Specified by:

getEntriesForClient in interface WaitListAccessor

Parameters:

caseParticipantRoleID - The case participant role id of the client.

Returns:

WaitListEntry The list of wait list entries for the given client.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Read:

WaitList

getEntries

@AccessLevel(value=EXTERNAL)
java.util.Set<WaitListEntry> getEntries()
                                                              throws curam.util.exception.InformationalException,
                                                                     curam.util.exception.AppException

Returns the list of all the wait list entries.

Specified by:

getEntries in interface WaitListAccessor

Returns:

WaitListEntry The list of wait list entries for the given client.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Read:

WaitList

searchBy

java.util.Set<WaitListEntry> searchBy(java.lang.String name,
                                      curam.codetable.impl.WAITLISTENTRYPRIORITYEntry priority,
                                      curam.util.type.Date expiryDate,
                                      curam.codetable.impl.WAITLISTENTRYSTATUSEntry status,
                                      curam.codetable.impl.WAITLISTTYPEEntry type)
                               throws curam.util.exception.InformationalException,
                                      curam.util.exception.AppException

Description copied from interface: WaitListAccessor

Returns the wait list entries for matching resource type for specific client name, priority, and number of expiry date and OR or status of the wait list entry.

Specified by:

searchBy in interface WaitListAccessor

Parameters:

name - The client name of the wait list entry.

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

expiryDate - The date on which the wait list entry expires. After this date, the client will no longer be considered for allocating the resource.

status - The status of the WaitList entry.

type - The type of the Wait List.

Returns:

The list of wait list entries.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

searchBy

@AccessLevel(value=EXTERNAL)
java.util.Set<WaitListEntry> searchBy(long personID,
                                                                   curam.codetable.impl.WAITLISTENTRYPRIORITYEntry waitListEntryPriority,
                                                                   curam.codetable.impl.WAITLISTENTRYEXPIRYDAYSEntry waitListEntryExpiryDays,
                                                                   curam.codetable.impl.WAITLISTENTRYSTATUSEntry waitListEntryStatus,
                                                                   curam.codetable.impl.WAITLISTTYPEEntry waitListType)
                                                            throws curam.util.exception.InformationalException,
                                                                   curam.util.exception.AppException

Returns the wait list entries for a matching resource type for specific case participant role ID, priority, and number of expiry days and/or status of the wait list entry.

Parameters:

personID - The case participant role id of the client for whom the wait list entries details are to be retrieved.

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

waitListEntryExpiryDays - The date on which the wait list entry expires. After this date, the client will no longer be considered for allocation to the resource.

waitListEntryStatus - The status of the wait list entry.

Returns:

WaitListEntry The list of wait list entries.

Throws:

curam.util.exception.InformationalException

curam.util.exception.AppException

Business Object Read:

WaitList