org.kuali.kra.common.committee.bo

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

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.common.committee.bo.CommitteeSequenceAssociateBase

org.kuali.kra.common.committee.bo.CommitteeAssociateBase

org.kuali.kra.common.committee.bo.CommitteeScheduleBase<CS,CMT,PS,CSM>

All Implemented Interfaces:

Serializable, Comparable<CS>, org.apache.ojb.broker.PersistenceBrokerAware, Permissionable, Sequenceable, SequenceAssociate<CommitteeBase<?,?,?>>, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

CommitteeSchedule, IacucCommitteeSchedule

public abstract class CommitteeScheduleBase<CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>,CMT extends CommitteeBase<CMT,?,CS>,PS extends ProtocolSubmissionBase,CSM extends CommitteeScheduleMinuteBase<CSM,CS>>
extends CommitteeAssociateBase
implements Comparable<CS>, Permissionable

This is BO class to support CommitteeScheulde. It has three transient field to support UI.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Long	DEFAULT_SCHEDULE_ID

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Fields inherited from interface org.kuali.kra.common.permissions.Permissionable

AWARD_BUDGET_KEY, AWARD_KEY, COI_DISCLOSURE_KEY, COMMITTEE_KEY, COMMITTEE_SCHEDULE_KEY, IACUC_PROTOCOL_KEY, IACUC_PROTOCOL_ONLINE_REVIEW_KEY, NEGOTIATION_KEY, PROPOSAL_BUDGET_KEY, PROPOSAL_KEY, PROTOCOL_KEY, PROTOCOL_ONLINE_REVIEW_KEY, SPONSOR_HIREARCHY_KEY, SUBAWARD_KEY, TIME_AND_MONEY_KEY

Constructor Summary

Constructors

Constructor and Description
CommitteeScheduleBase()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(CS other) Compares the schedule dates for two instances of CommitteeScheduleBase in order to enforce an ordering.
boolean	equals(Object obj)
Timestamp	getActualTime()
Date	getAgendaProdRevDate()
String	getComments()
List<CommitteeScheduleAttachmentsBase>	getCommitteeScheduleAttachments()
List<CommitteeScheduleAttendanceBase>	getCommitteeScheduleAttendances()
List<CSM>	getCommitteeScheduleMinutes()
List<CommScheduleActItemBase>	getCommScheduleActItems()
String	getDayOfWeek() This UI support method to find day Of week from BO's persistent field scheduledDate.
boolean	getDelete()
String	getDocumentKey() This method returns unique key for implementing document.
String	getDocumentNumberForPermission() This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
String	getDocumentRoleTypeCode()
Timestamp	getEndTime()
boolean	getFilter()
Long	getId()
List<PS>	getLatestProtocolSubmissions()
String	getLeadUnitNumber()
Integer	getMaxProtocols()
Date	getMeetingDate()
List<CommScheduleMinuteDocBase>	getMinuteDocs()
String	getNamespace()
abstract CMT	getParentCommittee()
String	getPlace()
List<ProtocolBase>	getProtocols()
Date	getProtocolSubDeadline()
List<PS>	getProtocolSubmissions()
List<String>	getRoleNames() This method gets all the role names for particular document.
List<ScheduleAgendaBase>	getScheduleAgendas()
Date	getScheduledDate()
String	getScheduleId()
ScheduleStatus	getScheduleStatus()
Integer	getScheduleStatusCode()
Timestamp	getStartTime()
Timestamp	getTime() This method is BO persistent accessor method, which adds Time to Date on each call.
Time12HrFmt	getViewEndTime()
Time12HrFmt	getViewStartTime()
Time12HrFmt	getViewTime()
int	hashCode()
boolean	isActiveFor(String personId) This method returns true if the given personId has a membership in the schedule's parent committee that is active for the schedule date, and false otherwise.
boolean	isAvailableToReviewers()
boolean	isScheduleDateInPast() This method returns true if and only if the schedule date has passed
boolean	isSelected()
void	populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes) Allows a permissionable to set additional qualified role attributes that may be needed by kim services to resolve the role members.
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setAgendaProdRevDate(Date agendaProdRevDate)
void	setAvailableToReviewers(boolean availableToReviewers)
void	setComments(String comments)
abstract void	setCommittee(CMT committee)
void	setCommitteeScheduleAttachments(List<CommitteeScheduleAttachmentsBase> committeeScheduleAttachments)
void	setCommitteeScheduleAttendances(List<CommitteeScheduleAttendanceBase> committeeScheduleAttendances)
void	setCommitteeScheduleMinutes(List<CSM> committeeScheduleMinutes)
void	setCommScheduleActItems(List<CommScheduleActItemBase> commScheduleActItems)
void	setDayOfWeek(String dayOfWeek)
void	setDelete(boolean delete)
void	setEndTime(Timestamp endTime)
void	setFilter(boolean filter)
void	setId(Long id)
void	setMaxProtocols(Integer maxProtocols)
void	setMeetingDate(Date meetingDate)
void	setMinuteDocs(List<CommScheduleMinuteDocBase> minuteDocs)
void	setPlace(String place)
void	setProtocols(List<ProtocolBase> protocols)
void	setProtocolSubDeadline(Date protocolSubDeadline)
void	setProtocolSubmissions(List<PS> protocolSubmissions)
void	setScheduleAgendas(List<ScheduleAgendaBase> scheduleAgendas)
void	setScheduledDate(Date scheduledDate)
void	setScheduleId(String scheduleId)
void	setScheduleStatus(ScheduleStatus scheduleStatus)
void	setScheduleStatusCode(Integer scheduleStatusCode)
void	setSelected(boolean selected)
void	setStartTime(Timestamp startTime)
void	setTime(Timestamp time)
void	setViewEndTime(Time12HrFmt viewEndTime)
void	setViewStartTime(Time12HrFmt viewStartTime)
void	setViewTime(Time12HrFmt viewTime)

