org.kuali.kra.common.committee.service.impl

Class CommitteeBatchCorrespondenceServiceImplBase

java.lang.Object

org.kuali.kra.common.committee.service.impl.CommitteeBatchCorrespondenceServiceImplBase

All Implemented Interfaces:

CommitteeBatchCorrespondenceServiceBase

Direct Known Subclasses:

CommitteeBatchCorrespondenceServiceImpl, IacucCommitteeBatchCorrespondenceServiceImpl

public abstract class CommitteeBatchCorrespondenceServiceImplBase
extends Object
implements CommitteeBatchCorrespondenceServiceBase

This class generates the batch correspondence of committees.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected org.kuali.rice.krad.service.DocumentService	documentService
protected int	finalActionCounter
protected KcEmailService	kcEmailService
protected KcNotificationService	kcNotificationService
protected KcPersonService	kcPersonService
protected static org.apache.commons.logging.Log	LOG
protected ProtocolCorrespondenceTemplateService	protocolCorrespondenceTemplateService
protected ProtocolDao<? extends ProtocolBase>	protocolDao
protected ProtocolGenericActionService	protocolGenericActionService

Constructor Summary

Constructors

Constructor and Description
CommitteeBatchCorrespondenceServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	applyFinalAction(ProtocolBase protocol, BatchCorrespondenceBase batchCorrespondence)
protected boolean	correspondencePreviouslyGenerated(ProtocolBase protocol, ProtocolCorrespondenceTypeBase protocolCorrespondenceType) This method determines if the notification for the protocol has already been generated.
protected ProtocolActionBase	createAndSaveProtocolAction(ProtocolBase protocol, ProtocolCorrespondenceTypeBase protocolCorrespondenceType, String protocolActionTypeCode) This method creates the ProtocolActionBase business object and persists it to the database.
protected ProtocolCorrespondence	createAndSaveProtocolCorrespondence(String committeeId, ProtocolBase protocol, ProtocolCorrespondenceTypeBase protocolCorrespondenceType, ProtocolActionBase protocolAction) This method creates the ProtocolCorrespondence business object and persists it to the database.
protected CommitteeBatchCorrespondenceDetailBase	createBatchCorrespondenceDetail(String committeeId, ProtocolBase protocol, ProtocolCorrespondenceTypeBase protocolCorrespondenceType, String committeeBatchCorrespondenceId, String protocolActionTypeCode) This method creates the CommitteeBatchCorrespondenceDetailBase and all associated business objects.
abstract CommitteeBatchCorrespondenceBase	generateBatchCorrespondence(String batchCorrespondenceTypeCode, String committeeId, Date startDate, Date endDate) This method generates the batch correspondence of a committee.
protected ProtocolCorrespondenceTypeBase	getAfterProtocolCorrespondenceTypeToGenerate(ProtocolBase protocol, BatchCorrespondenceBase batchCorrespondence) This method assists with determining what ProtocolCorrespondenceTypeBase is applicable to be generated at this time for correspondences that are to be send after the event.
protected abstract Class<? extends BatchCorrespondenceBase>	getBatchCorrespondenceBOClassHook()
protected ProtocolCorrespondenceTypeBase	getBeforeProtocolCorrespondenceTypeToGenerate(ProtocolBase protocol, BatchCorrespondenceBase batchCorrespondence) This method assists with determining what ProtocolCorrespondenceTypeBase is applicable to be generated at this time for correspondences that are to be send before the event.
protected abstract CommitteePrintingServiceBase	getCommitteePrintingService()
protected List<EmailAttachment>	getEmailAttachments(ProtocolCorrespondence protocolCorrespondence)
protected abstract CommitteeBatchCorrespondenceDetailBase	getNewCommitteeBatchCorrespondenceDetailInstanceHook()
protected abstract ProtocolActionBase	getNewProtocolActionInstanceHook(ProtocolBase protocol, Object object, String protocolActionTypeCode)
protected abstract ProtocolCorrespondence	getNewProtocolCorrespondenceInstanceHook()
protected abstract Class<? extends ProtocolCorrespondence>	getProtocolCorrespondenceBOClassHook()
protected ProtocolCorrespondenceTypeBase	getProtocolCorrespondenceTypeToGenerate(ProtocolBase protocol, BatchCorrespondenceBase batchCorrespondence) This method determines if and for which ProtocolCorrespondenceTypeBase a batch correspondence needs to be generated.
ProtocolDao<? extends ProtocolBase>	getProtocolDao()
protected BatchCorrespondenceBase	lookupBatchCorrespondence(String batchCorrespondenceTypeCode) This method looks up the BatchCorrespondenceBase business object via the batchCorrespondenceTypeCode.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Populated by Spring Beans.
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Populated by Spring Beans.
void	setKcNotificationService(KcNotificationService kcNotificationService) Populated by Spring Beans.
void	setKcPersonService(KcPersonService kcPersonService) Populated by Spring Beans.
void	setProtocolCorrespondenceTemplateService(ProtocolCorrespondenceTemplateService protocolCorrespondenceTemplateService) Populated by Spring Beans.
void	setProtocolDao(ProtocolDao<? extends ProtocolBase> protocolDao)
void	setProtocolGenericActionService(ProtocolGenericActionService protocolGenericActionService) Populated by Spring Beans.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

