/*
* 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.web.struts;
import static org.kuali.kfs.module.tem.TemConstants.AMENDMENT_TA_QUESTION;
import static org.kuali.kfs.module.tem.TemConstants.AMEND_NOTE_PREFIX;
import static org.kuali.kfs.module.tem.TemConstants.AMEND_NOTE_SUFFIX;
import static org.kuali.kfs.module.tem.TemConstants.AMEND_TA_TEXT;
import static org.kuali.kfs.module.tem.TemConstants.CONFIRM_AMENDMENT_QUESTION;
import static org.kuali.kfs.module.tem.TemKeyConstants.ERROR_TA_REASON_PASTLIMIT;
import static org.kuali.kfs.module.tem.TemKeyConstants.ERROR_TA_REASON_REQUIRED;
import static org.kuali.kfs.module.tem.TemKeyConstants.TA_QUESTION_DOCUMENT;
import static org.kuali.kfs.sys.KFSConstants.BLANK_SPACE;
import static org.kuali.kfs.sys.KFSConstants.MAPPING_BASIC;
import static org.kuali.kfs.sys.KFSConstants.NOTE_TEXT_PROPERTY_NAME;
import static org.kuali.kfs.sys.KFSConstants.QUESTION_REASON_ATTRIBUTE_NAME;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.lang.StringUtils;
import org.kuali.kfs.module.tem.TemConstants.TravelAuthorizationStatusCodeKeys;
import org.kuali.kfs.module.tem.TemConstants.TravelDocTypes;
import org.kuali.kfs.module.tem.TemKeyConstants;
import org.kuali.kfs.module.tem.businessobject.AccountingDocumentRelationship;
import org.kuali.kfs.module.tem.businessobject.ActualExpense;
import org.kuali.kfs.module.tem.document.TravelAuthorizationAmendmentDocument;
import org.kuali.kfs.module.tem.document.TravelAuthorizationDocument;
import org.kuali.kfs.module.tem.document.TravelDocument;
import org.kuali.kfs.module.tem.document.service.AccountingDocumentRelationshipService;
import org.kuali.kfs.module.tem.document.service.TravelDocumentService;
import org.kuali.kfs.module.tem.service.TravelExpenseService;
import org.kuali.kfs.module.tem.service.TravelService;
import org.kuali.kfs.sys.KFSConstants;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.rice.core.api.config.property.ConfigurationService;
import org.kuali.rice.kew.api.KewApiServiceLocator;
import org.kuali.rice.kew.api.document.attribute.DocumentAttributeIndexingQueue;
import org.kuali.rice.kim.api.identity.principal.Principal;
import org.kuali.rice.kim.api.services.KimApiServiceLocator;
import org.kuali.rice.krad.bo.Note;
import org.kuali.rice.krad.dao.DocumentDao;
import org.kuali.rice.krad.document.Document;
import org.kuali.rice.krad.exception.ValidationException;
import org.kuali.rice.krad.service.DataDictionaryService;
import org.kuali.rice.krad.service.DocumentService;
import org.kuali.rice.krad.service.NoteService;
import org.kuali.rice.krad.util.ObjectUtils;
import org.springframework.transaction.annotation.Transactional;
/**
*
*/
@Transactional
public class AmendQuestionHandler implements QuestionHandler<TravelDocument> {
protected ConfigurationService ConfigurationService;
protected DataDictionaryService dataDictionaryService;
protected TravelService travelService;
protected TravelDocumentService travelDocumentService;
protected TravelExpenseService travelExpenseService;
protected DocumentService documentService;
protected DocumentDao documentDao;
protected AccountingDocumentRelationshipService accountingDocumentRelationshipService;
protected NoteService noteService;
@Override
public <T> T handleResponse(final Inquisitive<TravelDocument,?> asker) throws Exception {
if (asker.denied(AMENDMENT_TA_QUESTION)) {
return (T) asker.back();
}
else if (asker.confirmed(CONFIRM_AMENDMENT_QUESTION)) {
return (T) asker.end();
// This is the case when the user clicks on "OK" in the end.
// After we inform the user that the close has been rerouted, we'll redirect to the portal page.
}
TravelDocument document = asker.getDocument();
// Build out full message.
String note = createNote(asker.getReason(), document.getDocumentNumber());
final StringBuilder noteText = new StringBuilder(note);
int noteTextLength = noteText.length();
// Get note text max length from DD.
int noteTextMaxLength = getDataDictionaryService().getAttributeMaxLength(Note.class, NOTE_TEXT_PROPERTY_NAME).intValue();
if (StringUtils.isBlank(asker.getReason()) || (noteTextLength > noteTextMaxLength)) {
// Figure out exact number of characters that the user can enter.
int reasonLimit = noteTextMaxLength - noteTextLength;
reasonLimit = reasonLimit<0?reasonLimit*-1:reasonLimit;
String message = getMessageFrom(TA_QUESTION_DOCUMENT);
String question = StringUtils.replace(message, "{0}", AMEND_TA_TEXT);
if (StringUtils.isBlank(asker.getReason())){
return (T) asker.confirm(AMENDMENT_TA_QUESTION, question, true, ERROR_TA_REASON_REQUIRED,QUESTION_REASON_ATTRIBUTE_NAME,AMEND_TA_TEXT);
}
else {
return (T) asker.confirm(AMENDMENT_TA_QUESTION, question, true, ERROR_TA_REASON_PASTLIMIT, QUESTION_REASON_ATTRIBUTE_NAME, new Integer(reasonLimit).toString());
}
}
// String previousDocumentId = ((StrutsInquisitor) asker).getForm().getDocId();
String previousDocumentId = null;
try {
// Below used as a place holder to allow code to specify actionForward to return if not a 'success question'
T returnActionForward = null;
returnActionForward = (T) ((StrutsInquisitor) asker).getMapping().findForward(MAPPING_BASIC);
final Note newNote = getDocumentService().createNoteFromDocument(document, noteText.toString());
newNote.setNoteText(noteText.toString());
getNoteService().save(newNote);
document.updateAndSaveAppDocStatus(TravelAuthorizationStatusCodeKeys.PEND_AMENDMENT);
TravelAuthorizationAmendmentDocument taaDocument = ((TravelAuthorizationDocument) document).toCopyTAA();
Note secondNote = getDocumentService().createNoteFromDocument(document, getMessageFrom(TemKeyConstants.TA_MESSAGE_AMEND_DOCUMENT_TEXT));
Principal systemUser = KimApiServiceLocator.getIdentityService().getPrincipalByPrincipalName(KFSConstants.SYSTEM_USER);
secondNote.setAuthorUniversalIdentifier(systemUser.getPrincipalId());
document.addNote(secondNote);
final DocumentAttributeIndexingQueue documentAttributeIndexingQueue = KewApiServiceLocator.getDocumentAttributeIndexingQueue();
documentAttributeIndexingQueue.indexDocument(document.getDocumentNumber());
TravelAuthorizationForm form = (TravelAuthorizationForm) ((StrutsInquisitor) asker).getForm();
form.setDocTypeName(TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT);
form.setDocument(taaDocument);
addActualExpenseNewDetailLines(form);
taaDocument.setApplicationDocumentStatus(TravelAuthorizationStatusCodeKeys.CHANGE_IN_PROCESS);
//save the TAA document once so it will not be lost
getDocumentService().saveDocument(taaDocument);
// add relationship
String documentType = document instanceof TravelAuthorizationAmendmentDocument ? TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT : TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT;
String relationDescription = documentType + " - " + TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT;
accountingDocumentRelationshipService.save(new AccountingDocumentRelationship(document.getDocumentNumber(), taaDocument.getDocumentNumber(), relationDescription));
// add an additional relationship to the original TA
if (documentType.equals(TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT)){
relationDescription = TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT + " - " + TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT;
List<Document> travelAuthDocs = travelDocumentService.getDocumentsRelatedTo(document, TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT);
//there should only be one travel auth document
accountingDocumentRelationshipService.save(new AccountingDocumentRelationship(travelAuthDocs.get(0).getDocumentNumber(), taaDocument.getDocumentNumber(), relationDescription));
}
if (ObjectUtils.isNotNull(returnActionForward)) {
return returnActionForward;
}
else {
String message = getMessageFrom(TA_QUESTION_DOCUMENT);
String question = StringUtils.replace(message, "{0}", AMEND_TA_TEXT);
return (T) asker.confirm(AMENDMENT_TA_QUESTION, question, true, "temSingleConfirmationQuestion", AMENDMENT_TA_QUESTION, "");
}
}
catch (ValidationException ve) {
throw ve;
}
}
protected String createNote(String reason, String documentNumber) {
String introNoteMessage = AMEND_NOTE_PREFIX + BLANK_SPACE;
String suffix = StringUtils.replace(AMEND_NOTE_SUFFIX, "{0}", documentNumber);
return introNoteMessage + reason + BLANK_SPACE + suffix;
}
@Override
public <T> T askQuestion(final Inquisitive<TravelDocument,?> asker) throws Exception {
final String key = getMessageFrom(TA_QUESTION_DOCUMENT);
final String question = StringUtils.replace(key, "{0}", AMEND_TA_TEXT);
T retval = (T) asker.confirm(AMENDMENT_TA_QUESTION, question,true);
return retval;
}
public String getReturnToFiscalOfficerQuestion(final String operation) {
String message = "";
//final String key = getConfigurationService().getPropertyValueAsString(TR_FISCAL_OFFICER_QUESTION);
final String key = getConfigurationService().getPropertyValueAsString(TA_QUESTION_DOCUMENT);
message = StringUtils.replace(key, "{0}", operation);
// Ask question if not already asked.
return message;
}
public String getMessageFrom(final String messageType) {
return getConfigurationService().getPropertyValueAsString(messageType);
}
public String getReturnToFiscalOfficerNote(final String notePrefix, String reason) {
String noteText = "";
// Have to check length on value entered.
final String introNoteMessage = notePrefix + BLANK_SPACE;
// Build out full message.
noteText = introNoteMessage + reason;
final int noteTextLength = noteText.length();
// Get note text max length from DD.
final int noteTextMaxLength = getDataDictionaryService().getAttributeMaxLength(Note.class, NOTE_TEXT_PROPERTY_NAME).intValue();
if (StringUtils.isBlank(reason) || (noteTextLength > noteTextMaxLength)) {
// Figure out exact number of characters that the user can enter.
int reasonLimit = noteTextMaxLength - noteTextLength;
if (ObjectUtils.isNull(reason)) {
// Prevent a NPE by setting the reason to a blank string.
reason = "";
}
}
return noteText;
}
/**
* Creates a new detail line for each actual expense on the document
* @param form the TravelAuthForm to copy expense detail lines on
*/
protected void addActualExpenseNewDetailLines(TravelAuthorizationForm form) {
form.setNewActualExpenseLines(new ArrayList<ActualExpense>());
for (ActualExpense actualExpense : form.getTravelAuthorizationDocument().getActualExpenses()) {
ActualExpense detail = getTravelExpenseService().createNewDetailForActualExpense(actualExpense);
form.getNewActualExpenseLines().add(detail);
}
}
/**
* Sets the ConfigurationService attribute.
*
* @return Returns the ConfigurationService.
*/
public void setConfigurationService(final ConfigurationService ConfigurationService) {
this.ConfigurationService = ConfigurationService;
}
/**
* Gets the ConfigurationService attribute.
*
* @return Returns the ConfigurationService.
*/
protected ConfigurationService getConfigurationService() {
return ConfigurationService;
}
/**
* Sets the travelService attribute.
*
* @return Returns the travelService.
*/
public void setTravelService(final TravelService travelService) {
this.travelService = travelService;
}
/**
* Gets the travelService attribute.
*
* @return Returns the travelService.
*/
protected TravelService getTravelService() {
return travelService;
}
/**
* Sets the dataDictionaryService attribute.
*
* @return Returns the dataDictionaryService.
*/
public void setDataDictionaryService(final DataDictionaryService dataDictionaryService) {
this.dataDictionaryService = dataDictionaryService;
}
/**
* Gets the dataDictionaryService attribute.
*
* @return Returns the dataDictionaryService.
*/
protected DataDictionaryService getDataDictionaryService() {
return dataDictionaryService;
}
public DocumentDao getDocumentDao() {
return documentDao;
}
public void setDocumentDao(DocumentDao documentDao) {
this.documentDao = documentDao;
}
/**
* Sets the documentService attribute.
*
* @return Returns the documentService.
*/
public void setDocumentService(final DocumentService documentService) {
this.documentService = documentService;
}
/**
* Gets the documentService attribute.
*
* @return Returns the documentService.
*/
protected DocumentService getDocumentService() {
return SpringContext.getBean(DocumentService.class);
}
public AccountingDocumentRelationshipService getAccountingDocumentRelationshipService() {
return accountingDocumentRelationshipService;
}
public void setAccountingDocumentRelationshipService(AccountingDocumentRelationshipService accountingDocumentRelationshipService) {
this.accountingDocumentRelationshipService = accountingDocumentRelationshipService;
}
public void setTravelDocumentService(TravelDocumentService travelDocumentService) {
this.travelDocumentService = travelDocumentService;
}
public NoteService getNoteService() {
return noteService;
}
public void setNoteService(NoteService noteService) {
this.noteService = noteService;
}
public TravelExpenseService getTravelExpenseService() {
return travelExpenseService;
}
public void setTravelExpenseService(TravelExpenseService travelExpenseService) {
this.travelExpenseService = travelExpenseService;
}
}