Methods inherited from class org.kuali.kra.common.committee.bo.CommitteeAssociateBase

getCommitteeIdFk, setCommitteeIdFk

Methods inherited from class org.kuali.kra.common.committee.bo.CommitteeSequenceAssociateBase

getSequenceNumber, getSequenceOwner, setSequenceOwner

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

DEFAULT_SCHEDULE_ID

public static final Long DEFAULT_SCHEDULE_ID

Constructor Detail

CommitteeScheduleBase

public CommitteeScheduleBase()

Method Detail

getId

public Long getId()

setId

public void setId(Long id)

getScheduleId

public String getScheduleId()

setScheduleId

public void setScheduleId(String scheduleId)

getScheduledDate

public Date getScheduledDate()

setScheduledDate

public void setScheduledDate(Date scheduledDate)

getPlace

public String getPlace()

setPlace

public void setPlace(String place)

getTime

public Timestamp getTime()

This method is BO persistent accessor method, which adds Time to Date on each call. In support to UI.

Returns:

setTime

public void setTime(Timestamp time)

getActualTime

public Timestamp getActualTime()

getProtocolSubDeadline

public Date getProtocolSubDeadline()

setProtocolSubDeadline

public void setProtocolSubDeadline(Date protocolSubDeadline)

getScheduleStatusCode

public Integer getScheduleStatusCode()

setScheduleStatusCode

public void setScheduleStatusCode(Integer scheduleStatusCode)

getMeetingDate

public Date getMeetingDate()

setMeetingDate

public void setMeetingDate(Date meetingDate)

getStartTime

public Timestamp getStartTime()

setStartTime

public void setStartTime(Timestamp startTime)

getEndTime

public Timestamp getEndTime()

setEndTime

public void setEndTime(Timestamp endTime)

getAgendaProdRevDate

public Date getAgendaProdRevDate()

setAgendaProdRevDate

public void setAgendaProdRevDate(Date agendaProdRevDate)

getMaxProtocols

public Integer getMaxProtocols()

setMaxProtocols

public void setMaxProtocols(Integer maxProtocols)

getComments

public String getComments()

setComments

public void setComments(String comments)

isAvailableToReviewers

public boolean isAvailableToReviewers()

setAvailableToReviewers

public void setAvailableToReviewers(boolean availableToReviewers)

getParentCommittee

public abstract CMT getParentCommittee()

setCommittee

public abstract void setCommittee(CMT committee)

getScheduleStatus

public ScheduleStatus getScheduleStatus()

setScheduleStatus

public void setScheduleStatus(ScheduleStatus scheduleStatus)

setDayOfWeek

public void setDayOfWeek(String dayOfWeek)

getDayOfWeek

public String getDayOfWeek()

This UI support method to find day Of week from BO's persistent field scheduledDate.

Returns:

setFilter

public void setFilter(boolean filter)

getFilter

public boolean getFilter()

getViewTime

public Time12HrFmt getViewTime()

setViewTime

public void setViewTime(Time12HrFmt viewTime)

getDelete

public boolean getDelete()

setDelete

public void setDelete(boolean delete)

getProtocols

public List<ProtocolBase> getProtocols()

setProtocols

public void setProtocols(List<ProtocolBase> protocols)

getCommitteeScheduleAttendances