protocolDao

protected ProtocolDao<? extends ProtocolBase> protocolDao

protocolGenericActionService

protected ProtocolGenericActionService protocolGenericActionService

protocolCorrespondenceTemplateService

protected ProtocolCorrespondenceTemplateService protocolCorrespondenceTemplateService

documentService

protected org.kuali.rice.krad.service.DocumentService documentService

kcPersonService

protected KcPersonService kcPersonService

kcNotificationService

protected KcNotificationService kcNotificationService

kcEmailService

protected KcEmailService kcEmailService

finalActionCounter

protected int finalActionCounter

Constructor Detail

CommitteeBatchCorrespondenceServiceImplBase

public CommitteeBatchCorrespondenceServiceImplBase()

Method Detail

generateBatchCorrespondence

public abstract CommitteeBatchCorrespondenceBase generateBatchCorrespondence(String batchCorrespondenceTypeCode,
                                                           String committeeId,
                                                           Date startDate,
                                                           Date endDate)
                                                                      throws Exception

Description copied from interface: CommitteeBatchCorrespondenceServiceBase

This method generates the batch correspondence of a committee.

Specified by:

generateBatchCorrespondence in interface CommitteeBatchCorrespondenceServiceBase

Returns:

CommitteeBatchCorrespondenceBase

Throws:

Exception

getProtocolCorrespondenceTypeToGenerate

protected ProtocolCorrespondenceTypeBase getProtocolCorrespondenceTypeToGenerate(ProtocolBase protocol,
                                                                     BatchCorrespondenceBase batchCorrespondence)
                                                                          throws Exception

This method determines if and for which ProtocolCorrespondenceTypeBase a batch correspondence needs to be generated. The final action is being applied at this time as well.

Parameters:

protocol -

batchCorrespondence -

Returns:

The ProtocolCorrespondeceType for which correspondence needs to be generated. Null if no correspondence needs to be generated.

Throws:

Exception

getBeforeProtocolCorrespondenceTypeToGenerate

protected ProtocolCorrespondenceTypeBase getBeforeProtocolCorrespondenceTypeToGenerate(ProtocolBase protocol,
                                                                           BatchCorrespondenceBase batchCorrespondence)
                                                                                throws Exception

This method assists with determining what ProtocolCorrespondenceTypeBase is applicable to be generated at this time for correspondences that are to be send before the event.

Parameters:

protocol -

batchCorrespondence -

Returns:

The ProtocolCorrespondenceTypeBase for which correspondence may be generated at this time. Null if no correspondence needs to be generated.

Throws:

Exception

getAfterProtocolCorrespondenceTypeToGenerate

protected ProtocolCorrespondenceTypeBase getAfterProtocolCorrespondenceTypeToGenerate(ProtocolBase protocol,
                                                                          BatchCorrespondenceBase batchCorrespondence)
                                                                               throws Exception

This method assists with determining what ProtocolCorrespondenceTypeBase is applicable to be generated at this time for correspondences that are to be send after the event.

Parameters:

protocol -

batchCorrespondence -

Returns:

The ProtocolCorrespondenceTypeBase for which correspondence may be generated at this time. Null if no correspondence needs to be generated.

Throws:

Exception

applyFinalAction

protected abstract void applyFinalAction(ProtocolBase protocol,
                    BatchCorrespondenceBase batchCorrespondence)
                                  throws Exception

Throws:

Exception

correspondencePreviouslyGenerated

protected boolean correspondencePreviouslyGenerated(ProtocolBase protocol,
                                        ProtocolCorrespondenceTypeBase protocolCorrespondenceType)

This method determines if the notification for the protocol has already been generated.

