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

Class CommitteeServiceImplBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>,PS extends ProtocolSubmissionBase,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>

java.lang.Object

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

All Implemented Interfaces:

CommitteeServiceBase<CMT,CS>

Direct Known Subclasses:

CommitteeServiceImpl, IacucCommitteeServiceImpl

public abstract class CommitteeServiceImplBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>,PS extends ProtocolSubmissionBase,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>
extends Object
implements CommitteeServiceBase<CMT,CS>

The CommitteeBase Service implementation.

Constructor Summary

Constructors

Constructor and Description
CommitteeServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCommitteeResearchArea(CMT committee, ResearchAreaBase researchArea) Add a research area to the committee.
void	addResearchAreas(CMT committee, Collection<ResearchAreaBase> researchAreas) Add the research areas to the committee.
protected List<CS>	copySchedules(List<CS> newSchedules, List<CS> oldSchedules)
List<org.kuali.rice.core.api.util.KeyValue>	getAvailableCommitteeDates(String committeeId) Get the valid upcoming committee dates for scheduling a protocol.
List<CommitteeMembershipBase>	getAvailableMembers(String committeeId, String scheduleId) Get the active members scheduled for a future meeting (schedule) in a committee.
List<CommitteeMembershipBase>	getAvailableMembersNow(String committeeId) Get the active members in a committee.
protected Calendar	getCalendar(Date date)
protected abstract Class<CMT>	getCommitteeBOClassHook()
CMT	getCommitteeById(String committeeId) Retrieve a committee from the database based upon its CommitteeBase ID.
CS	getCommitteeSchedule(CMT committee, String scheduleId) Get the committee schedule.
protected CS	getCopiedSchedule(CS schedule)
protected String	getDescription(CS schedule) Get the date/place/time description that will be displayed in the drop-down menu for the user.
protected abstract CommitteeResearchAreaBase	getNewCommitteeResearchAreaInstanceHook()
protected CS	getNewCommitteeSchedule(CS schedule, List<CS> schedules)
protected boolean	hasResearchArea(CMT committee, ResearchAreaBase researchArea) Does the committee already have this research area?
protected boolean	isInNewCommittee(CS schedule, List<CS> schedules)
protected boolean	isMemberAvailable(CommitteeMembershipBase member, Date scheduledDate) Is the member available for the given schedule meeting date? The member must have a role for that date.
protected boolean	isNotEmptyData(CS schedule)
protected boolean	isOkayToScheduleReview(CMT committee, CS schedule) Is it OK to schedule a review for the given committee and schedule?
protected boolean	isScheduleDateMatched(CS schedule, List<CS> schedules)
List<CS>	mergeCommitteeSchedule(String committeeId) This method to merge existing meeting data to the new approved committee.
protected void	setActItemId(CommScheduleActItemBase actItem, List<CSM> minutes)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Set the Business Object Service.
void	setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitteeServiceImplBase

public CommitteeServiceImplBase()

Method Detail

setBusinessObjectService

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

Set the Business Object Service.

Parameters:

businessObjectService - the Business Object Service

getCommitteeById

public CMT getCommitteeById(String committeeId)

Description copied from interface: CommitteeServiceBase

Retrieve a committee from the database based upon its CommitteeBase ID.

Specified by:

getCommitteeById in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Parameters:

committeeId - the committee ID

Returns:

the committee or null if not found

See Also:

CommitteeServiceBase.getCommitteeById(java.lang.String)

getCommitteeBOClassHook

protected abstract Class<CMT> getCommitteeBOClassHook()

addResearchAreas

public void addResearchAreas(CMT committee,
                    Collection<ResearchAreaBase> researchAreas)

Description copied from interface: CommitteeServiceBase

Add the research areas to the committee. Duplicates are not added.

Specified by:

addResearchAreas in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Parameters:

committee - the committee to add to

researchAreas - the research areas to add

See Also:

org.kuali.kra.common.committee.service.CommitteeServiceBase#addResearchAreas(org.kuali.kra.common.committee.bo.CMT, java.util.Collection)

hasResearchArea

protected boolean hasResearchArea(CMT committee,
                      ResearchAreaBase researchArea)

Does the committee already have this research area?

Parameters:

committee -

researchArea -

Returns:

true if the committee has the research area; otherwise false

addCommitteeResearchArea

protected void addCommitteeResearchArea(CMT committee,
                            ResearchAreaBase researchArea)

