Package com.axelor.meta.web

Class MetaWorkflowTaskController

java.lang.Object

com.axelor.meta.web.MetaWorkflowTaskController

public class MetaWorkflowTaskController
extends Object

Constructor Summary

Constructors

Constructor	Description
MetaWorkflowTaskController()

Method Summary

Modifier and Type	Method	Description
void	cancel(ActionRequest request, ActionResponse response)	Cancel a pending task (admin only).
void	claim(ActionRequest request, ActionResponse response)	Claim a pooled task for the current user.
void	complete(ActionRequest request, ActionResponse response)	Complete the task with a comment.
void	completeTask(ActionRequest request, ActionResponse response)	Approve the task: straight through when its commentMode asks for no comment on a completion, otherwise via the comment dialog.
void	countMyTasks(ActionRequest request, ActionResponse response)	How many approvals the current user can act on -- the nav-header notification badge, pushed over the tags websocket channel alongside the team-task and mail counts.
void	forceCompleteTask(ActionRequest request, ActionResponse response)	Force-complete the task (admin).
void	myTasks(ActionRequest request, ActionResponse response)	Open the actionable-by-me grid for the current user.
void	openRecord(ActionRequest request, ActionResponse response)	Open the underlying business record in its own form.
void	openTask(ActionRequest request, ActionResponse response)	Open a single task's approval form directly (not the record's task grid) — the target of a dropdown row's body click.
void	pendingCountForRecord(ActionRequest request, ActionResponse response)	Pending-approval count for one business record — powers the record form's toolbar badge.
void	prepareForm(ActionRequest request, ActionResponse response)	onLoad: hide toolbar buttons the current user can't use right now.
void	reassign(ActionRequest request, ActionResponse response)	Reassign a pending task (admin or current assignee) to a new user/role/group.
void	reject(ActionRequest request, ActionResponse response)	Reject the task with a required comment, then resume the run (routing on the rejection is a downstream decision).
void	rejectTask(ActionRequest request, ActionResponse response)	Reject the task, prompting for a comment only when commentMode requires one.
void	tasksForRecord(ActionRequest request, ActionResponse response)	Open the pending approvals for one business record — the target of the record form's toolbar "Approvals" button.
void	tasksListForRecord(ActionRequest request, ActionResponse response)	Pending tasks on one business record as lightweight DTO rows for the record form's approvals dropdown.
void	workflowModels(ActionRequest request, ActionResponse response)	Models that have at least one active workflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MetaWorkflowTaskController

public MetaWorkflowTaskController()

Method Details

myTasks

public void myTasks(ActionRequest request,
 ActionResponse response)

Open the actionable-by-me grid for the current user.

countMyTasks

public void countMyTasks(ActionRequest request,
 ActionResponse response)

How many approvals the current user can act on -- the nav-header notification badge, pushed over the tags websocket channel alongside the team-task and mail counts.

Counts exactly what myTasks(com.axelor.rpc.ActionRequest, com.axelor.rpc.ActionResponse) lists (same predicate, see WorkflowTaskQueries.myTasksDomain(com.axelor.auth.db.User)), so the badge never promises rows the grid then withholds. Unauthenticated callers get 0 rather than an error: the channel fans this out to every session and a missing user is not a fault.

tasksForRecord

public void tasksForRecord(ActionRequest request,
 ActionResponse response)

Open the pending approvals for one business record — the target of the record form's toolbar "Approvals" button. The record's model/id arrive as context (_recordModel/ _recordId) since a task references its record polymorphically.

pendingCountForRecord

public void pendingCountForRecord(ActionRequest request,
 ActionResponse response)

Pending-approval count for one business record — powers the record form's toolbar badge. The model/recordId arrive as client-supplied context, so this authorizes by record read access exactly as tasksForRecord(com.axelor.rpc.ActionRequest, com.axelor.rpc.ActionResponse) does; a caller who cannot read the record (or supplies no record) gets 0. Guarding here closes the IDOR the client's own count query would otherwise leave open, since task read access alone does not gate the polymorphic record.

tasksListForRecord

public void tasksListForRecord(ActionRequest request,
 ActionResponse response)

Pending tasks on one business record as lightweight DTO rows for the record form's approvals dropdown. Authorizes by record read access exactly as pendingCountForRecord(com.axelor.rpc.ActionRequest, com.axelor.rpc.ActionResponse) (client- supplied model/id ⇒ IDOR guard); a caller who cannot read the record — or supplies none — gets an empty list. Each row carries the friendly snapshot fields plus server-computed action flags (via WorkflowTaskQueries.rowsForRecord(java.lang.String, java.lang.Long, com.axelor.auth.db.User)), so the client never decides who may act.

workflowModels

public void workflowModels(ActionRequest request,
 ActionResponse response)

Models that have at least one active workflow. The client fetches this once and caches it, so the per-record pending-count query is skipped on forms whose model can never have an approval.

prepareForm

public void prepareForm(ActionRequest request,
 ActionResponse response)

onLoad: hide toolbar buttons the current user can't use right now.

openRecord

public void openRecord(ActionRequest request,
 ActionResponse response)

Open the underlying business record in its own form.

openTask

public void openTask(ActionRequest request,
 ActionResponse response)

Open a single task's approval form directly (not the record's task grid) — the target of a dropdown row's body click. Opens meta-workflow-approval-form as a popup preselected on this task via _showRecord, keeping its toolbar so the approver can act from the detail view. Record-access gated like every other per-task operation.

completeTask

public void completeTask(ActionRequest request,
 ActionResponse response)

Approve the task: straight through when its commentMode asks for no comment on a completion, otherwise via the comment dialog. Same for rejectTask(com.axelor.rpc.ActionRequest, com.axelor.rpc.ActionResponse) and forceCompleteTask(com.axelor.rpc.ActionRequest, com.axelor.rpc.ActionResponse) — the dialog exists to collect a required comment, so a task that requires none never shows one.

rejectTask

public void rejectTask(ActionRequest request,
 ActionResponse response)

Reject the task, prompting for a comment only when commentMode requires one.

forceCompleteTask

public void forceCompleteTask(ActionRequest request,
 ActionResponse response)

Force-complete the task (admin). A forced completion is a completion, so it follows the complete half of commentMode exactly as completeTask(com.axelor.rpc.ActionRequest, com.axelor.rpc.ActionResponse) does.

complete

public void complete(ActionRequest request,
 ActionResponse response)

Complete the task with a comment. When context contains _force=true (the force-complete dialog), delegates to WorkflowTaskService.forceComplete(java.lang.Long, java.lang.String, com.axelor.auth.db.User) so admin authorization is checked instead.

reject

public void reject(ActionRequest request,
 ActionResponse response)

Reject the task with a required comment, then resume the run (routing on the rejection is a downstream decision). Surfaces the service's required-comment error and keeps the popup open.

claim

public void claim(ActionRequest request,
 ActionResponse response)

Claim a pooled task for the current user.

reassign

public void reassign(ActionRequest request,
 ActionResponse response)

Reassign a pending task (admin or current assignee) to a new user/role/group.

cancel

public void cancel(ActionRequest request,
 ActionResponse response)

Cancel a pending task (admin only).