/*
* eGov suite of products aim to improve the internal efficiency,transparency,
* accountability and the service delivery of the government organizations.
*
* Copyright (C) <2015> eGovernments Foundation
*
* The updated version of eGov suite of products as by eGovernments Foundation
* is available at http://www.egovernments.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/ or
* http://www.gnu.org/licenses/gpl.html .
*
* In addition to the terms of the GPL license to be adhered to in using this
* program, the following additional terms are to be complied with:
*
* 1) All versions of this program, verbatim or modified must carry this
* Legal Notice.
*
* 2) Any misrepresentation of the origin of the material is prohibited. It
* is required that all modified versions of this material be marked in
* reasonable ways as different from the original version.
*
* 3) This license does not grant any rights to any user of the program
* with regards to rights under trademark law for use of the trade names
* or trademarks of eGovernments Foundation.
*
* In case of any queries, you can reach eGovernments Foundation at contact@egovernments.org.
*/
package org.egov.collection.web.actions.reports;
import java.util.Date;
import java.util.List;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;
import org.egov.collection.constants.CollectionConstants;
import org.egov.collection.entity.OnlinePayment;
import org.egov.collection.utils.CollectionsUtil;
import org.egov.commons.EgwStatus;
import org.egov.infra.admin.master.entity.Department;
import org.egov.infra.reporting.engine.ReportConstants.FileFormat;
import org.egov.infra.reporting.engine.ReportRequest.ReportDataSourceType;
import org.egov.infra.web.struts.actions.ReportFormAction;
/**
* Action class for Online Trasaction Report
*/
@Results({
@Result(name = OnlineTransactionReportAction.INDEX, location = "onlineTransactionReport-index.jsp"),
@Result(name = OnlineTransactionReportAction.REPORT, location = "receiptRegisterReport-report.jsp") })
public class OnlineTransactionReportAction extends ReportFormAction {
private static final long serialVersionUID = 1L;
// Report parameter names
private static final String EGOV_DEPT_ID = "EGOV_DEPT_ID";
private static final String EGOV_FROM_DATE = "EGOV_FROM_DATE";
private static final String EGOV_TO_DATE = "EGOV_TO_DATE";
private static final String EGOV_BILLING_SERVICE_ID = "EGOV_BILLING_SERVICE_ID";
private static final String EGOV_ONLINETRANSACTION_STATUS_ID = "EGOV_ONLINETRANSACTION_STATUS_ID";
private CollectionsUtil collectionsUtil;
@Override
public void prepare() {
super.prepare();
setReportFormat(FileFormat.PDF);
setDataSourceType(ReportDataSourceType.SQL);
}
@Override
@Action(value = "/reports/onlineTransactionReport-criteria")
public String criteria() {
// Setup drop down data for department list
addRelatedEntity("department", Department.class, "name");
setupDropdownDataExcluding();
// Add dropdown data for billing services (serviceList)
addDropdownData(CollectionConstants.DROPDOWN_DATA_SERVICE_LIST,
collectionsUtil.getBillingServiceList());
addDropdownData(CollectionConstants.DROPDOWN_DATA_ONLINETRANSACTIONSTATUS_LIST, getOnlineReceiptStatuses());
// default value for from/to date = today
setReportParam(EGOV_FROM_DATE, new Date());
setReportParam(EGOV_TO_DATE, new Date());
return INDEX;
}
@Override
@Action(value = "/reports/onlineTransactionReport-report")
public String report() {
return super.report();
}
private List<EgwStatus> getOnlineReceiptStatuses() {
return persistenceService.findAllByNamedQuery(
CollectionConstants.QUERY_ALL_STATUSES_FOR_MODULE,
OnlinePayment.class.getSimpleName());
}
@Override
protected String getReportTemplateName() {
return CollectionConstants.REPORT_TEMPLATE_ONLINE_TRANSACTION;
}
/**
* @param collectionsUtil The collections util object
*/
public void setCollectionsUtil(final CollectionsUtil collectionsUtil) {
this.collectionsUtil = collectionsUtil;
}
/**
* @return the department id
*/
public Integer getDepartmentId() {
return (Integer) getReportParam(EGOV_DEPT_ID);
}
/**
* @param deptId the department id to set
*/
public void setDepartmentId(final Integer deptId) {
setReportParam(EGOV_DEPT_ID, deptId);
}
/**
* @return the from date
*/
public Date getFromDate() {
return (Date) getReportParam(EGOV_FROM_DATE);
}
/**
* @param fromDate the from date to set
*/
public void setFromDate(final Date fromDate) {
setReportParam(EGOV_FROM_DATE, fromDate);
}
/**
* @return the do date
*/
public Date getToDate() {
return (Date) getReportParam(EGOV_TO_DATE);
}
/**
* @param toDate the to date to set
*/
public void setToDate(final Date toDate) {
setReportParam(EGOV_TO_DATE, toDate);
}
/**
* @return The billing service id
*/
public Long getBillingServiceId() {
return (Long) getReportParam(EGOV_BILLING_SERVICE_ID);
}
/**
* @param billingServiceId The Billing service id to set
*/
public void setBillingServiceId(final Long challanServiceId) {
setReportParam(EGOV_BILLING_SERVICE_ID, challanServiceId);
}
public Long getStatusId() {
return (Long) getReportParam(EGOV_ONLINETRANSACTION_STATUS_ID);
}
public void setStatusId(final Long statusId) {
setReportParam(EGOV_ONLINETRANSACTION_STATUS_ID, statusId);
}
}