WorkflowAllocationFunction (core)

All Known Implementing Classes:

WorkflowAllocationFunction, curam.core.sl.impl.WorkflowAllocationFunction, WorkflowAllocationFunctionFactory
```
@AccessLevel(value=EXTERNAL)
public interface WorkflowAllocationFunction
```
To select a specific agent or group of agents that can do the work for a specific task, an allocation strategy is defined. There are three types of allocation strategies currently supported by Curam workflow: function, rule and target. This class contains the allocation functions that may be used in task allocation.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`curam.core.sl.struct.AllocationTargetList`	`allocateTaskForPlannedItemTaskType(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemKey)` Returns a list of allocation targets that are defined by the allocation strategy specified for tasks associated with plan items.
`curam.core.sl.struct.AllocationTargetList`	`caseApprovalAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)` Returns a list of allocation targets that include the specified user.
`curam.core.sl.struct.AllocationTargetList`	`caseOwnerAllocationStrategy(curam.core.sl.struct.CaseIDKey key)` Returns a list of allocation targets that include the owner of the specified case.
`curam.core.sl.struct.AllocationTargetList`	`caseReviewAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)` Returns a list of allocation targets that include the reviewer(s) of the specified case.
`curam.core.sl.struct.AllocationTargetList`	`caseSupervisorAllocationStrategy(curam.core.sl.struct.CaseIDKey key)` Returns a list of allocation targets that include the supervisor(s) of the specified case.
`curam.core.sl.struct.AllocationTargetList`	`manualAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)` Returns a list of allocation targets that include the assignee details specified to create a new task from.
`curam.core.sl.struct.AllocationTargetList`	`manualReserveStrategy(curam.core.sl.struct.TaskManagementTaskKey taskManagementTaskKey, curam.core.sl.struct.TaskCreateDetails taskCreateDetails)` Returns a list of allocation targets that include the assignee details specified to create a new task from.
`curam.core.sl.struct.AllocationTargetList`	`processStandardAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)` Returns a list of allocation targets that include the administrator for the participant specified in the details to create a new task from.
`curam.core.sl.struct.AllocationTargetList`	`processStandardCaseAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)` Returns a list of allocation targets that include the owner for the case specified in the details to create a new task from.
`curam.core.sl.struct.AllocationTargetList`	`workQueueTaskAllocationStrategy(curam.core.sl.struct.WorkQueueIDKey key)` Returns a list of allocation targets that includes the specified work queue.

- Method Detail
  - caseApprovalAllocationStrategy
```
curam.core.sl.struct.AllocationTargetList caseApprovalAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException
```
    Returns a list of allocation targets that include the specified user.
    
    Parameters:
    
    taskCreateDetails - The details for creating a new task which include the name of the user that an allocation target should be created from.
    
    Returns:
    
    A list of allocation targets.
    
    Throws:
    
    curam.util.exception.AppException
    
    curam.util.exception.InformationalException
  - caseReviewAllocationStrategy
```
curam.core.sl.struct.AllocationTargetList caseReviewAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException
```
    Returns a list of allocation targets that include the reviewer(s) of the specified case.
    
    Parameters:
    
    taskCreateDetails - The details to create a new task from which include the case identifier. The unique identifier of the case is used to identify the reviewer(s) which will be used to create allocation targets from.
    
    Returns:
    
    A list of allocation targets.
    
    Throws:
    
    curam.util.exception.AppException
    
    curam.util.exception.InformationalException
  - manualAllocationStrategy
```
curam.core.sl.struct.AllocationTargetList manualAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException
```
    Returns a list of allocation targets that include the assignee details specified to create a new task from.
    
    Parameters:
    
    taskCreateDetails - The details used to create a new task from which includes the assignee name and assignee type used to create the allocation target from.
    
    Returns:
    
    A list of allocation targets.
    
    Throws:
    
    curam.util.exception.AppException
    
    curam.util.exception.InformationalException
  - manualReserveStrategy
```
curam.core.sl.struct.AllocationTargetList manualReserveStrategy(curam.core.sl.struct.TaskManagementTaskKey taskManagementTaskKey,
                                                                curam.core.sl.struct.TaskCreateDetails taskCreateDetails)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException
```
    Returns a list of allocation targets that include the assignee details specified to create a new task from. If the reserveToMeInd flag has been specified in the details to create the new task, then the task will be added to the user's My Tasks> list.
    Parameters: taskCreateDetails - The details used to create a new task from which includes the assignee name and assignee type used to create the allocation target from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException
  processStandardAllocationStrategy curam.core.sl.struct.AllocationTargetList processStandardAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException Returns a list of allocation targets that include the administrator for the participant specified in the details to create a new task from. Parameters: taskCreateDetails - The details used to create a new task from which includes a participant whose administrator will be used to create the allocation target from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException processStandardCaseAllocationStrategy curam.core.sl.struct.AllocationTargetList processStandardCaseAllocationStrategy(curam.core.sl.struct.TaskCreateDetails taskCreateDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException Returns a list of allocation targets that include the owner for the case specified in the details to create a new task from. Parameters: taskCreateDetails - The details used to create a new task from which includes a case whose owner will be used to create the allocation target from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException caseOwnerAllocationStrategy curam.core.sl.struct.AllocationTargetList caseOwnerAllocationStrategy(curam.core.sl.struct.CaseIDKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException Returns a list of allocation targets that include the owner of the specified case. Parameters: key - The unique identifier of the case whose owner will be used to create an allocation target from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException caseSupervisorAllocationStrategy curam.core.sl.struct.AllocationTargetList caseSupervisorAllocationStrategy(curam.core.sl.struct.CaseIDKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException Returns a list of allocation targets that include the supervisor(s) of the specified case. If the supervisor has not been specified for the case, then the dynamic supervisor of the case owner will be used to create the allocation target. If the case owner does not have any supervisors, then the allocation target is created using the administrator of the case work queue. Parameters: key - The unique identifier of a case which will be processed to determine what users to create the allocation targets from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException allocateTaskForPlannedItemTaskType curam.core.sl.struct.AllocationTargetList allocateTaskForPlannedItemTaskType(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException Returns a list of allocation targets that are defined by the allocation strategy specified for tasks associated with plan items. The tasks are allocated based on the service plan task configuration setting. If the task configuration setting is such that the task should be assigned to the planned item owner then the plan item owner is retrieved and an allocation target is created for that item. Otherwise, an allocation target is created for the item in the task configuration. Parameters: plannedItemKey - The unique identifier of the planned item whose task configuration details will be used to create allocation targets from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException workQueueTaskAllocationStrategy curam.core.sl.struct.AllocationTargetList workQueueTaskAllocationStrategy(curam.core.sl.struct.WorkQueueIDKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException Returns a list of allocation targets that includes the specified work queue. Parameters: key - The unique identifier of a work queue which will be used to create an allocation target from. Returns: A list of allocation targets. Throws: curam.util.exception.AppException curam.util.exception.InformationalException

Interface WorkflowAllocationFunction

Method Summary

Method Detail

caseApprovalAllocationStrategy

caseReviewAllocationStrategy

manualAllocationStrategy

manualReserveStrategy

processStandardAllocationStrategy

processStandardCaseAllocationStrategy

caseOwnerAllocationStrategy

caseSupervisorAllocationStrategy

allocateTaskForPlannedItemTaskType

workQueueTaskAllocationStrategy