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

Class CommitteeScheduleServiceImplBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

java.lang.Object

org.kuali.kra.common.committee.service.impl.CommitteeScheduleServiceImplBase<CS,CMT,CSM>

All Implemented Interfaces:

CommitteeScheduleServiceBase<CS,CMT,CSM>

Direct Known Subclasses:

CommitteeScheduleServiceImpl, IacucCommitteeScheduleServiceImpl

@Transactional
public abstract class CommitteeScheduleServiceImplBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>
extends Object
implements CommitteeScheduleServiceBase<CS,CMT,CSM>

The CommitteeBase Service implementation.

Constructor Summary

Constructors

Constructor and Description
CommitteeScheduleServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSchedule(ScheduleData scheduleData, CMT committee) This method implementer must add new non conflicting, non-repeating schedule dates to existing CommitteeBase.CommitteeScheduleBase list.
protected void	addScheduleDatesToCommittee(List<Date> dates, CMT committee, String location, List<Date> skippedDates) Helper method to add schedule to list.
protected Date	calculateAdvancedSubmissionDays(Date startDate, Integer days) Helper method to calculate advanced submission days.
void	downloadAttachment(KraPersistableBusinessObjectBase attachmentDataSource, javax.servlet.http.HttpServletResponse response) This method will downloadAttachment to CommitteeScheduleAttachmentsBase.
CSM	getCommitteeScheduleMinute(Long committeeScheduleId) This method returns a specific schedule minute based on a committee id NOTE: a null is returned if the ID doesn't exist in the DB.
protected abstract Class<CSM>	getCommitteeScheduleMinuteBOClassHook()
protected ScheduleStatus	getDefaultScheduleStatus() Helper method to retrieve default ScheduleStatus object.
List<CSM>	getMinutesByProtocol(Long protocolId) This method returns a list of minutes based on a protocol ID
List<CSM>	getMinutesByProtocolSubmission(Long submissionID) This method returns a list of minutes based on a protocol submission ID
List<CSM>	getMinutesBySchedule(Long scheduleId) This method returns a list of minutes based on a schedule ID
protected abstract CS	getNewCommiteeScheduleInstanceHook()
protected abstract CommitteeScheduleAttachmentsBase	getNewCommitteeScheduleAttachmentsInstanceHook()
protected Time24HrFmt	getTime24hFmt(Date date, int min) Helper method to convert date and minutes into Time24HrFmt object.
Boolean	isCommitteeScheduleDeletable(CS committeeSchedule) This method implementer must check if passed CommitteeScheduleBase is deleteable.
protected Boolean	isDateAvailable(List<CS> committeeSchedules, Date date) Helper method to test if date is available (non conflicting).
protected Boolean	isProtocolAssignedToScheduleDate(CS committeeSchedule) Helper method to check if ProtocolBase is assigned to CommitteeScheduleBase.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Set the Business Object Service.
void	setReviewCommentsService(ReviewCommentsService<?> reviewCommentsService) Set the ReviewComments Service.
void	setScheduleService(ScheduleService scheduleService) Set the Schedule Service.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitteeScheduleServiceImplBase

public CommitteeScheduleServiceImplBase()

Method Detail

setBusinessObjectService

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

Set the Business Object Service.

Parameters:

businessObjectService - the Business Object Service

setScheduleService

public void setScheduleService(ScheduleService scheduleService)

Set the Schedule Service.

Parameters:

scheduleService -

setReviewCommentsService

public void setReviewCommentsService(ReviewCommentsService<?> reviewCommentsService)

Set the ReviewComments Service.

Parameters:

reviewCommentsService -

isCommitteeScheduleDeletable

public Boolean isCommitteeScheduleDeletable(CS committeeSchedule)

Description copied from interface: CommitteeScheduleServiceBase

This method implementer must check if passed CommitteeScheduleBase is deleteable.
Rule:
Any past schedule date must not be allowed to delete.
Allow delete if NO Protocol is assigned to CommitteeScheduleBase.

Specified by:

isCommitteeScheduleDeletable in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Returns:

See Also:

CommitteeScheduleServiceBase.isCommitteeScheduleDeletable(org.kuali.kra.common.committee.bo.CommitteeScheduleBase)

isProtocolAssignedToScheduleDate

protected Boolean isProtocolAssignedToScheduleDate(CS committeeSchedule)

Helper method to check if ProtocolBase is assigned to CommitteeScheduleBase.

Parameters:

committeeSchedule -

Returns:

addSchedule

public void addSchedule(ScheduleData scheduleData,
               CMT committee)
                 throws ParseException

Description copied from interface: CommitteeScheduleServiceBase

This method implementer must add new non conflicting, non-repeating schedule dates to existing CommitteeBase.CommitteeScheduleBase list.

Specified by:

addSchedule in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Throws:

ParseException

See Also:

CommitteeScheduleServiceBase.addSchedule(org.kuali.kra.common.committee.web.struts.form.schedule.ScheduleData, org.kuali.kra.common.committee.bo.CommitteeBase)

getTime24hFmt

protected Time24HrFmt getTime24hFmt(Date date,
                        int min)
                             throws ParseException

Helper method to convert date and minutes into Time24HrFmt object.

Parameters:

date -

min -

Returns:

Throws:

ParseException

addScheduleDatesToCommittee

protected void addScheduleDatesToCommittee(List<Date> dates,
                               CMT committee,
                               String location,
                               List<Date> skippedDates)

Helper method to add schedule to list.

Parameters:

dates -

committee -

location -

skippedDates -

getNewCommiteeScheduleInstanceHook

protected abstract CS getNewCommiteeScheduleInstanceHook()

isDateAvailable

protected Boolean isDateAvailable(List<CS> committeeSchedules,
                      Date date)

Helper method to test if date is available (non conflicting).

Parameters:

committeeSchedules -

date -

Returns:

calculateAdvancedSubmissionDays

protected Date calculateAdvancedSubmissionDays(Date startDate,
                                   Integer days)

Helper method to calculate advanced submission days.

Parameters:

startDate -

days -

Returns:

getDefaultScheduleStatus

protected ScheduleStatus getDefaultScheduleStatus()

Helper method to retrieve default ScheduleStatus object.

Returns:

getMinutesByProtocol

public List<CSM> getMinutesByProtocol(Long protocolId)

Description copied from interface: CommitteeScheduleServiceBase

This method returns a list of minutes based on a protocol ID

Specified by:

getMinutesByProtocol in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Returns:

See Also:

CommitteeScheduleServiceBase.getMinutesByProtocol(java.lang.Long)

getCommitteeScheduleMinuteBOClassHook

protected abstract Class<CSM> getCommitteeScheduleMinuteBOClassHook()

getMinutesBySchedule

public List<CSM> getMinutesBySchedule(Long scheduleId)

Description copied from interface: CommitteeScheduleServiceBase

This method returns a list of minutes based on a schedule ID

Specified by:

getMinutesBySchedule in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Returns:

See Also:

CommitteeScheduleServiceBase.getMinutesBySchedule(java.lang.Long)

getCommitteeScheduleMinute

public CSM getCommitteeScheduleMinute(Long committeeScheduleId)

Description copied from interface: CommitteeScheduleServiceBase

This method returns a specific schedule minute based on a committee id NOTE: a null is returned if the ID doesn't exist in the DB.

Specified by:

getCommitteeScheduleMinute in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Returns:

See Also:

CommitteeScheduleServiceBase.getCommitteeScheduleMinute(java.lang.Long)

getMinutesByProtocolSubmission

public List<CSM> getMinutesByProtocolSubmission(Long submissionID)

Description copied from interface: CommitteeScheduleServiceBase

This method returns a list of minutes based on a protocol submission ID

Specified by:

getMinutesByProtocolSubmission in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Returns:

See Also:

CommitteeScheduleServiceBase.getMinutesByProtocolSubmission(java.lang.Long)

downloadAttachment

public void downloadAttachment(KraPersistableBusinessObjectBase attachmentDataSource,
                      javax.servlet.http.HttpServletResponse response)
                        throws Exception

This method will downloadAttachment to CommitteeScheduleAttachmentsBase.

Specified by:

downloadAttachment in interface CommitteeScheduleServiceBase<CS extends CommitteeScheduleBase<CS,CMT,?,CSM>,CMT extends CommitteeBase<CMT,?,CS>,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

Parameters:

committeScheduleAttachments -

Throws:

Exception

getNewCommitteeScheduleAttachmentsInstanceHook

protected abstract CommitteeScheduleAttachmentsBase getNewCommitteeScheduleAttachmentsInstanceHook()