org.kuali.kra.protocol.actions.correspondence

Class ProtocolActionsCorrespondenceBase

java.lang.Object

org.kuali.kra.printing.print.AbstractPrint

org.kuali.kra.protocol.actions.correspondence.ProtocolActionsCorrespondenceBase

All Implemented Interfaces:

Serializable, Printable

Direct Known Subclasses:

AbstractProtocolActionsCorrespondence, IacucProtocolActionsCorrespondence

public abstract class ProtocolActionsCorrespondenceBase
extends AbstractPrint

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProtocolActionsCorrespondenceBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getAdministratorType()
abstract CorrespondenceXmlStreamBase	getCorrespondenceXmlStream()
String	getLeadUnitNumber()
protected abstract String	getModuleNameSpace()
protected abstract ProtocolPrintWatermarkBase	getNewProtocolPrintWatermarkInstanceHook()
KraPersistableBusinessObjectBase	getPrintableBusinessObject() Fetches the ResearchDocumentBase
ProtocolBase	getProtocol()
abstract String	getProtocolActionType() This method returns the appropriate protocol action type, such as ProtocolActionType.ASSIGN_TO_AGENDA.
protected abstract ProtocolActionTypeToCorrespondenceTemplateService	getProtocolActionTypeToCorrespondenceTemplateService()
String	getProtoCorrespTypeCode() This method returns the protocol correspondence type code of the first template associated the action of the sub class.
Watermarkable	getWatermarkable() This method for getting watermark for protocol correspondence PDF.
List<Source>	getXSLTemplates() This method provides a way to get the XSL Transform(s) for the KC generated XML.
boolean	isWatermarkEnabled() This method is to enable watermark in correspondence.
Map<String,byte[]>	renderXML() This method generates the XML that conforms to Delta Report XSD returns it as InputStream
void	setProtocol(ProtocolBase protcol)

Methods inherited from class org.kuali.kra.printing.print.AbstractPrint

getAttachments, getBytes, getReportParameters, getXmlStream, getXSLTemplateWithBookmarks, setAttachments, setPrintableBusinessObject, setReportParameters, setXmlStream

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolActionsCorrespondenceBase

public ProtocolActionsCorrespondenceBase()

Method Detail

setProtocol

public void setProtocol(ProtocolBase protcol)

getProtocol

public ProtocolBase getProtocol()

getPrintableBusinessObject

public KraPersistableBusinessObjectBase getPrintableBusinessObject()

Description copied from class: AbstractPrint

Fetches the ResearchDocumentBase

Specified by:

getPrintableBusinessObject in interface Printable

Overrides:

getPrintableBusinessObject in class AbstractPrint

Returns:

ResearchDocumentBase document

getProtocolActionTypeToCorrespondenceTemplateService

protected abstract ProtocolActionTypeToCorrespondenceTemplateService getProtocolActionTypeToCorrespondenceTemplateService()

getProtocolActionType

public abstract String getProtocolActionType()

This method returns the appropriate protocol action type, such as ProtocolActionType.ASSIGN_TO_AGENDA.

Returns:

a string that is a ProtocolActionType

getXSLTemplates

public List<Source> getXSLTemplates()

Description copied from interface: Printable

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.

Specified by:

getXSLTemplates in interface Printable

Overrides:

getXSLTemplates in class AbstractPrint

getProtoCorrespTypeCode

public String getProtoCorrespTypeCode()

This method returns the protocol correspondence type code of the first template associated the action of the sub class. If there are no templates, returns an empty String.

Returns:

a String

renderXML

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

Description copied from class: AbstractPrint

This method generates the XML that conforms to Delta Report XSD returns it as InputStream

Specified by:

renderXML in interface Printable

Overrides:

renderXML in class AbstractPrint

Returns:

InputStream of generated XML

Throws:

PrintingException - in case of any errors occur during XML generation

getCorrespondenceXmlStream

public abstract CorrespondenceXmlStreamBase getCorrespondenceXmlStream()

isWatermarkEnabled

public boolean isWatermarkEnabled()

This method is to enable watermark in correspondence. Overriding AbstractPrint method isWatermarkEnabled()

Specified by:

isWatermarkEnabled in interface Printable

Overrides:

isWatermarkEnabled in class AbstractPrint

Returns:

boolean

See Also:

Printable.isWatermarkEnabled()

getWatermarkable

public Watermarkable getWatermarkable()

This method for getting watermark for protocol correspondence PDF. Overriding AbstractPrint method getWatermarkable

Specified by:

getWatermarkable in interface Printable

Overrides:

getWatermarkable in class AbstractPrint

Returns:

prtocolPrintWatermark

getNewProtocolPrintWatermarkInstanceHook

protected abstract ProtocolPrintWatermarkBase getNewProtocolPrintWatermarkInstanceHook()

getLeadUnitNumber

public String getLeadUnitNumber()

getAdministratorType

protected abstract String getAdministratorType()

getModuleNameSpace

protected abstract String getModuleNameSpace()