Parameters:

protocol -

protocolCorrespondenceType -

Returns:

true if the correspondence has already been generated, false otherwise

getProtocolCorrespondenceBOClassHook

protected abstract Class<? extends ProtocolCorrespondence> getProtocolCorrespondenceBOClassHook()

createBatchCorrespondenceDetail

protected CommitteeBatchCorrespondenceDetailBase createBatchCorrespondenceDetail(String committeeId,
                                                                     ProtocolBase protocol,
                                                                     ProtocolCorrespondenceTypeBase protocolCorrespondenceType,
                                                                     String committeeBatchCorrespondenceId,
                                                                     String protocolActionTypeCode)
                                                                          throws PrintingException

This method creates the CommitteeBatchCorrespondenceDetailBase and all associated business objects. The associated business objects are persisted to the database on creation.

Parameters:

protocol -

protocolCorrespondenceType -

committeeBatchCorrespondenceId -

protocolActionTypeCode -

Returns:

the populated CommitteeBatchCorrespondenceDetailBase

Throws:

PrintingException

getNewCommitteeBatchCorrespondenceDetailInstanceHook

protected abstract CommitteeBatchCorrespondenceDetailBase getNewCommitteeBatchCorrespondenceDetailInstanceHook()

createAndSaveProtocolAction

protected ProtocolActionBase createAndSaveProtocolAction(ProtocolBase protocol,
                                             ProtocolCorrespondenceTypeBase protocolCorrespondenceType,
                                             String protocolActionTypeCode)

This method creates the ProtocolActionBase business object and persists it to the database.

Parameters:

protocol -

protocolCorrespondenceType -

protocolActionTypeCode -

Returns:

the populated ProtocolActionBase

getNewProtocolActionInstanceHook

protected abstract ProtocolActionBase getNewProtocolActionInstanceHook(ProtocolBase protocol,
                                                  Object object,
                                                  String protocolActionTypeCode)

createAndSaveProtocolCorrespondence

protected ProtocolCorrespondence createAndSaveProtocolCorrespondence(String committeeId,
                                                         ProtocolBase protocol,
                                                         ProtocolCorrespondenceTypeBase protocolCorrespondenceType,
                                                         ProtocolActionBase protocolAction)
                                                              throws PrintingException

This method creates the ProtocolCorrespondence business object and persists it to the database.

Parameters:

protocol -

protocolCorrespondenceType -

protocolAction -

Returns:

the populated ProtocolCorrespondence

Throws:

PrintingException

getNewProtocolCorrespondenceInstanceHook

protected abstract ProtocolCorrespondence getNewProtocolCorrespondenceInstanceHook()

getEmailAttachments

protected List<EmailAttachment> getEmailAttachments(ProtocolCorrespondence protocolCorrespondence)

lookupBatchCorrespondence

protected BatchCorrespondenceBase lookupBatchCorrespondence(String batchCorrespondenceTypeCode)

This method looks up the BatchCorrespondenceBase business object via the batchCorrespondenceTypeCode.

Parameters:

batchCorrespondenceTypeCode -

Returns:

the BatchCorrespondenceBase business object

getBatchCorrespondenceBOClassHook

protected abstract Class<? extends BatchCorrespondenceBase> getBatchCorrespondenceBOClassHook()

getCommitteePrintingService

protected abstract CommitteePrintingServiceBase getCommitteePrintingService()

setBusinessObjectService

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

Populated by Spring Beans.

Parameters:

businessObjectService -

setProtocolGenericActionService

public void setProtocolGenericActionService(ProtocolGenericActionService protocolGenericActionService)

Populated by Spring Beans.

Parameters:

protocolGenericActionService -

setProtocolCorrespondenceTemplateService

public void setProtocolCorrespondenceTemplateService(ProtocolCorrespondenceTemplateService protocolCorrespondenceTemplateService)

Populated by Spring Beans.

Parameters:

protocolCorrespondenceTemplateService -

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

Populated by Spring Beans.

Parameters:

documentService -

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

Populated by Spring Beans.

Parameters:

kcPersonService -

setKcNotificationService

public void setKcNotificationService(KcNotificationService kcNotificationService)

Populated by Spring Beans.

Parameters:

kcNotificationService -

setDateTimeService

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

getProtocolDao

public ProtocolDao<? extends ProtocolBase> getProtocolDao()

setProtocolDao

public void setProtocolDao(ProtocolDao<? extends ProtocolBase> protocolDao)