Package overit.geocallapp.wfm.core.bl.datacollection.template.visibilityrules.task

Class BTDataCollectionTemplateVisibleForUserSearch

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionTemplateVisibleForUserSearchEvent>

overit.geocallapp.wfm.core.bl.datacollection.template.visibilityrules.task.BTDataCollectionTemplateVisibleForUserSearch

All Implemented Interfaces:

Serializable, Tool

@Event(DataCollectionTemplateVisibleForUserSearchEvent.class)
public class BTDataCollectionTemplateVisibleForUserSearch
extends BusinessTask<DataCollectionTemplateVisibleForUserSearchEvent>

Business task for searching generable templates on mobile.

This task returns all the DC template IDs that the mobile user can use for generating Data Collections. A template is generable if:

• There isn't any visibility rule configured for the template, OR
• There is a rule row that matches the user profile

The matching logic for a rule is:

 if ( (userTypeList is empty OR userTypeList contains the userType)
   AND (operationCenterList is empty OR operationCenterList contains the operationCenter)
   AND (structuresList is empty OR structuresList contains the structure)
   AND (areaList is empty OR areaList contains the area) )
 then rule is valid
 

Since:

22.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Long>	userAreas
protected Set<Long>	userOperationCenters
protected Set<Long>	userStructures
protected Long	userType
protected overit.geocallapp.wfm.users.UserVisibilitySettings	visibilitySettings

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionTemplateVisibleForUserSearch()

Method Summary

Modifier and Type	Method	Description
protected void	body(DataCollectionTemplateVisibleForUserSearchEvent event, PoolKit poolKit)	Implements this method to write the specific task logic to handle the input parameter.
protected List<BODCTemplateVisibilityRuleRow>	collectMatchingRows(PoolKit poolKit)	Collects all the rows that match the user profile.
protected Set<Long>	getAreasFromOperationCenter(Long operationCenterId, PoolKit poolKit)
protected Set<Long>	getMatchingRulesTemplates(PoolKit poolKit)	Gets all the templates with visibility rules that match the user profile.
protected Long	getStructureFromOperationCenter(Long operationCenterId, PoolKit poolKit)
protected Set<Long>	getTemplateIdsFromRuleHeaders(Set<Long> validRuleHeaders, PoolKit poolKit)	Retrieves the template IDs associated with the given rule headers.
protected Set<Long>	getTemplatesWithoutRules(PoolKit poolKit)	Gets all the templates without visibility rules.
protected Set<Long>	getValidRuleHeaders(Map<Long,List<BODCTemplateVisibilityRuleRow>> groupedRows)	Finds the valid rule headers for the user organizational structures.
protected boolean	hasIntersection(Set<Long> ruleSet, Set<Long> userSet)	Checks if there is an intersection between the rule set and the user set.
protected void	loadUserOrganizationalStructures(Long userId, PoolKit poolKit)	Loads the user organizational structures that will be used for filtering the rules.
protected overit.geocallapp.wfm.users.UserVisibilitySettings	loadUserVisibilitySettings(Long userId, PooledConnection conn)	Loads the user visibility settings.
protected Set<Long>	searchRulesByArea(PoolKit poolKit)	Gets the rule headers that have a row that match the user areas
protected Set<Long>	searchRulesByOperationCenter(PoolKit poolKit)	Gets the rule headers that have a row that match the user operation centers
protected Set<Long>	searchRulesByStructure(PoolKit poolKit)	Gets the rule headers that have a row that match the user structures
protected Set<Long>	searchRulesByUserType(PoolKit poolKit)	Gets the rule headers that have a row that match the user type
protected void	validateUser(Long userId, PoolKit poolKit)	Validate the user id.

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Field Details

userOperationCenters

protected Set<Long> userOperationCenters

userStructures

protected Set<Long> userStructures

userAreas

protected Set<Long> userAreas

userType

protected Long userType

visibilitySettings

protected overit.geocallapp.wfm.users.UserVisibilitySettings visibilitySettings

Constructor Details

BTDataCollectionTemplateVisibleForUserSearch

public BTDataCollectionTemplateVisibleForUserSearch()

Method Details

body

protected void body(DataCollectionTemplateVisibleForUserSearchEvent event,
 PoolKit poolKit)
             throws DAException,
DAValidateException

Description copied from class: BusinessTask

Implements this method to write the specific task logic to handle the input parameter.

Specified by:

body in class BusinessTask<DataCollectionTemplateVisibleForUserSearchEvent>

Parameters:

event - the object upon which the task will works on

poolKit - the poolkit containing the reference to the database connection that can be used

