org.kuali.kra.proposaldevelopment.budget.service.impl

Class BudgetSubAwardServiceImpl

java.lang.Object

org.kuali.kra.proposaldevelopment.budget.service.impl.BudgetSubAwardServiceImpl

All Implemented Interfaces:

BudgetSubAwardService

public class BudgetSubAwardServiceImpl
extends Object
implements BudgetSubAwardService

This class...

Constructor Summary

Constructors

Constructor and Description
BudgetSubAwardServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	cleanContentId(String contentId)
protected Element	copyElementToName(Element element, String tagName)
protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue	createHashValueType(String hashValueStr)
protected Map	extractAttachments(com.lowagie.text.pdf.PdfReader reader) extracts attachments from PDF File
protected BudgetPeriod	findBudgetPeriod(BudgetSubAwardPeriodDetail detail, Budget budget)
protected BudgetSubAwardPeriodDetail	findBudgetSubAwardPeriodDetail(Budget budget, BudgetSubAwards budgetSubAward, Date startDate, Date endDate) First find a budget period that matches the start and end date.
protected BudgetLineItem	findOrCreateLineItem(List<BudgetLineItem> lineItems, BudgetSubAwardPeriodDetail subAwardDetail, BudgetSubAwards subAward, BudgetPeriod budgetPeriod, String costElement)
protected List<BudgetLineItem>	findSubAwardLineItems(BudgetPeriod budgetPeriod, Integer subAwardNumber)
void	generateSubAwardLineItems(BudgetSubAwards subAward, Budget budget)
protected BudgetService	getBudgetService()
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected String	getLoggedInUserNetworkId() This method return loggedin user id
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue	getValue(byte[] fileBytes)
protected byte[]	getXMLFromPDF(com.lowagie.text.pdf.PdfReader reader) extracts XML from PDF
protected BudgetDecimal	lesserValue(BudgetDecimal num1, BudgetDecimal num2)
void	populateBudgetSubAwardAttachments(Budget budget) This method is to handle subaward attachments
void	populateBudgetSubAwardFiles(Budget budget, BudgetSubAwards subAward, String newFileName, byte[] newFileData) This method is to populate the subaward files
void	prepareBudgetSubAwards(Budget budget)
protected void	removeAllEmptyNodes(Document document, String xpath, int parentLevel)
void	removeSubAwardAttachment(BudgetSubAwards subAward)
void	setBudgetService(BudgetService budgetService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
protected static Object[]	unpackFile(com.lowagie.text.pdf.PdfReader reader, com.lowagie.text.pdf.PdfDictionary filespec) Unpacks a file attachment.
boolean	updateSubAwardBudgetDetails(Budget budget, BudgetSubAwards budgetSubAward, List<String[]> errors) Reads the XML from the PDF and parses out amounts from the budget periods.
protected BudgetSubAwards	updateXML(byte[] xmlContents, Map fileMap, BudgetSubAwards budgetSubAwardBean, Budget budget) updates the XMl with hashcode for the files

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetSubAwardServiceImpl

public BudgetSubAwardServiceImpl()

Method Detail

populateBudgetSubAwardFiles

public void populateBudgetSubAwardFiles(Budget budget,
                               BudgetSubAwards subAward,
                               String newFileName,
                               byte[] newFileData)

Description copied from interface: BudgetSubAwardService

This method is to populate the subaward files

Specified by:

populateBudgetSubAwardFiles in interface BudgetSubAwardService

See Also:

org.kuali.kra.proposaldevelopment.budget.service.BudgetSubAwardService#populateBudgetSubAwardFiles(org.kuali.kra.proposaldevelopment.budget.bo.BudgetSubAwards)

removeSubAwardAttachment

public void removeSubAwardAttachment(BudgetSubAwards subAward)

Specified by:

removeSubAwardAttachment in interface BudgetSubAwardService

prepareBudgetSubAwards

public void prepareBudgetSubAwards(Budget budget)

Specified by:

prepareBudgetSubAwards in interface BudgetSubAwardService

generateSubAwardLineItems

public void generateSubAwardLineItems(BudgetSubAwards subAward,
                             Budget budget)

Specified by:

generateSubAwardLineItems in interface BudgetSubAwardService

findBudgetPeriod

protected BudgetPeriod findBudgetPeriod(BudgetSubAwardPeriodDetail detail,
                            Budget budget)

lesserValue

protected BudgetDecimal lesserValue(BudgetDecimal num1,
                        BudgetDecimal num2)

findOrCreateLineItem

protected BudgetLineItem findOrCreateLineItem(List<BudgetLineItem> lineItems,
                                  BudgetSubAwardPeriodDetail subAwardDetail,
                                  BudgetSubAwards subAward,
                                  BudgetPeriod budgetPeriod,
                                  String costElement)

findSubAwardLineItems

protected List<BudgetLineItem> findSubAwardLineItems(BudgetPeriod budgetPeriod,
                                         Integer subAwardNumber)

getLoggedInUserNetworkId

protected String getLoggedInUserNetworkId()

This method return loggedin user id

getXMLFromPDF

protected byte[] getXMLFromPDF(com.lowagie.text.pdf.PdfReader reader)
                        throws Exception

extracts XML from PDF

Throws:

Exception

extractAttachments

protected Map extractAttachments(com.lowagie.text.pdf.PdfReader reader)
                          throws IOException

extracts attachments from PDF File

Throws:

IOException

unpackFile

protected static Object[] unpackFile(com.lowagie.text.pdf.PdfReader reader,
                  com.lowagie.text.pdf.PdfDictionary filespec)
                              throws IOException

Unpacks a file attachment.

Parameters:

reader - The object that reads the PDF document

filespec - The dictonary containing the file specifications

Throws:

IOException

updateSubAwardBudgetDetails

public boolean updateSubAwardBudgetDetails(Budget budget,
                                  BudgetSubAwards budgetSubAward,
                                  List<String[]> errors)
                                    throws Exception

Description copied from interface: BudgetSubAwardService

Reads the XML from the PDF and parses out amounts from the budget periods. Returns true if the process succeeded, possibly with warnings. Returns false if the process failed for any reason. The required list, errors, will be populated by a list of String arrays. Each array will contain at least one string, the error key for the message. Any other Strings in the array should be considered message parameters for that error message.

Specified by:

updateSubAwardBudgetDetails in interface BudgetSubAwardService

Returns:

Throws:

Exception

See Also:

BudgetSubAwardService.updateSubAwardBudgetDetails(org.kuali.kra.budget.core.Budget, org.kuali.kra.proposaldevelopment.budget.bo.BudgetSubAwards, java.util.List)

findBudgetSubAwardPeriodDetail

protected BudgetSubAwardPeriodDetail findBudgetSubAwardPeriodDetail(Budget budget,
                                                        BudgetSubAwards budgetSubAward,
                                                        Date startDate,
                                                        Date endDate)

First find a budget period that matches the start and end date. If that is found, find a subaward period detail with the same budget period number.

Parameters:

budget -

budgetSubAward -

startDate -

endDate -

Returns:

updateXML

protected BudgetSubAwards updateXML(byte[] xmlContents,
                        Map fileMap,
                        BudgetSubAwards budgetSubAwardBean,
                        Budget budget)
                             throws Exception

updates the XMl with hashcode for the files

Throws:

Exception

cleanContentId

protected String cleanContentId(String contentId)

populateBudgetSubAwardAttachments

public void populateBudgetSubAwardAttachments(Budget budget)

Description copied from interface: BudgetSubAwardService

This method is to handle subaward attachments

Specified by:

populateBudgetSubAwardAttachments in interface BudgetSubAwardService

removeAllEmptyNodes

protected void removeAllEmptyNodes(Document document,
                       String xpath,
                       int parentLevel)
                            throws TransformerException

Throws:

TransformerException

copyElementToName

protected Element copyElementToName(Element element,
                        String tagName)

getValue

protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue getValue(byte[] fileBytes)
                                                                          throws Exception

Throws:

Exception

createHashValueType

protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue createHashValueType(String hashValueStr)
                                                                                     throws Exception

Throws:

Exception

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

getBudgetService

protected BudgetService getBudgetService()

setBudgetService

public void setBudgetService(BudgetService budgetService)

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)