com.webmethods.caf.faces.data.task.impl

Interface ITaskWorkloadProvider

All Known Implementing Classes:

BaseTaskWorkloadProvider, TaskInboxQueueWorkloadProvider, TaskRoundRobinWorkloadProvider

public interface ITaskWorkloadProvider

Common interface for task distribution manager. The implementation function is to choose a set of principals to distribute a task from a larger set (workgroup). The workgroup members are typically members of the one or several static roles used for assignment configuration when using distribution management option

Method Summary

Modifier and Type	Method and Description
Object	getResult() Functions of concrete workload manager implementation to return a principal or principal list to distribute given task to
com.webmethods.caf.rules.IRule	getRule() Returns the rule instance used for this workload manager
String	getTaskID() Returns task instance ID for this workload manager
String	getWorkgroup() Returns an identifier for the workgroup.
Object[]	getWorkgroupMembers() Returns workgroups members
void	init(Map<String,?> properties) Initializes distribution manager with bag of properties
void	setRule(com.webmethods.caf.rules.IRule rule) Sets rule instance to be used by workload manager
void	setTaskID(String taskID) Sets task instance ID for this workload manager
void	setWorkgroup(String workgroup) Sets identifier for the workgroup.
void	setWorkgroupMembers(Object[] workgroupMembers) Sets workgroup members

Method Detail

init

void init(Map<String,?> properties)
   throws Exception

Initializes distribution manager with bag of properties

Throws:

Exception

getWorkgroup

String getWorkgroup()

Returns an identifier for the workgroup. Each workgroup has a unique name and a set of members to choose from

setWorkgroup

void setWorkgroup(String workgroup)

Sets identifier for the workgroup. Each workgroup has a unique name and a set of members to choose from

getWorkgroupMembers

Object[] getWorkgroupMembers()

Returns workgroups members

setWorkgroupMembers

void setWorkgroupMembers(Object[] workgroupMembers)

Sets workgroup members

getRule

com.webmethods.caf.rules.IRule getRule()

Returns the rule instance used for this workload manager

setRule

void setRule(com.webmethods.caf.rules.IRule rule)

Sets rule instance to be used by workload manager

getTaskID

String getTaskID()

Returns task instance ID for this workload manager

setTaskID

void setTaskID(String taskID)

Sets task instance ID for this workload manager

getResult

Object getResult()

Functions of concrete workload manager implementation to return a principal or principal list to distribute given task to