Throws:

DAException - in case of database error

DAValidateException - in case of database validation error

validateUser

protected void validateUser(Long userId,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Validate the user id.

Parameters:

userId - the user id

Throws:

DAValidateException - if the user id is not valid

DAException

loadUserOrganizationalStructures

protected void loadUserOrganizationalStructures(Long userId,
 PoolKit poolKit)
                                         throws DAException,
DAValidateException

Loads the user organizational structures that will be used for filtering the rules.

Parameters:

userId - the user ID

poolKit - the PoolKit

Throws:

DAException - if a database error occurs

DAValidateException - if a validation error occurs

getStructureFromOperationCenter

protected Long getStructureFromOperationCenter(Long operationCenterId,
 PoolKit poolKit)
                                        throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getAreasFromOperationCenter

protected Set<Long> getAreasFromOperationCenter(Long operationCenterId,
 PoolKit poolKit)
                                         throws DAException

Throws:

DAException

loadUserVisibilitySettings

protected overit.geocallapp.wfm.users.UserVisibilitySettings loadUserVisibilitySettings(Long userId,
 PooledConnection conn)
                                                                                 throws DAException,
DAValidateException

Loads the user visibility settings.

Parameters:

userId - the user ID

Returns:

the user visibility settings

Throws:

DAException

DAValidateException

getTemplatesWithoutRules

protected Set<Long> getTemplatesWithoutRules(PoolKit poolKit)
                                      throws DAException,
DAValidateException

Gets all the templates without visibility rules.

Parameters:

poolKit - the pool kit

Returns:

the of templates id without rules

Throws:

DAException

DAValidateException

getMatchingRulesTemplates

protected Set<Long> getMatchingRulesTemplates(PoolKit poolKit)
                                       throws DAException,
DAValidateException

Gets all the templates with visibility rules that match the user profile.

Parameters:

poolKit - the PoolKit

Returns:

the set of templates id with matching rules

Throws:

DAException

DAValidateException

collectMatchingRows

protected List<BODCTemplateVisibilityRuleRow> collectMatchingRows(PoolKit poolKit)
                                                           throws DAException,
DAValidateException

Collects all the rows that match the user profile.

Parameters:

poolKit - the PoolKit

Returns:

the list of matching rows

Throws:

DAException

DAValidateException

getValidRuleHeaders

protected Set<Long> getValidRuleHeaders(Map<Long,List<BODCTemplateVisibilityRuleRow>> groupedRows)

Finds the valid rule headers for the user organizational structures.

Parameters:

groupedRows - the grouped rows

Returns:

the set of valid rule headers

hasIntersection

protected boolean hasIntersection(Set<Long> ruleSet,
 Set<Long> userSet)

Checks if there is an intersection between the rule set and the user set.

Parameters:

ruleSet - the rule set

userSet - the user set

Returns:

true if there is an intersection, false otherwise

getTemplateIdsFromRuleHeaders

protected Set<Long> getTemplateIdsFromRuleHeaders(Set<Long> validRuleHeaders,
 PoolKit poolKit)
                                           throws DAException,
DAValidateException

Retrieves the template IDs associated with the given rule headers.

Parameters:

validRuleHeaders - the set of valid rule headers

poolKit - the pool kit for database operations

Returns:

the set of template IDs

Throws:

DAException - if a database access error occurs

DAValidateException

searchRulesByUserType

protected Set<Long> searchRulesByUserType(PoolKit poolKit)
                                   throws DAException,
DAValidateException

Gets the rule headers that have a row that match the user type

Parameters:

poolKit - the PoolKit

Returns:

the set of valid rules headers

Throws:

DAException

DAValidateException

searchRulesByOperationCenter

protected Set<Long> searchRulesByOperationCenter(PoolKit poolKit)
                                          throws DAException,
DAValidateException

Gets the rule headers that have a row that match the user operation centers

Parameters:

poolKit - the PoolKit

Returns:

the set of valid rules headers

Throws:

DAException

DAValidateException

searchRulesByStructure

protected Set<Long> searchRulesByStructure(PoolKit poolKit)
                                    throws DAException,
DAValidateException

Gets the rule headers that have a row that match the user structures

Parameters:

poolKit - the PoolKit

Returns:

the set of valid rules headers

Throws:

DAException

DAValidateException

searchRulesByArea

protected Set<Long> searchRulesByArea(PoolKit poolKit)
                               throws DAException,
DAValidateException

Gets the rule headers that have a row that match the user areas

Parameters:

poolKit - the PoolKit

Returns:

the set of valid rules headers

Throws:

DAException

DAValidateException