curam.core.facade.intf

Interface UserTaskAllocationBlocking

All Known Implementing Classes:

UserTaskAllocationBlocking, curam.core.facade.impl.UserTaskAllocationBlocking, UserTaskAllocationBlockingFactory

@AccessLevel(value=EXTERNAL)
public interface UserTaskAllocationBlocking

Task allocation blocking enables the user to ensure that no tasks are assigned to them for a specified period of time. This class provides the operations used to create, list and cancel task allocation blocking periods for a user.

Method Summary

Modifier and Type	Method and Description
void	blockTaskAllocationForUser(curam.core.sl.struct.TaskAllocationBlockingCreateDetails key) Creates a task allocation blocking record for the specified user.
void	clearTaskAllocationBlockForUser(curam.core.sl.supervisor.struct.TaskAllocationBlockingDetails key) Clears an active or pending task allocation blocking record.
curam.core.facade.struct.AllTaskAllocationBlockingPeriodsForUserDetailsList	listTaskAllocationBlockingHistoryForUser(curam.core.struct.UserNameKey key) Returns a list of the task allocation blocking details for a specified user.

Method Detail

blockTaskAllocationForUser

void blockTaskAllocationForUser(curam.core.sl.struct.TaskAllocationBlockingCreateDetails key)
                         throws curam.util.exception.AppException,
                                curam.util.exception.InformationalException

Creates a task allocation blocking record for the specified user. A start and end date time is specified for the task allocation blocking period which allows task allocation blocking periods to be created for future dates.

The following validations are invoked by this operation:

• The start date and time must be in the future.
• If specified, the end date and time must be later than the start date and time.
• The time period of the task allocation block must not overlap with any current or pending task allocation block for the source user.
• The time period of the task allocation block must not overlap with any current or pending task redirections for the target user.

Parameters:

key - The details of the new task allocation blocking period.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listTaskAllocationBlockingHistoryForUser

curam.core.facade.struct.AllTaskAllocationBlockingPeriodsForUserDetailsList listTaskAllocationBlockingHistoryForUser(curam.core.struct.UserNameKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns a list of the task allocation blocking details for a specified user. Two lists of data are returned. The first contains the details of the all the active and pending task allocation blocking records for the specified user. The second list contains a list of all the expired task allocation blocking history records for the specified user.

Parameters:

key - The name of the user whose task allocation blocking period details will be returned. If a user name is not specified, the currently logged in user will be used.

Returns:

A list of task allocation blocking details for a specified user.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

clearTaskAllocationBlockForUser

void clearTaskAllocationBlockForUser(curam.core.sl.supervisor.struct.TaskAllocationBlockingDetails key)
                              throws curam.util.exception.AppException,
                                     curam.util.exception.InformationalException

Clears an active or pending task allocation blocking record. If the task allocation blocking period is active, then the end date time of the task allocation blocking record is updated to be the current date time. If the task allocation blocking period is pending, the task allocation blocking record is physically removed from the associated database table.

Parameters:

key - The details of the task allocation blocking period to clear.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException