org.egov.collection.utils

Class CollectionsUtil

java.lang.Object

org.egov.collection.utils.CollectionsUtil

public class CollectionsUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.egov.eis.service.AssignmentService	assignmentService
static SimpleDateFormat	CHEQUE_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
CollectionsUtil()

Method Summary

Modifier and Type	Method and Description
boolean	checkChallanValidity(Challan challan) This method checks if the given challan is valid.
Boolean	checkVoucherCreation(ReceiptHeader receiptHeader)
org.egov.infra.search.elastic.entity.CollectionIndex	constructCollectionIndex(ReceiptHeader receiptHeader)
org.egov.infra.reporting.engine.ReportOutput	createReport(org.egov.infra.reporting.engine.ReportRequest reportRequest)
void	emailReceiptAsAttachment(ReceiptHeader receiptHeader, byte[] attachment)
List	getAllCounters()
List<org.egov.commons.Fund>	getAllFunds()
List	getAllLocations()
List<org.egov.infra.admin.master.entity.Department>	getAllNonPrimaryAssignmentsOfLoggedInUser()
List<org.egov.infra.admin.master.entity.Department>	getAllNonPrimaryAssignmentsOfUser(org.egov.infra.admin.master.entity.User user)
List<org.egov.commons.EgwStatus>	getAllReceiptHeaderStatus() This method returns the List of EgwStatus for ReceiptHeader
String	getAppConfigValue(String moduleName, String key) This method returns the config value for the given module name and key
String	getAppConfigValue(String moduleName, String key, String defaultValue) This method returns the currently active config value for the given module name and key
List<org.egov.infra.admin.master.entity.AppConfigValues>	getAppConfigValues(String moduleName, String key) This method returns the list of config values for the given module name and key
String	getApproverName(org.egov.pims.commons.Position position)
Object	getBean(String beanName) Fetches given bean from application context
List	getBillingServiceList()
List	getChallanServiceList()
List<String>	getCollectionModesNotAllowed(org.egov.infra.admin.master.entity.User loggedInUser) This method returns the collection modes that are not allowed based on rules configured in the script
String	getDepartmentForWorkFlow()
org.egov.infra.admin.master.entity.Department	getDepartmentOfLoggedInUser()
org.egov.infra.admin.master.entity.Department	getDepartmentOfUser(org.egov.infra.admin.master.entity.User user)
List<org.egov.infra.admin.master.entity.Department>	getDepartmentsAllowedForChallanApproval(org.egov.infra.admin.master.entity.User loggedInUser, ReceiptHeader receiptHeaderObj)
String	getDesignationForThirdPartyUser()
List<org.egov.pims.commons.Designation>	getDesignationsAllowedForChallanApproval(Integer departmentId, ReceiptHeader receiptHeaderObj)
org.egov.pims.model.PersonalInformation	getEmployeeByDepartmentDesignationBoundaryandFunctionary(Long deptId, Long designationId, Integer boundaryId, Integer functionaryId) This method is invoked from the ReceiptHeader.workFlow script and returns Employee object for the given Department Id, Designation Id ,Boundary Id and FunctionaryId
org.egov.commons.CFinancialYear	getFinancialYearforDate(Date date) This method retrieves the CFinancialYear for the given date.
org.egov.infra.admin.master.entity.Location	getLocationById(Long locationId)
org.egov.infra.admin.master.entity.Location	getLocationOfUser(Map<String,Object> sessionMap)
org.egov.infra.admin.master.entity.User	getLoggedInUser() This method returns the User instance associated with the logged in user
String	getLoggedInUserName()
org.egov.infra.admin.master.entity.Department	getNonPrimaryDeptOfUser(org.egov.infra.admin.master.entity.User user)
List<OnlinePayment>	getOnlineTransactionHistory(String consumerCode)
org.egov.pims.commons.Position	getPositionByDeptDesgAndBoundary(org.egov.infra.admin.master.entity.Boundary boundary)
org.egov.pims.commons.Position	getPositionById(Long positionId) Gets position by given position id
org.egov.pims.commons.Position	getPositionByName(String positionName) Gets position by given position name
List<org.egov.eis.entity.EmployeeView>	getPositionBySearchParameters(String beginsWith, Integer desId, Integer deptId, Integer jurdId, Integer roleId, Date userDate, Integer maxResults)
org.egov.pims.commons.Position	getPositionforEmp(Integer employeeId) This method is invoked from the ReceiptHeader.workFlow script and returns the position for the employee id passed as parameter
org.egov.pims.commons.Position	getPositionOfUser(org.egov.infra.admin.master.entity.User user)
List	getReceiptCreators()
org.egov.commons.EgwStatus	getReceiptStatusForCode(String statusCode) Returns the Status object for given status code for a receipt
String	getReceiptTemplateName(char receiptType, String serviceCode)
List	getReceiptZoneList()
Date	getRemittanceVoucherDate(Date receiptDate)
org.egov.commons.EgwStatus	getStatusForModuleAndCode(String moduleName, String statusCode) This method returns the EgwStatus for the given module type and status code
List<org.egov.infra.admin.master.entity.AppConfigValues>	getThirdPartyUserRoles()
org.egov.infra.admin.master.entity.User	getUserById(Long userId)
org.egov.infra.admin.master.entity.User	getUserByUserName(String userName) This method returns the User instance for the userName passed as parameter
Boolean	getVoucherType()
Boolean	isEmployee(org.egov.infra.admin.master.entity.User user)
boolean	isPropertyTaxArrearAccountHead(String glcode, String description) This method checks if the given glcode belongs to an account head representing an arrear account head (for Property Tax).
boolean	isValidTemplate(String templateName)
List<ReceiptDetail>	reconstructReceiptDetail(ReceiptHeader receiptHeader, List<ReceiptDetail> receiptDetailList)
void	setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)
void	setReportService(org.egov.infra.reporting.engine.ReportService reportService)
void	setUserService(org.egov.infra.admin.master.service.UserService userService)

Methods inherited from class java.lang.Object

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

Field Detail

CHEQUE_DATE_FORMAT

public static final SimpleDateFormat CHEQUE_DATE_FORMAT

assignmentService

@Autowired
protected org.egov.eis.service.AssignmentService assignmentService

Constructor Detail

CollectionsUtil

public CollectionsUtil()

Method Detail

getReceiptStatusForCode

public org.egov.commons.EgwStatus getReceiptStatusForCode(String statusCode)

Returns the Status object for given status code for a receipt

Parameters:

statusCode - Status code for which status object is to be returned

Returns:

the Status object for given status code for a receipt

getStatusForModuleAndCode

public org.egov.commons.EgwStatus getStatusForModuleAndCode(String moduleName,
                                                            String statusCode)

This method returns the EgwStatus for the given module type and status code

Parameters:

moduleName - Module name of the required status

statusCode - Status code of the required status

Returns:

the EgwStatus instance

getAllReceiptHeaderStatus

public List<org.egov.commons.EgwStatus> getAllReceiptHeaderStatus()

This method returns the List of EgwStatus for ReceiptHeader

Returns:

the List of EgwStatus instance

getLoggedInUserName

public String getLoggedInUserName()

Parameters:

sessionMap - Map of session variables

Returns:

user name of currently logged in user

getLoggedInUser

public org.egov.infra.admin.master.entity.User getLoggedInUser()

This method returns the User instance associated with the logged in user

Parameters:

sessionMap - Map of session variables

Returns:

the logged in user

getDepartmentOfUser

public org.egov.infra.admin.master.entity.Department getDepartmentOfUser(org.egov.infra.admin.master.entity.User user)

Parameters:

user - the user whose department is to be returned

Returns:

department of the given user

getDepartmentOfLoggedInUser

public org.egov.infra.admin.master.entity.Department getDepartmentOfLoggedInUser()

Parameters:

sessionMap - map of session variables

Returns:

department of currently logged in user

getUserByUserName

public org.egov.infra.admin.master.entity.User getUserByUserName(String userName)

This method returns the User instance for the userName passed as parameter

Parameters:

userName -

Returns:

User

getLocationOfUser

public org.egov.infra.admin.master.entity.Location getLocationOfUser(Map<String,Object> sessionMap)

Parameters:

sessionMap - Map of session variables

Returns:

Location object for given user

getLocationById

public org.egov.infra.admin.master.entity.Location getLocationById(Long locationId)

getAllCounters

public List getAllCounters()

Returns:

list of all active counters

getChallanServiceList

public List getChallanServiceList()

Returns:

List of all collection services (service type = C)

getBillingServiceList

public List getBillingServiceList()

Returns:

List of all billing services

getReceiptCreators

public List getReceiptCreators()

Returns:

list of all users who have created at least one receipt

getReceiptZoneList

public List getReceiptZoneList()

Returns:

list of all zones that have receipts created

getCollectionModesNotAllowed

public List<String> getCollectionModesNotAllowed(org.egov.infra.admin.master.entity.User loggedInUser)

This method returns the collection modes that are not allowed based on rules configured in the script

Parameters:

loggedInUser - a User entity representing the logged in user.

Returns:

a List of String values representing the mode of payments supported.

isEmployee

public Boolean isEmployee(org.egov.infra.admin.master.entity.User user)

getThirdPartyUserRoles

public List<org.egov.infra.admin.master.entity.AppConfigValues> getThirdPartyUserRoles()

getDepartmentForWorkFlow

public String getDepartmentForWorkFlow()

getPositionByDeptDesgAndBoundary

public org.egov.pims.commons.Position getPositionByDeptDesgAndBoundary(org.egov.infra.admin.master.entity.Boundary boundary)

getDesignationForThirdPartyUser

public String getDesignationForThirdPartyUser()

getPositionOfUser

public org.egov.pims.commons.Position getPositionOfUser(org.egov.infra.admin.master.entity.User user)

Parameters:

sessionMap - Map of session variables

Returns:

Position of logged in user

getPositionByName

public org.egov.pims.commons.Position getPositionByName(String positionName)

Gets position by given position name

Parameters:

positionName - Position name

Returns:

Position object for given position name

getFinancialYearforDate

public org.egov.commons.CFinancialYear getFinancialYearforDate(Date date)

This method retrieves the CFinancialYear for the given date.

Parameters:

date - an instance of Date for which the financial year is to be retrieved.

Returns:

an instance of representing the financial year for the given date

checkChallanValidity

public boolean checkChallanValidity(Challan challan)

This method checks if the given challan is valid.

Parameters:

challan - the Challan instance whose validity has to be checked

Returns:

a boolean value - true indicating that the challan is valid and false indicating that teh challan is not valid

getBean

public Object getBean(String beanName)

Fetches given bean from application context

Parameters:

beanName - name of bean to be fetched

Returns:

given bean from application context

getAppConfigValue

public String getAppConfigValue(String moduleName,
                                String key,
                                String defaultValue)

This method returns the currently active config value for the given module name and key

Parameters:

moduleName - a String representing the module name

key - a String representing the key

defaultValue - Default value to be returned in case the key is not defined

Returns:

String representing the configuration value

getAppConfigValue

public String getAppConfigValue(String moduleName,
                                String key)

This method returns the config value for the given module name and key

Parameters:

moduleName - a String representing the module name

key - a String representing the key

Returns:

String representing the configuration value

getAppConfigValues

public List<org.egov.infra.admin.master.entity.AppConfigValues> getAppConfigValues(String moduleName,
                                                                                   String key)

This method returns the list of config values for the given module name and key

Parameters:

moduleName - a String representing the module name

key - a String representing the key

Returns:

List representing the list of configuration values

getPositionById

public org.egov.pims.commons.Position getPositionById(Long positionId)

Gets position by given position id

Parameters:

positionId - Position Id

Returns:

Position object for given position id

getPositionforEmp

public org.egov.pims.commons.Position getPositionforEmp(Integer employeeId)

This method is invoked from the ReceiptHeader.workFlow script and returns the position for the employee id passed as parameter

Parameters:

employeeId - PersonalInformation Id

Returns:

Position object for Employee Id passed as parameter

getEmployeeByDepartmentDesignationBoundaryandFunctionary

public org.egov.pims.model.PersonalInformation getEmployeeByDepartmentDesignationBoundaryandFunctionary(Long deptId,
                                                                                                        Long designationId,
                                                                                                        Integer boundaryId,
                                                                                                        Integer functionaryId)

This method is invoked from the ReceiptHeader.workFlow script and returns Employee object for the given Department Id, Designation Id ,Boundary Id and FunctionaryId

Parameters:

deptId - Department Id

designationId - Designation Id

boundaryId - Boundary Id

functionaryId - Functionary Id

Returns:

PersonalInformation

getAllNonPrimaryAssignmentsOfLoggedInUser

public List<org.egov.infra.admin.master.entity.Department> getAllNonPrimaryAssignmentsOfLoggedInUser()

Parameters:

sessionMap -

Returns:

getAllNonPrimaryAssignmentsOfUser

public List<org.egov.infra.admin.master.entity.Department> getAllNonPrimaryAssignmentsOfUser(org.egov.infra.admin.master.entity.User user)

Parameters:

user - the user whose non-primary department list is to be returned

Returns:

list of non-primary department of the given user

getNonPrimaryDeptOfUser

public org.egov.infra.admin.master.entity.Department getNonPrimaryDeptOfUser(org.egov.infra.admin.master.entity.User user)

Parameters:

user - the user whose non-primary department is to be returned

Returns:

non-primary department of the given user. In case user has multiple non-primary departments, the first one will be returned.

getDesignationsAllowedForChallanApproval

public List<org.egov.pims.commons.Designation> getDesignationsAllowedForChallanApproval(Integer departmentId,
                                                                                        ReceiptHeader receiptHeaderObj)

getDepartmentsAllowedForChallanApproval

public List<org.egov.infra.admin.master.entity.Department> getDepartmentsAllowedForChallanApproval(org.egov.infra.admin.master.entity.User loggedInUser,
                                                                                                   ReceiptHeader receiptHeaderObj)

isPropertyTaxArrearAccountHead

public boolean isPropertyTaxArrearAccountHead(String glcode,
                                              String description)

This method checks if the given glcode belongs to an account head representing an arrear account head (for Property Tax). The glcodes for such accounts are retrieved from App Config.

Parameters:

glcode - The Chart of Accounts Code

description - Description of the glcode

getPositionBySearchParameters

public List<org.egov.eis.entity.EmployeeView> getPositionBySearchParameters(String beginsWith,
                                                                            Integer desId,
                                                                            Integer deptId,
                                                                            Integer jurdId,
                                                                            Integer roleId,
                                                                            Date userDate,
                                                                            Integer maxResults)
                                                                     throws org.egov.commons.exception.NoSuchObjectException

Throws:

org.egov.commons.exception.NoSuchObjectException

getOnlineTransactionHistory

public List<OnlinePayment> getOnlineTransactionHistory(String consumerCode)

Parameters:

consumerCode -

Returns:

last three online transaction for the consumerCode

getAllLocations

public List getAllLocations()

Returns:

list of all active locations

getAllFunds

public List<org.egov.commons.Fund> getAllFunds()

Returns:

list of all fund

getUserById

public org.egov.infra.admin.master.entity.User getUserById(Long userId)

setUserService

public void setUserService(org.egov.infra.admin.master.service.UserService userService)

setPersistenceService

public void setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)

setReportService

public void setReportService(org.egov.infra.reporting.engine.ReportService reportService)

isValidTemplate

public boolean isValidTemplate(String templateName)

createReport

public org.egov.infra.reporting.engine.ReportOutput createReport(org.egov.infra.reporting.engine.ReportRequest reportRequest)

constructCollectionIndex

public org.egov.infra.search.elastic.entity.CollectionIndex constructCollectionIndex(ReceiptHeader receiptHeader)

checkVoucherCreation

public Boolean checkVoucherCreation(ReceiptHeader receiptHeader)

getApproverName

public String getApproverName(org.egov.pims.commons.Position position)

reconstructReceiptDetail

public List<ReceiptDetail> reconstructReceiptDetail(ReceiptHeader receiptHeader,
                                                    List<ReceiptDetail> receiptDetailList)

getRemittanceVoucherDate

public Date getRemittanceVoucherDate(Date receiptDate)

getVoucherType

public Boolean getVoucherType()

getReceiptTemplateName

public String getReceiptTemplateName(char receiptType,
                                     String serviceCode)

Parameters:

serviceCode - Billing service code for which the receipt template is to be returned

Returns:

Receipt template to be used for given billing service code.

emailReceiptAsAttachment

public void emailReceiptAsAttachment(ReceiptHeader receiptHeader,
                                     byte[] attachment)