Add a research area to the committee.

Parameters:

committee -

researchArea -

getNewCommitteeResearchAreaInstanceHook

protected abstract CommitteeResearchAreaBase getNewCommitteeResearchAreaInstanceHook()

getAvailableCommitteeDates

public List<org.kuali.rice.core.api.util.KeyValue> getAvailableCommitteeDates(String committeeId)

Description copied from interface: CommitteeServiceBase

Get the valid upcoming committee dates for scheduling a protocol. This method is used by CommitteeScheduleValuesFinderBase.

Specified by:

getAvailableCommitteeDates in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Returns:

list of key/value pairs with the dates

See Also:

CommitteeServiceBase.getAvailableCommitteeDates(java.lang.String)

isOkayToScheduleReview

protected boolean isOkayToScheduleReview(CMT committee,
                             CS schedule)

Is it OK to schedule a review for the given committee and schedule?

Parameters:

committee -

schedule -

Returns:

getCalendar

protected Calendar getCalendar(Date date)

getDescription

protected String getDescription(CS schedule)

Get the date/place/time description that will be displayed in the drop-down menu for the user.

Parameters:

schedule -

Returns:

getAvailableMembers

public List<CommitteeMembershipBase> getAvailableMembers(String committeeId,
                                                String scheduleId)

Description copied from interface: CommitteeServiceBase

Get the active members scheduled for a future meeting (schedule) in a committee.

Specified by:

getAvailableMembers in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Parameters:

committeeId - the committee's id

scheduleId - the schedule's id

Returns:

the list of active members who will be at the meeting

See Also:

CommitteeServiceBase.getAvailableMembers(java.lang.String, java.lang.String)

getAvailableMembersNow

public List<CommitteeMembershipBase> getAvailableMembersNow(String committeeId)

Description copied from interface: CommitteeServiceBase

Get the active members in a committee.

Specified by:

getAvailableMembersNow in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Parameters:

committeeId - the committee's id

Returns:

the list of active members on the committee now

See Also:

CommitteeServiceBase.getAvailableMembers(java.lang.String, java.lang.String)

isMemberAvailable

protected boolean isMemberAvailable(CommitteeMembershipBase member,
                        Date scheduledDate)

Is the member available for the given schedule meeting date? The member must have a role for that date.

Parameters:

member - the member

scheduledDate - the date of the meeting

Returns:

true if the member will be at the meeting; otherwise false TODO: This method calls member.isActive() and then carries out date checking that has already been performed in member.isActive()? Perhaps this method should be removed and its invocation in getAvailableMembers() above should be replaced by a single call to member.isActive(schedule.getScheduledDate())

getCommitteeSchedule

public CS getCommitteeSchedule(CMT committee,
                      String scheduleId)

Description copied from interface: CommitteeServiceBase

Get the committee schedule.

Specified by:

getCommitteeSchedule in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Parameters:

committee - the committee to search

scheduleId - the id of the schedule to find

Returns:

the schedule or null if not found

See Also:

CommitteeServiceBase.getCommitteeSchedule(org.kuali.kra.common.committee.bo.CommitteeBase, java.lang.String)

mergeCommitteeSchedule

public List<CS> mergeCommitteeSchedule(String committeeId)

Description copied from interface: CommitteeServiceBase

This method to merge existing meeting data to the new approved committee.

Specified by:

mergeCommitteeSchedule in interface CommitteeServiceBase<CMT extends CommitteeBase<CMT,?,CS>,CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Returns:

See Also:

CommitteeServiceBase.mergeCommitteeSchedule(java.lang.String)

copySchedules

protected List<CS> copySchedules(List<CS> newSchedules,
                     List<CS> oldSchedules)

isNotEmptyData

protected boolean isNotEmptyData(CS schedule)

getCopiedSchedule

protected CS getCopiedSchedule(CS schedule)

setActItemId

protected void setActItemId(CommScheduleActItemBase actItem,
                List<CSM> minutes)

isScheduleDateMatched

protected boolean isScheduleDateMatched(CS schedule,
                            List<CS> schedules)

isInNewCommittee

protected boolean isInNewCommittee(CS schedule,
                       List<CS> schedules)

getNewCommitteeSchedule

protected CS getNewCommitteeSchedule(CS schedule,
                         List<CS> schedules)

setSequenceAccessorService

public void setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)