org.kuali.kra.printing.xmlstream

Interface XmlStream

All Known Implementing Classes:

AbstractResearchAndRelatedStream, AwardBaseStream, AwardBudgetBaseStream, AwardBudgetHierarchyXmlStream, AwardBudgetHistoryTransaction, AwardBudgetHistoryTransactionXmlStream, AwardDeltaXmlStream, AwardNoticeXmlStream, AwardTemplateXmlStream, BudgetBaseSalaryStream, BudgetBaseStream, BudgetCumilativeXmlStream, BudgetSalaryXmlStream, BudgetSummaryTotalXmlStream, BudgetSummaryXmlStream, BudgetTotalXmlStream, CoiCertificationXmlStream, CommitteeXmlStream, CorrespondenceXmlStream, CorrespondenceXmlStreamBase, CurrentAndPendingBaseStream, CurrentProposalXmlStream, IacucCommitteeXmlStream, IacucCorrespondenceXmlStream, IacucProtocolSummaryXmlStream, IacucProtocolXmlStream, IacucRenewalReminderStream, IacucScheduleXmlStream, IndustrialBudgetXmlStream, IndustrialCumBudgetXmlStream, InstitutionalProposalBaseStream, InstitutionalProposalXmlStream, MoneyAndEndDatesHistoryXmlStream, NegotiationActivityXmlStream, NIHResearchAndRelatedXmlStream, PendingProposalXmlStream, PrintBaseXmlStream, PrintCertificationXmlStream, ProposalBaseStream, ProposalDevelopmentXmlStream, ProposalLogXmlStream, ProposalSubmissionXmlStream, ProtocolSummaryXmlStream, ProtocolSummaryXmlStreamBase, ProtocolXmlStream, ProtocolXmlStreamBase, QuestionnaireXmlStream, RenewalReminderStream, RenewalReminderStreamBase, ReportTrackingXmlStream, ResearchAndRelatedXmlStream, ScheduleXmlStream, SubawardXmlStream

public interface XmlStream

This class is used for generating XML stream for report generation of any document like AwardDocument, BudgetDocument etc

Author:

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,org.apache.xmlbeans.XmlObject>	generateXmlStream(KraPersistableBusinessObjectBase printableBusinessObject, Map<String,Object> reportParameters) This method generates XML for a given ResearchDocumentBase based on the parameters provided in a Map and returns an XmlObject of the generated XML.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Getter for BusinessObjectService
org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Setter for BusinessObjectService
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Method Detail

generateXmlStream

Map<String,org.apache.xmlbeans.XmlObject> generateXmlStream(KraPersistableBusinessObjectBase printableBusinessObject,
                                                          Map<String,Object> reportParameters)

This method generates XML for a given ResearchDocumentBase based on the parameters provided in a Map and returns an XmlObject of the generated XML.

Parameters:

printableBusinessObject - for which XMl is to be generated

reportParameters - Map of various parameters required for XML generation

Returns:

Map consisting of XML Objects mapped to bookmarks

Throws:

PrintingException - in case of any errors occur during report generation

getBusinessObjectService

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

Getter for BusinessObjectService

Returns:

BusinessObjectService

setBusinessObjectService

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

Setter for BusinessObjectService

Parameters:

businessObjectService -

getDateTimeService

org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

Returns:

the dateTimeService

setDateTimeService

void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Parameters:

dateTimeService - the dateTimeService to set