public List<CommitteeScheduleAttendanceBase> getCommitteeScheduleAttendances()

setCommitteeScheduleAttendances

public void setCommitteeScheduleAttendances(List<CommitteeScheduleAttendanceBase> committeeScheduleAttendances)

isSelected

public boolean isSelected()

setSelected

public void setSelected(boolean selected)

equals

public boolean equals(Object obj)

Specified by:

equals in class CommitteeSequenceAssociateBase

hashCode

public int hashCode()

Specified by:

hashCode in class CommitteeSequenceAssociateBase

compareTo

public int compareTo(CS other)

Compares the schedule dates for two instances of CommitteeScheduleBase in order to enforce an ordering.

Specified by:

compareTo in interface Comparable<CS extends CommitteeScheduleBase<CS,CMT,PS,CSM>>

Parameters:

other - The CommitteeScheduleBase to be compared.

Returns:

the result of comparing this scheduledDate to the other scheduledDate

resetPersistenceState

public void resetPersistenceState()

Description copied from interface: Sequenceable

This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity. During sequencing, the VersioningService needs to be able to signal that a Sequenceable has changed state from an persisted entity to a new, unpersisted one. Otherwise, versioning operations would result earlier SequenceOwners losing the association with older versions of associates. This behavior comes into play whenever an associated object is versioned. Typically, implementers will set primary key fields to null to trigger an INSERT during save.

Specified by:

resetPersistenceState in interface Sequenceable

Specified by:

resetPersistenceState in class CommitteeSequenceAssociateBase

getProtocolSubmissions

public List<PS> getProtocolSubmissions()

getLatestProtocolSubmissions

public List<PS> getLatestProtocolSubmissions()

setProtocolSubmissions

public void setProtocolSubmissions(List<PS> protocolSubmissions)

getViewStartTime

public Time12HrFmt getViewStartTime()

setViewStartTime

public void setViewStartTime(Time12HrFmt viewStartTime)

getViewEndTime

public Time12HrFmt getViewEndTime()

setViewEndTime

public void setViewEndTime(Time12HrFmt viewEndTime)

getCommScheduleActItems

public List<CommScheduleActItemBase> getCommScheduleActItems()

setCommScheduleActItems

public void setCommScheduleActItems(List<CommScheduleActItemBase> commScheduleActItems)

getCommitteeScheduleMinutes

public List<CSM> getCommitteeScheduleMinutes()

setCommitteeScheduleMinutes

public void setCommitteeScheduleMinutes(List<CSM> committeeScheduleMinutes)

getCommitteeScheduleAttachments

public List<CommitteeScheduleAttachmentsBase> getCommitteeScheduleAttachments()

setCommitteeScheduleAttachments

public void setCommitteeScheduleAttachments(List<CommitteeScheduleAttachmentsBase> committeeScheduleAttachments)

getMinuteDocs

public List<CommScheduleMinuteDocBase> getMinuteDocs()

setMinuteDocs

public void setMinuteDocs(List<CommScheduleMinuteDocBase> minuteDocs)

getScheduleAgendas

public List<ScheduleAgendaBase> getScheduleAgendas()

setScheduleAgendas

public void setScheduleAgendas(List<ScheduleAgendaBase> scheduleAgendas)

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Returns:

getDocumentNumberForPermission

public String getDocumentNumberForPermission()

Description copied from interface: Permissionable

This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.

Specified by:

getDocumentNumberForPermission in interface Permissionable

Returns:

getDocumentRoleTypeCode

public String getDocumentRoleTypeCode()

Specified by:

getDocumentRoleTypeCode in interface Permissionable

getLeadUnitNumber

public String getLeadUnitNumber()

Specified by:

getLeadUnitNumber in interface Permissionable

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Permissionable

getRoleNames

public List<String> getRoleNames()

Description copied from interface: Permissionable

This method gets all the role names for particular document.

Specified by:

getRoleNames in interface Permissionable

Returns:

populateAdditionalQualifiedRoleAttributes

public void populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)

Description copied from interface: Permissionable

Allows a permissionable to set additional qualified role attributes that may be needed by kim services to resolve the role members.

Specified by:

populateAdditionalQualifiedRoleAttributes in interface Permissionable

isActiveFor

public boolean isActiveFor(String personId)

This method returns true if the given personId has a membership in the schedule's parent committee that is active for the schedule date, and false otherwise. Also returns false if the personId parameter or the parent committee of the schedule is null.

Parameters:

personId -

Returns:

isScheduleDateInPast

public boolean isScheduleDateInPast()

This method returns true if and only if the schedule date has passed

Returns: