org.kuali.kra.protocol.correspondence

Interface ProtocolCorrespondenceTemplateService

All Known Subinterfaces:

IacucProtocolCorrespondenceTemplateService, ProtocolCorrespondenceTemplateService

All Known Implementing Classes:

IacucProtocolCorrespondenceTemplateServiceImpl, ProtocolCorrespondenceTemplateServiceImpl, ProtocolCorrespondenceTemplateServiceImpl

public interface ProtocolCorrespondenceTemplateService

The ProtocolBase Correspondence Template Service provides a set of methods for working with protocol correspondence templates.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommitteeProtocolCorrespondenceTemplate(ProtocolCorrespondenceTypeBase correspondenceType, ProtocolCorrespondenceTemplateBase correspondenceTemplate) This method adds a committee specific ProtocolCorrespondenceTemplateBase.
void	addDefaultProtocolCorrespondenceTemplate(ProtocolCorrespondenceTypeBase correspondenceType, ProtocolCorrespondenceTemplateBase correspondenceTemplate) This method adds a default ProtocolCorrespondenceTemplateBase.
ProtocolCorrespondenceTemplateBase	getProtocolCorrespondenceTemplate(String committeeId, String protoCorrespTypeCode) This method is to get the correspondence template for the protoCorrespondenceType and the committeeId specified.
void	saveProtocolCorrespondenceTemplates(List<ProtocolCorrespondenceTypeBase> protocolCorrespondenceTypes, List<ProtocolCorrespondenceTemplateBase> deletedBos) This method saves the correspondence templates.

Method Detail

addDefaultProtocolCorrespondenceTemplate

void addDefaultProtocolCorrespondenceTemplate(ProtocolCorrespondenceTypeBase correspondenceType,
                                            ProtocolCorrespondenceTemplateBase correspondenceTemplate)
                                              throws Exception

This method adds a default ProtocolCorrespondenceTemplateBase.

Parameters:

correspondenceType - - the protocol correspondence type to which the template is to be added.

correspondenceTemplate - - the protocol correspondence template to be added.

Throws:

Exception

addCommitteeProtocolCorrespondenceTemplate

void addCommitteeProtocolCorrespondenceTemplate(ProtocolCorrespondenceTypeBase correspondenceType,
                                              ProtocolCorrespondenceTemplateBase correspondenceTemplate)
                                                throws Exception

This method adds a committee specific ProtocolCorrespondenceTemplateBase.

Parameters:

correspondenceType - - the protocol correspondence type to which the template is to be added.

correspondenceTemplate - - the protocol correspondence template to be added.

Throws:

Exception

saveProtocolCorrespondenceTemplates

void saveProtocolCorrespondenceTemplates(List<ProtocolCorrespondenceTypeBase> protocolCorrespondenceTypes,
                                       List<ProtocolCorrespondenceTemplateBase> deletedBos)

This method saves the correspondence templates.

Parameters:

protocolCorrespondenceTypes - - the list of protocolCorrespondenceTypes with templates to be saved to the database..

deletedBos - - the list of protocolCorrespondenceTemplates that are to be deleted from the database.

getProtocolCorrespondenceTemplate

ProtocolCorrespondenceTemplateBase getProtocolCorrespondenceTemplate(String committeeId,
                                                                   String protoCorrespTypeCode)

This method is to get the correspondence template for the protoCorrespondenceType and the committeeId specified. If it is not found for this committee, then retrieve from 'DEFAULT'

Parameters:

committeeId -

protoCorrespTypeCode -

Returns: