Package org.openiam.workflow.activiti.service

Interface ActivitiSearchTaskService

All Known Implementing Classes:

ActivitiSearchTaskServiceImpl

public interface ActivitiSearchTaskService

Interface to handle variations of search task

Method Summary

Modifier and Type	Method	Description
int	count(HistorySearchBean searchBean)
int	countCertificationTasks(HistorySearchBean searchBean)
int	countTasks(TaskSearchBean searchBean)
org.springframework.data.domain.Page<TaskWrapper>	findTasks(TaskSearchBean searchBean, int from, int size)
CampaignTaskListWrapper	getAccessCertificationCampaigns(AccessCertificationCampaignSearchBean searchBean, int from, int size)	Provide data for UAR page - stat information by campaign
CampaignStatsResponse	getAccessCertificationCampaignStats(AccessCertificationCampaignSearchBean searchBean)	Provides data for UAR page - Stat information about all cert tasks (new / in progress / completed) Search happens based on OR pattern of task name (used when call done from webconsole for all or selected campaign), OR based on requester (reviewer ID), also if reviewer ID is provided we check if they are UAR or Global UAR managers.
List<AccessCertificationHistoryObject>	getAccessCertificationHistoryForUserId(String userId, int from, int size)
List<AccessCertificationReminderData>	getAccessCertificationReminders(Date forDate)	Get a list of Access Certification Process instances to what we have to send reminders.
TaskListWrapper	getAccessCertificationTasks(HistorySearchBean searchBean, int from, int size)
UploadAttachment	getAttachmentBodyAsBase64String(String id)
List<ProcessInstanceComment>	getCommentForProcessInstanceIds(TaskSearchBean searchBean)	Count comments with different types for TaskSearchBean#getProcessInstanceIds()
List<String>	getCompletedProcessInstanceIds(Date completedBefore, Date completedAfter)
TaskListWrapper	getCompletedProcessInstances(HistorySearchBean historySearchBean, int from, int size)	Method return finished process instances by HistorySearchBean.
org.springframework.data.domain.Page<TaskWrapper>	getHistory(HistorySearchBean searchBean, int from, int size)
List<TaskHistoryWrapper>	getHistoryForInstance(String instanceId)
TaskListWrapper	getHistoryOfApprovals(String involvedUserId, int from, int size)	Method is used to get All tasks in which given user is involded
TaskListWrapper	getHistoryOfApprovals(HistorySearchBean historySearchBean, int from, int size)	Method is used to get All tasks in which given user is involded by HistorySearchBean filtering
int	getNumOfAssignedTasksWithFilter(String userId, String description, Date fromDate, Date toDate)
int	getNumOfCandidateTasksWithFilter(String userId, String description, Date fromDate, Date toDate)
TaskListWrapper	getPivotView(HistorySearchBean historySearchBean, int from, int size)	Provides data only for Pivot view.
List<UploadAttachment>	getProcessInstanceAttachments(String id)
List<AccessCertificationTaskComment>	getProcessInstanceComments(String processInstanceId, String type)
List<TaskResRequestedWithProcessInstanceIdWrapper>	getRequestedResources(TaskSearchBean searchBean)
List<TaskResRequestedWithProcessInstanceIdWrapper>	getRequestedResourcesForOpenAndCompletedTasks(TaskSearchBean searchBean)	this method returns requested resources for the task but for open and completed. is used for reporting for ex. access cert report
TaskResRequestedWrapper	getRequestedResourcesUserRelated(String taskId, Map<String,String> blockedRoles, Map<String,String> blockedGroups)
ReviewedAccessWrapper	getReviewedAccess(String procInstanceId)
TaskWrapper	getTask(String taskId)
TaskWrapper	getTaskFromHistory(String processInstanceId)
TaskWrapper	getTaskFromHistory(String executionId, String taskId)
TaskWrapper	getTaskInLastState(String processInstanceId)	Method query by taskId from tasks, if no any results, it tries to query from history (task maybe already finished).
TaskResRequestedWrapper	getTaskRequestedRes(String taskId, Map<String,String> blockedRoleIds, Map<String,String> blockedGroupIds)
TaskListWrapper	getTasksForAssignedUserWithFilter(String userId, int from, int size, String description, Date fromDate, Date toDate)
TaskListWrapper	getTasksForCandidateUserWithFilter(String userId, int from, int size, String description, Date fromDate, Date toDate)
TaskListWrapper	getTasksForUser(String userId, int from, int size)	Deprecated.

