/*
* The Kuali Financial System, a comprehensive financial management system for higher education.
*
* Copyright 2005-2014 The Kuali Foundation
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.kuali.kfs.module.tem.document.maintenance;
import static org.kuali.kfs.module.tem.TemConstants.EMP_TRAVELER_TYP_CD;
import static org.kuali.kfs.module.tem.TemConstants.NONEMP_TRAVELER_TYP_CD;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import org.kuali.kfs.integration.ar.AccountsReceivableCustomer;
import org.kuali.kfs.integration.ar.AccountsReceivableCustomerAddress;
import org.kuali.kfs.integration.ar.AccountsReceivableModuleService;
import org.kuali.kfs.module.ar.ArKeyConstants;
import org.kuali.kfs.module.tem.TemConstants;
import org.kuali.kfs.module.tem.TemPropertyConstants;
import org.kuali.kfs.module.tem.TemWorkflowConstants;
import org.kuali.kfs.module.tem.businessobject.TemProfile;
import org.kuali.kfs.module.tem.businessobject.TemProfileAccount;
import org.kuali.kfs.module.tem.document.authorization.TemProfileAuthorizer;
import org.kuali.kfs.module.tem.service.TemProfileService;
import org.kuali.kfs.module.tem.service.TravelerService;
import org.kuali.kfs.sys.KFSConstants;
import org.kuali.kfs.sys.KFSPropertyConstants;
import org.kuali.kfs.sys.businessobject.ChartOrgHolder;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.document.FinancialSystemMaintainable;
import org.kuali.kfs.sys.document.FinancialSystemMaintenanceDocument;
import org.kuali.kfs.sys.service.FinancialSystemUserService;
import org.kuali.rice.core.api.datetime.DateTimeService;
import org.kuali.rice.kew.api.exception.WorkflowException;
import org.kuali.rice.kim.api.identity.Person;
import org.kuali.rice.kns.document.MaintenanceDocument;
import org.kuali.rice.krad.bo.DocumentHeader;
import org.kuali.rice.krad.bo.Note;
import org.kuali.rice.krad.bo.PersistableBusinessObject;
import org.kuali.rice.krad.exception.AuthorizationException;
import org.kuali.rice.krad.service.DocumentService;
import org.kuali.rice.krad.service.KRADServiceLocator;
import org.kuali.rice.krad.service.NoteService;
import org.kuali.rice.krad.service.SequenceAccessorService;
import org.kuali.rice.krad.util.GlobalVariables;
import org.kuali.rice.krad.util.ObjectUtils;
public class TemProfileMaintainable extends FinancialSystemMaintainable {
private static final Logger LOG = Logger.getLogger(TemProfileMaintainable.class);
protected transient TemProfileAuthorizer authorizer;
/**
* This will create a new profile from either a principal id or from a customer number depending on what got filled out
*
*
* @see org.kuali.rice.kns.maintenance.Maintainable#setupNewFromExisting()
*/
@Override
public void processAfterNew(MaintenanceDocument document, Map<String,String[]> parameters) {
super.processAfterNew(document, parameters);
TravelerService travelerService = SpringContext.getBean(TravelerService.class);
SequenceAccessorService sas = SpringContext.getBean(SequenceAccessorService.class);
TemProfile temProfile = (TemProfile) super.getBusinessObject();
Integer profileId = temProfile.getProfileId();
if(ObjectUtils.isNull(profileId)) {
Integer newProfileId = sas.getNextAvailableSequenceNumber(TemConstants.TEM_PROFILE_SEQ_NAME).intValue();
temProfile.setProfileId(newProfileId);
}
String principalId = "";
if (parameters.containsKey(KFSPropertyConstants.PRINCIPAL_ID)) {
principalId = parameters.get(KFSPropertyConstants.PRINCIPAL_ID)[0];
if(StringUtils.isNotBlank(principalId)) {
//we want to set the principal
final Person person = getPersonService().getPerson(principalId);
temProfile.setPrincipal(person);
temProfile.setPrincipalId(principalId);
if(travelerService.isKimPersonEmployee(person)) {
temProfile.setTravelerTypeCode(EMP_TRAVELER_TYP_CD);
} else {
temProfile.setTravelerTypeCode(NONEMP_TRAVELER_TYP_CD);
}
// set the profile's chart/org for permission check
String primaryDeptCode[] = person.getPrimaryDepartmentCode().split("-");
if(primaryDeptCode != null && primaryDeptCode.length == 2){
temProfile.setHomeDeptChartOfAccountsCode(primaryDeptCode[0]);
temProfile.setHomeDeptOrgCode(primaryDeptCode[1]);
}
// is this user the current user & we have edit own tem profile perm? or if this user isn't the current user, do we have edit all profiles perm? If not, then we're going to throw an exception
final Person currentUser = GlobalVariables.getUserSession().getPerson();
if (!(doesProfilePrincipalMatchCurrentUser(principalId) && getTemProfileAuthorizer().canEditOwnProfile(document, currentUser)) && !(getTemProfileAuthorizer().canCreateAnyProfile(document, currentUser))) {
throw new AuthorizationException(currentUser.getPrincipalName(),
TemConstants.Permission.EDIT_ANY_PROFILE,
this.getClass().getSimpleName());
}
}
}
String customerNumber = "";
if (parameters.containsKey(TemPropertyConstants.TemProfileProperties.CUSTOMER_NUMBER)) {
customerNumber = parameters.get(TemPropertyConstants.TemProfileProperties.CUSTOMER_NUMBER)[0];
if(StringUtils.isNotBlank(customerNumber)) {
//we want to set the customer
AccountsReceivableCustomer person = getAccountsReceivableModuleService().findCustomer(customerNumber);
temProfile.setCustomer(person);
temProfile.setCustomerNumber(customerNumber);
if(travelerService.isCustomerEmployee(person)) {
temProfile.setTravelerTypeCode(EMP_TRAVELER_TYP_CD);
} else {
temProfile.setTravelerTypeCode(NONEMP_TRAVELER_TYP_CD);
}
// set the profile to the current user's chart/org for perm check
final Person currentUser = GlobalVariables.getUserSession().getPerson();
final ChartOrgHolder chartOrg = SpringContext.getBean(FinancialSystemUserService.class).getPrimaryOrganization(currentUser, TemConstants.NAMESPACE);
temProfile.setHomeDeptChartOfAccountsCode(chartOrg.getChartOfAccountsCode());
temProfile.setHomeDeptOrgCode(chartOrg.getOrganizationCode());
// does the current user have the ability to initiate all tem profiles? if not, throw an exception
if (!(getTemProfileAuthorizer().canCreateAnyProfile(document, currentUser))) {
throw new AuthorizationException(currentUser.getPrincipalName(),
TemConstants.Permission.EDIT_ANY_PROFILE,
this.getClass().getSimpleName());
}
}
}
travelerService.populateTemProfile(temProfile);
if (document.isNew()) {
if (StringUtils.isNotBlank(principalId)) {
document.getDocumentHeader().setDocumentDescription(trimDescription(TemConstants.NEW_TEM_PROFILE_DESCRIPTION_PREFIX + temProfile.getPrincipal().getName()));
}
else if (StringUtils.isNotBlank(customerNumber)) {
document.getDocumentHeader().setDocumentDescription(trimDescription(TemConstants.NEW_TEM_PROFILE_DESCRIPTION_PREFIX + temProfile.getCustomer().getCustomerName()));
}
}
}
/**
* Determines if the currently logged in user is the given principal
* @param principalId the principal to check
* @return true if the principal id belongs to the currently logged in user, false otherwise
*/
protected boolean doesProfilePrincipalMatchCurrentUser(String principalId) {
final Person currentUser = GlobalVariables.getUserSession().getPerson();
if (currentUser == null) {
return false; // no current user? weird. But no, you can't initialize profiles, you no one!
}
return StringUtils.equals(principalId, currentUser.getPrincipalId());
}
/**
* Populate the TemProfile details
*
* @param profile
*/
protected void populateInfo(TemProfile profile) {
SpringContext.getBean(TravelerService.class).populateTemProfile(profile);
SpringContext.getBean(TemProfileService.class).updateACHAccountInfo(profile);
}
/**
* @see org.kuali.rice.kns.maintenance.KualiMaintainableImpl#processAfterEdit(org.kuali.rice.kns.document.MaintenanceDocument, java.util.Map)
*/
@Override
public void processAfterEdit(MaintenanceDocument document, Map<String, String[]> parameters) {
populateInfo((TemProfile)document.getOldMaintainableObject().getBusinessObject());
populateInfo((TemProfile)document.getNewMaintainableObject().getBusinessObject());
super.processAfterEdit(document, parameters);
}
@Override
public void doRouteStatusChange(DocumentHeader documentHeader) {
super.doRouteStatusChange(documentHeader);
if (documentHeader.getWorkflowDocument().isProcessed()){
TemProfile temProfile = (TemProfile) super.getBusinessObject();
if(NONEMP_TRAVELER_TYP_CD.equals(temProfile.getTravelerTypeCode())) {
updateCustomerContactInformation(temProfile);
}
}
}
protected void updateCustomerContactInformation(TemProfile temProfile) {
AccountsReceivableCustomer customer = temProfile.getCustomer();
if (!ObjectUtils.isNull(customer) && !ObjectUtils.isNull(customer.getAccountsReceivableCustomerAddresses()) && !customer.getAccountsReceivableCustomerAddresses().isEmpty()) {
for(AccountsReceivableCustomerAddress customerAddress : customer.getAccountsReceivableCustomerAddresses()) {
if(ArKeyConstants.CustomerConstants.CUSTOMER_ADDRESS_TYPE_CODE_PRIMARY.equals(customerAddress.getAccountsReceivableCustomerAddressType().getCustomerAddressTypeCode())) {
customerAddress.setCustomerLine1StreetAddress(temProfile.getTemProfileAddress().getStreetAddressLine1());
customerAddress.setCustomerLine2StreetAddress(temProfile.getTemProfileAddress().getStreetAddressLine2());
customerAddress.setCustomerCityName(temProfile.getTemProfileAddress().getCityName());
customerAddress.setCustomerStateCode(temProfile.getTemProfileAddress().getStateCode());
customerAddress.setCustomerZipCode(temProfile.getTemProfileAddress().getZipCode());
customerAddress.setCustomerCountryCode(temProfile.getTemProfileAddress().getCountryCode());
customerAddress.setCustomerEmailAddress(temProfile.getEmailAddress());
getAccountsReceivableModuleService().saveCustomer(temProfile.getCustomer());
}
}
customer.setCustomerPhoneNumber(temProfile.getPhoneNumber());
customer.setCustomerEmailAddress(temProfile.getEmailAddress());
getAccountsReceivableModuleService().saveCustomer(temProfile.getCustomer());
}
}
/**
*
* @see org.kuali.kfs.sys.document.FinancialSystemMaintainable#answerSplitNodeQuestion(java.lang.String)
*/
@Override
protected boolean answerSplitNodeQuestion(String nodeName) throws UnsupportedOperationException {
if (nodeName.equals(TemWorkflowConstants.TAX_MANAGER_REQUIRED)) {
return taxManagerRequiredRouting();
}
if (nodeName.equals(TemWorkflowConstants.REQUIRES_TRAVELER_REVIEW)) {
return travelerRequiredRouting();
}
if (nodeName.equals(TemWorkflowConstants.REQUIRES_PROFILE_REVIEW)) {
// routes to profile review under the same circumstance as traveler.
return travelerRequiredRouting();
}
throw new UnsupportedOperationException("Cannot answer split question for this node you call \"" + nodeName + "\"");
}
/**
* Overriding to return - TemProfile doesn't need this
*
* @see org.kuali.kfs.sys.document.FinancialSystemMaintainable#populateChartOfAccountsCodeFields()
*/
@Override
protected void populateChartOfAccountsCodeFields() {
}
/**
*
* This method returns true if:<br/>
* When editing a profile
* 1. The non-resident alien property has changed<br/>
* 2. The citizenship property has changed<br/>
* When creating a new profile
* 3. The non-resident alien property is set<br/>
* 4. The citizenship is not US or blank<br/>
* @return
*/
protected boolean taxManagerRequiredRouting() {
TemProfile newTemProfile = (TemProfile) getParentMaintDoc().getNewMaintainableObject().getBusinessObject();
TemProfile oldTemProfile = (TemProfile) getParentMaintDoc().getOldMaintainableObject().getBusinessObject();
//edit profile
if (ObjectUtils.isNotNull(oldTemProfile.getProfileId())) {
// If NRA changed, route to tax manager
if (!newTemProfile.getNonResidentAlien().equals(oldTemProfile.getNonResidentAlien())) {
return true;
}
// If citizenship changed, route to tax manager
if (!StringUtils.equalsIgnoreCase(newTemProfile.getCitizenship(), oldTemProfile.getCitizenship())) {
return true;
}
}
//new profile
else {
// If NRA is selected, route to tax manager
if (newTemProfile.getNonResidentAlien()) {
return true;
}
//if citizenship is something other than US or blank, route to tax manager
if (!StringUtils.isBlank(newTemProfile.getCitizenship()) && !newTemProfile.getCitizenship().equals(KFSConstants.COUNTRY_CODE_UNITED_STATES)) {
return true;
}
}
return false;
}
protected boolean travelerRequiredRouting() {
TemProfile newTemProfile = (TemProfile) getParentMaintDoc().getNewMaintainableObject().getBusinessObject();
String initiator = getParentMaintDoc().getDocumentHeader().getWorkflowDocument().getInitiatorPrincipalId();
if (newTemProfile.getPrincipalId() != null &&!newTemProfile.getPrincipalId().equals(initiator)) {
return true;
}
return false;
}
protected FinancialSystemMaintenanceDocument getParentMaintDoc() {
FinancialSystemMaintenanceDocument maintDoc = null;
try {
maintDoc = (FinancialSystemMaintenanceDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(getDocumentNumber());
}
catch (WorkflowException e) {
throw new RuntimeException(e);
}
return maintDoc;
}
@Override
protected void refreshReferences(String referencesToRefresh) {
//make call to super
super.refreshReferences( removeReferenceFromString(referencesToRefresh, "temProfileAddress") );
}
/**
* Removes a named reference from a referencesToRefresh string
*/
protected String removeReferenceFromString(String referencesToRefresh, String referenceToRemove){
String newReference = referencesToRefresh;
if(ObjectUtils.isNotNull(newReference)){
int index = newReference.indexOf(referenceToRemove);
if(index != -1){
//remove from beginning
if(index == 0){
String suffix = "";
//add comma at end since there is more after this word
if(newReference.length() != referenceToRemove.length()){
suffix = ",";
}
newReference = referencesToRefresh.replaceAll("temProfileAddress" + suffix, "");
}else{
//removing from middle to end... either way, comma will be in front
newReference = referencesToRefresh.replaceAll("," + "temProfileAddress", "");
}
}
}
return newReference;
}
/**
*
* This method trims the descriptionText to 40 characters.
* @param descriptionText
* @return
*/
protected String trimDescription(String descriptionText) {
if (descriptionText.length() > 40) {
descriptionText = descriptionText.substring(0, 39);
}
return descriptionText;
}
/**
* Reference getDocumentService.createNoteFromDocument
*
* This method creates a note on the maintenance doc indicating that a AR Customer record has been generated.
* @param temProfile
* @return
*/
protected Note addCustomerCreatedNote(TemProfile temProfile) {
String text = "AR Customer ID " + temProfile.getCustomer().getCustomerNumber() + " has been generated";
Note note = new Note();
note.setNotePostedTimestamp(SpringContext.getBean(DateTimeService.class).getCurrentTimestamp());
note.setVersionNumber(Long.valueOf(1));
note.setNoteText(text);
note.setNoteTypeCode(KFSConstants.NoteTypeEnum.BUSINESS_OBJECT_NOTE_TYPE.getCode());
Person kualiUser = GlobalVariables.getUserSession().getPerson();
note = getNoteService().createNote(note, temProfile, kualiUser.getPrincipalId());
return note;
}
/**
* @see org.kuali.rice.kns.maintenance.KualiMaintainableImpl#getNewCollectionLine(java.lang.String)
*/
@Override
public PersistableBusinessObject getNewCollectionLine( String collectionName ) {
PersistableBusinessObject addLine = super.getNewCollectionLine(collectionName);
if (collectionName.equals("accounts")){
TemProfileAccount account = (TemProfileAccount) addLine;
TemProfile temProfile = (TemProfile) super.getBusinessObject();
account.setProfile(temProfile);
return account;
}
return addLine;
}
protected AccountsReceivableModuleService getAccountsReceivableModuleService() {
return SpringContext.getBean(AccountsReceivableModuleService.class);
}
public NoteService getNoteService(){
return KRADServiceLocator.getNoteService();
}
/**
* @return an authorizer we can ask TemProfile specific questions of
*/
protected TemProfileAuthorizer getTemProfileAuthorizer() {
if (this.authorizer == null) {
authorizer = (TemProfileAuthorizer)getDocumentHelperService().getDocumentAuthorizer(TemConstants.TravelDocTypes.TRAVEL_PROFILE_DOCUMENT);
}
return authorizer;
}
}