org.kuali.kra.printing

Interface Printable

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractPrint, AbstractProtocolActionsCorrespondence, AssignToAgendaCorrespondence, AwardBudgetHierarchyPrint, AwardBudgetHistoryTransactionPrint, AwardDeltaPrint, AwardNoticePrint, AwardReportTracking, AwardTemplatePrint, BudgetCostShareSummaryPrint, BudgetCumulativePrint, BudgetSalaryPrint, BudgetSummaryPrint, BudgetSummaryTotalPrint, BudgetTotalPrint, CoiBatchCorrespondencePrint, CoiCertificationPrint, CoiCorrespondenceTemplatePrint, CoiTemplatePrint, CommitteeFutureScheduledMeetingsPrint, CommitteeRosterPrint, CommitteeTemplatePrint, CurrentProposalPrint, GenericPrintable, GrantExemptionCorrespondence, IacucCommitteeFutureScheduledMeetingsPrint, IacucCommitteeRosterPrint, IacucCommitteeTemplatePrint, IacucProtocolActionsCorrespondence, IacucProtocolBatchCorrespondencePrint, IacucProtocolCorrespondenceTemplatePrint, IacucProtocolFullProtocolPrint, IacucProtocolHistoryPrint, IacucProtocolReviewCommentsPrint, IacucProtocolSummaryViewPrint, IacucScheduleTemplatePrint, IacucWithdrawCorrespondence, IndustrialBudgetPrint, IndustrialCumulativeBudgetPrint, InstitutionalProposalPrint, MoneyAndEndDatesHistoryPrint, NegotiationActivityprint, PendingProposalPrint, PrintCertificationPrint, ProposalLogPrint, ProposalSponsorFormsPrint, ProtocolActionsCorrespondenceBase, ProtocolBatchCorrespondencePrint, ProtocolCorrespondenceTemplatePrint, ProtocolFullProtocolPrint, ProtocolFullProtocolPrintBase, ProtocolGenericCorrespondence, ProtocolHistoryPrint, ProtocolHistoryPrintBase, ProtocolReportPrint, ProtocolReportPrintBase, ProtocolReviewCommentsPrint, ProtocolReviewCommentsPrintBase, ProtocolSummaryViewPrint, ProtocolSummaryViewPrintBase, QuestionnairePrint, ReportTrackingPrint, S2SFormPrint, ScheduleTemplatePrint, ScheduleTemplatePrintBase, SubAwardSF294Print, SubAwardSF295Print, TemplatePrint, TemplatePrint, TemplatePrintBase, WithdrawCorrespondence

public interface Printable
extends Serializable

This interface marks reports, notifications, BOs and Documents as printable in Kuali-Coeus. KC Docs & BOs that will be printed via KC printing services should implement this interface.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,byte[]>	getAttachments() This method will return the PDF attachments specific to the printable.
KraPersistableBusinessObjectBase	getPrintableBusinessObject() This method will provide the document object associated with the printable
Watermarkable	getWatermarkable() This method for setting the appropriate watermark with respect to the document.
List<Source>	getXSLTemplates() This method provides a way to get the XSL Transform(s) for the KC generated XML.
Map<String,Source>	getXSLTemplateWithBookmarks()
boolean	isWatermarkEnabled() This method returns whether to enable or disable watermark in the report.
Map<String,byte[]>	renderXML() This method will provide the either reflected or XML-Bean based XML for input to the Transform into XML-FO.

Method Detail

getXSLTemplates

List<Source> getXSLTemplates()

This method provides a way to get the XSL Transform(s) for the KC generated XML. This XSLT will create a transformed XML-FO stream that will be converted to PDF. Note that multiple transforms are possible on this data.

getXSLTemplateWithBookmarks

Map<String,Source> getXSLTemplateWithBookmarks()

renderXML

Map<String,byte[]> renderXML()
                             throws PrintingException

This method will provide the either reflected or XML-Bean based XML for input to the Transform into XML-FO.

Throws:

PrintingException

getPrintableBusinessObject

KraPersistableBusinessObjectBase getPrintableBusinessObject()

This method will provide the document object associated with the printable

Returns:

ResearchDocument

getAttachments

Map<String,byte[]> getAttachments()

This method will return the PDF attachments specific to the printable. During printing the attachments will be added as bookmarks to the output. The Key in the map is used as the name of the bookmark.

Returns:

Map of Attachment pdf bytes with bookmark names.

isWatermarkEnabled

boolean isWatermarkEnabled()

This method returns whether to enable or disable watermark in the report.

Returns:

boolean Value

getWatermarkable

Watermarkable getWatermarkable()

This method for setting the appropriate watermark with respect to the document.

Returns:

Watermarkable