Method Detail

getTasksForCandidateUserWithFilter

TaskListWrapper getTasksForCandidateUserWithFilter(String userId,
                                                   int from,
                                                   int size,
                                                   String description,
                                                   Date fromDate,
                                                   Date toDate)

getTasksForAssignedUserWithFilter

TaskListWrapper getTasksForAssignedUserWithFilter(String userId,
                                                  int from,
                                                  int size,
                                                  String description,
                                                  Date fromDate,
                                                  Date toDate)

getNumOfAssignedTasksWithFilter

int getNumOfAssignedTasksWithFilter(String userId,
                                    String description,
                                    Date fromDate,
                                    Date toDate)

getNumOfCandidateTasksWithFilter

int getNumOfCandidateTasksWithFilter(String userId,
                                     String description,
                                     Date fromDate,
                                     Date toDate)

getTask

TaskWrapper getTask(String taskId)
             throws BasicDataServiceException

Throws:

BasicDataServiceException

getHistoryOfApprovals

TaskListWrapper getHistoryOfApprovals(String involvedUserId,
                                      int from,
                                      int size)

Method is used to get All tasks in which given user is involded

Parameters:

involvedUserId - - given user internal id

from - - first Element number

size - - size of the page

Returns:

- TaskListWrapper

getHistoryOfApprovals

TaskListWrapper getHistoryOfApprovals(HistorySearchBean historySearchBean,
                                      int from,
                                      int size)

Method is used to get All tasks in which given user is involded by HistorySearchBean filtering

Parameters:

historySearchBean - - search bean

from - - first Element number

size - - size of the page

Returns:

- TaskListWrapper

getTaskFromHistory

TaskWrapper getTaskFromHistory(String executionId,
                               String taskId)

getTaskInLastState

TaskWrapper getTaskInLastState(String processInstanceId)

Method query by taskId from tasks, if no any results, it tries to query from history (task maybe already finished).

Parameters:

processInstanceId - - id of the processInstance.

Returns:

TaskWrapper of task if found, return NULL if no any results.

getTaskRequestedRes

TaskResRequestedWrapper getTaskRequestedRes(String taskId,
                                            Map<String,String> blockedRoleIds,
                                            Map<String,String> blockedGroupIds)
                                     throws BasicDataServiceException

Throws:

BasicDataServiceException

getReviewedAccess

ReviewedAccessWrapper getReviewedAccess(String procInstanceId)
                                 throws BasicDataServiceException

Throws:

BasicDataServiceException

findTasks

org.springframework.data.domain.Page<TaskWrapper> findTasks(TaskSearchBean searchBean,
                                                            int from,
                                                            int size)

getCompletedProcessInstanceIds

List<String> getCompletedProcessInstanceIds(Date completedBefore,
                                            Date completedAfter)

countTasks

int countTasks(TaskSearchBean searchBean)

getHistory

org.springframework.data.domain.Page<TaskWrapper> getHistory(HistorySearchBean searchBean,
                                                             int from,
                                                             int size)

countCertificationTasks

int countCertificationTasks(HistorySearchBean searchBean)

getAccessCertificationTasks

TaskListWrapper getAccessCertificationTasks(HistorySearchBean searchBean,
                                            int from,
                                            int size)

getHistoryForInstance

List<TaskHistoryWrapper> getHistoryForInstance(String instanceId)

count

int count(HistorySearchBean searchBean)

getCompletedProcessInstances

TaskListWrapper getCompletedProcessInstances(HistorySearchBean historySearchBean,
                                             int from,
                                             int size)

Method return finished process instances by HistorySearchBean.

Parameters:

historySearchBean - - search bean for filtering

from - - 1st result

size - - number of entities to return

Returns:

list of entities wrapped by TaskListWrapper

getRequestedResourcesForOpenAndCompletedTasks

List<TaskResRequestedWithProcessInstanceIdWrapper> getRequestedResourcesForOpenAndCompletedTasks(TaskSearchBean searchBean)

this method returns requested resources for the task but for open and completed. is used for reporting for ex. access cert report

Parameters:

searchBean - contains process instance ids

Returns:

getCommentForProcessInstanceIds

List<ProcessInstanceComment> getCommentForProcessInstanceIds(TaskSearchBean searchBean)

Count comments with different types for TaskSearchBean#getProcessInstanceIds()

Parameters:

searchBean -

Returns:

ArrayList of ProcessInstanceComment

getTasksForUser

@Deprecated
TaskListWrapper getTasksForUser(String userId,
                                int from,
                                int size)

Deprecated.

getRequestedResources

List<TaskResRequestedWithProcessInstanceIdWrapper> getRequestedResources(TaskSearchBean searchBean)

getProcessInstanceComments

List<AccessCertificationTaskComment> getProcessInstanceComments(String processInstanceId,
                                                                String type)
                                                         throws BasicDataServiceException

Throws:

BasicDataServiceException

getAttachmentBodyAsBase64String

UploadAttachment getAttachmentBodyAsBase64String(String id)
                                          throws BasicDataServiceException

Throws:

BasicDataServiceException

getProcessInstanceAttachments

List<UploadAttachment> getProcessInstanceAttachments(String id)
                                              throws BasicDataServiceException

Throws:

BasicDataServiceException

getAccessCertificationHistoryForUserId

List<AccessCertificationHistoryObject> getAccessCertificationHistoryForUserId(String userId,
                                                                              int from,
                                                                              int size)

getAccessCertificationReminders

List<AccessCertificationReminderData> getAccessCertificationReminders(Date forDate)

Get a list of Access Certification Process instances to what we have to send reminders.

Parameters:

forDate - - before what date process Instances are required

Returns:

- list of AccessCertificationReminderData with data required for the reminders emails.

getPivotView

TaskListWrapper getPivotView(HistorySearchBean historySearchBean,
                             int from,
                             int size)

Provides data only for Pivot view. Dont reuse it if any changes are required.

Parameters:

historySearchBean - - search bean for filtering

from - - 1st result

size - - number of entities to return

Returns:

list of entities wrapped by TaskListWrapper

getAccessCertificationCampaigns

CampaignTaskListWrapper getAccessCertificationCampaigns(AccessCertificationCampaignSearchBean searchBean,
                                                        int from,
                                                        int size)

Provide data for UAR page - stat information by campaign

Parameters:

searchBean -

from -

size -

Returns:

list of access certification camaigns with information about required steps and status

getAccessCertificationCampaignStats

CampaignStatsResponse getAccessCertificationCampaignStats(AccessCertificationCampaignSearchBean searchBean)

Provides data for UAR page - Stat information about all cert tasks (new / in progress / completed) Search happens based on OR pattern of task name (used when call done from webconsole for all or selected campaign), OR based on requester (reviewer ID), also if reviewer ID is provided we check if they are UAR or Global UAR managers.

Parameters:

searchBean -

Returns:

getTaskFromHistory

TaskWrapper getTaskFromHistory(String processInstanceId)

getRequestedResourcesUserRelated

TaskResRequestedWrapper getRequestedResourcesUserRelated(String taskId,
                                                         Map<String,String> blockedRoles,
                                                         Map<String,String> blockedGroups)