org.kuali.kra.common.committee.meeting

Class CommitteeScheduleMinuteBase<CSM extends CommitteeScheduleMinuteBase<CSM,CS>,CS extends CommitteeScheduleBase<CS,?,?,CSM>>

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.onlinereview.ProtocolReviewableBase<CS>

org.kuali.kra.common.committee.meeting.CommitteeScheduleMinuteBase<CSM,CS>

All Implemented Interfaces:

Serializable, Cloneable, org.apache.ojb.broker.PersistenceBrokerAware, 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:

CommitteeScheduleMinute, IacucCommitteeScheduleMinute

public abstract class CommitteeScheduleMinuteBase<CSM extends CommitteeScheduleMinuteBase<CSM,CS>,CS extends CommitteeScheduleBase<CS,?,?,CSM>>
extends ProtocolReviewableBase<CS>
implements Cloneable

This is BO class for committee schedule minute.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<CommitteeScheduleMinuteBase>	entryTypeComparator

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

UPDATE_USER_LENGTH

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
CommitteeScheduleMinuteBase() Constructs a CommitteeScheduleMinuteBase.
CommitteeScheduleMinuteBase(String minuteEntryTypeCode) Constructs a CommitteeScheduleMinuteBase with a default minute entry.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Equality is based on minute id, minute entry value, entry number(order position) and whether or not it is private.
boolean	getCanView() Returns whether the current user can view this comment.
CS	getCommitteeSchedule()
CommScheduleActItemBase	getCommScheduleActItem()
Long	getCommScheduleActItemsIdFk()
Long	getCommScheduleMinutesId()
CSM	getCopy()
Timestamp	getCreateTimestamp()
String	getCreateUser()
String	getCreateUserFullName() Gets the createUserFullName attribute.
Integer	getEntryNumber()
String	getMinuteEntry()
MinuteEntryType	getMinuteEntryType()
String	getMinuteEntryTypeCode()
CSM	getPristineInstance() This method will try to obtain the pristine instance of this BO from the database using the schedule id as the primary key value.
boolean	getPrivateCommentFlag()
ProtocolBase	getProtocol()
ProtocolContingencyBase	getProtocolContingency()
String	getProtocolContingencyCode()
Long	getProtocolId()
Long	getProtocolIdFk()
ProtocolOnlineReviewBase	getProtocolOnlineReview() Gets the protocolReview attribute.
Long	getProtocolOnlineReviewIdFk() Gets the protocolReviewIdFk attribute.
ProtocolReviewer	getProtocolReviewer()
Long	getProtocolReviewerIdFk()
List<ProtocolBase>	getProtocols()
boolean	getReadOnly()
Long	getScheduleIdFk()
Long	getSubmissionIdFk()
String	getUpdateUserFullName() Gets the updateUserFullName attribute.
protected abstract boolean	isAdministrator(String principalId)
boolean	isDisplayReviewerName()
boolean	isFinal() This method indicates if the OLR is finalized or not review comment has a finalflag, but review attachment does not
boolean	isFinalFlag()
boolean	isGenerateAttendance()
boolean	isPersisted() This method returns true if the object has been saved to the database, and returns false if it has not.
boolean	isPrivate() This method is to show whether comment or attachment is private or not
boolean	isReviewComment() This method is needed to determine whether schedule minute comments have been accepted by the irb admin.
boolean	isUpdateUserToBeRecorded(CSM pristineInstance) This method returns true if this BO instance's minuteEntry text or the private or final flag values or the protocol values have been updated by the user.
protected void	preUpdate()
void	setCommitteeSchedule(CS committeeSchedule)
void	setCommScheduleActItem(CommScheduleActItemBase commScheduleActItem)
void	setCommScheduleActItemsIdFk(Long commScheduleActItemsIdFk)
void	setCommScheduleMinutesId(Long commScheduleMinutesId)
void	setCreateTimestamp(Timestamp createTimestamp)
void	setCreateUser(String createUser)
void	setCreateUserFullName(String createUserFullName) Sets the createUserFullName attribute value.
void	setDisplayReviewerName(boolean displayReviewerName)
void	setEntryNumber(Integer entryNumber)
void	setFinalFlag(boolean finalFlag)
void	setGenerateAttendance(boolean generateAttendance)
void	setMinuteEntry(String minuteEntry)
void	setMinuteEntryType(MinuteEntryType minuteEntryType)
void	setMinuteEntryTypeCode(String minuteEntryTypeCode)
void	setPrivateCommentFlag(boolean privateCommentFlag)
void	setProtocol(ProtocolBase protocol)
void	setProtocolContingency(ProtocolContingencyBase protocolContingency)
void	setProtocolContingencyCode(String protocolContingencyCode)
void	setProtocolIdFk(Long protocolIdFk)
void	setProtocolOnlineReview(ProtocolOnlineReviewBase protocolReview) Sets the protocolReview attribute value.
void	setProtocolOnlineReviewIdFk(Long protocolOnlineReviewIdFk) Sets the protocolReviewIdFk attribute value.
void	setProtocolReviewer(ProtocolReviewer protocolReviewer)
void	setProtocolReviewerIdFk(Long protocolReviewerIdFk)
void	setProtocols(List<ProtocolBase> protocols)
void	setReadOnly(boolean readOnly)
void	setScheduleIdFk(Long scheduleIdFk)
void	setSubmissionIdFk(Long submissionIdFk)
void	setUpdateUserFullName(String updateUserFullName) Sets the updateUserFullName attribute value.

Methods inherited from class org.kuali.kra.protocol.onlinereview.ProtocolReviewableBase

getProtocolOnlineReviewBOClassHook, isAccepted

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

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, 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, hashCode, notify, notifyAll, wait, wait, wait

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

toString

Field Detail

entryTypeComparator

public static final Comparator<CommitteeScheduleMinuteBase> entryTypeComparator

Constructor Detail

CommitteeScheduleMinuteBase

public CommitteeScheduleMinuteBase()

Constructs a CommitteeScheduleMinuteBase.

CommitteeScheduleMinuteBase

public CommitteeScheduleMinuteBase(String minuteEntryTypeCode)

Constructs a CommitteeScheduleMinuteBase with a default minute entry.

Parameters:

minuteEntryTypeCode - the type code for the default minute entry

Method Detail

getScheduleIdFk

public Long getScheduleIdFk()

setScheduleIdFk

public void setScheduleIdFk(Long scheduleIdFk)

getEntryNumber

public Integer getEntryNumber()

setEntryNumber

public void setEntryNumber(Integer entryNumber)

getMinuteEntryTypeCode

public String getMinuteEntryTypeCode()

setMinuteEntryTypeCode

public void setMinuteEntryTypeCode(String minuteEntryTypeCode)

getProtocolIdFk

public Long getProtocolIdFk()

setProtocolIdFk

public void setProtocolIdFk(Long protocolIdFk)

getCommScheduleActItemsIdFk

public Long getCommScheduleActItemsIdFk()

setCommScheduleActItemsIdFk

public void setCommScheduleActItemsIdFk(Long commScheduleActItemsIdFk)

getSubmissionIdFk

public Long getSubmissionIdFk()

setSubmissionIdFk

public void setSubmissionIdFk(Long submissionIdFk)

getPrivateCommentFlag

public boolean getPrivateCommentFlag()

setPrivateCommentFlag

public void setPrivateCommentFlag(boolean privateCommentFlag)

getProtocolContingencyCode

public String getProtocolContingencyCode()

setProtocolContingencyCode

public void setProtocolContingencyCode(String protocolContingencyCode)

getMinuteEntry

public String getMinuteEntry()

setMinuteEntry

public void setMinuteEntry(String minuteEntry)

getCommScheduleMinutesId

public Long getCommScheduleMinutesId()

setCommScheduleMinutesId

public void setCommScheduleMinutesId(Long commScheduleMinutesId)

getProtocolContingency

public ProtocolContingencyBase getProtocolContingency()

setProtocolContingency

public void setProtocolContingency(ProtocolContingencyBase protocolContingency)

getMinuteEntryType

public MinuteEntryType getMinuteEntryType()

setMinuteEntryType

public void setMinuteEntryType(MinuteEntryType minuteEntryType)

getCommScheduleActItem

public CommScheduleActItemBase getCommScheduleActItem()

setCommScheduleActItem

public void setCommScheduleActItem(CommScheduleActItemBase commScheduleActItem)

getProtocols

public List<ProtocolBase> getProtocols()

setProtocols

public void setProtocols(List<ProtocolBase> protocols)

isGenerateAttendance

public boolean isGenerateAttendance()

setGenerateAttendance

public void setGenerateAttendance(boolean generateAttendance)

isFinalFlag

public boolean isFinalFlag()

setFinalFlag

public void setFinalFlag(boolean finalFlag)

getProtocol

public ProtocolBase getProtocol()

Specified by:

getProtocol in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

setProtocol

public void setProtocol(ProtocolBase protocol)

getProtocolReviewerIdFk

public Long getProtocolReviewerIdFk()

setProtocolReviewerIdFk

public void setProtocolReviewerIdFk(Long protocolReviewerIdFk)

getProtocolReviewer

public ProtocolReviewer getProtocolReviewer()

setProtocolReviewer

public void setProtocolReviewer(ProtocolReviewer protocolReviewer)

setCreateUser

public void setCreateUser(String createUser)

getCreateUser

public String getCreateUser()

Specified by:

getCreateUser in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

setCreateTimestamp

public void setCreateTimestamp(Timestamp createTimestamp)

getCreateTimestamp

public Timestamp getCreateTimestamp()

getProtocolOnlineReviewIdFk

public Long getProtocolOnlineReviewIdFk()

Gets the protocolReviewIdFk attribute.

Specified by:

getProtocolOnlineReviewIdFk in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

Returns:

Returns the protocolReviewIdFk.

setProtocolOnlineReviewIdFk

public void setProtocolOnlineReviewIdFk(Long protocolOnlineReviewIdFk)

Sets the protocolReviewIdFk attribute value.

Parameters:

protocolOnlineReviewIdFk - The protocolReviewIdFk to set.

getProtocolOnlineReview

public ProtocolOnlineReviewBase getProtocolOnlineReview()

Gets the protocolReview attribute.

Returns:

Returns the protocolReview.

setProtocolOnlineReview

public void setProtocolOnlineReview(ProtocolOnlineReviewBase protocolReview)

Sets the protocolReview attribute value.

Parameters:

protocolReview - The protocolReview to set.

equals

public boolean equals(Object o)

Equality is based on minute id, minute entry value, entry number(order position) and whether or not it is private. This function is used to determine if a minute needs to be updated on the DB.

Overrides:

equals in class Object

Parameters:

o - a CommitteeScheduleMinuteBase object

Returns:

boolean if the passed in minute is the same as THIS minute.

See Also:

Object.equals(java.lang.Object)

preUpdate

protected void preUpdate()

Overrides:

preUpdate in class KraPersistableBusinessObjectBase

See Also:

org.kuali.core.bo.PersistableBusinessObjectBase#beforeInsert()

getPristineInstance

public CSM getPristineInstance()

This method will try to obtain the pristine instance of this BO from the database using the schedule id as the primary key value. It will return null if the schedule id is null or if the pristine instance cannot be loaded from the DB for whatever reason.

Returns:

isUpdateUserToBeRecorded

public boolean isUpdateUserToBeRecorded(CSM pristineInstance)

This method returns true if this BO instance's minuteEntry text or the private or final flag values or the protocol values have been updated by the user. It checks these fields by comparing this instance against the supplied pristine instance of this BO. This method will return false if the supplied pristineInstance argument is null, or if its schedule id (primary key) is different from this instance's schedule id.

isPersisted

public boolean isPersisted()

This method returns true if the object has been saved to the database, and returns false if it has not.

Returns:

a boolean

getProtocolId

public Long getProtocolId()

Specified by:

getProtocolId in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

getCreateUserFullName

public String getCreateUserFullName()

Gets the createUserFullName attribute.

Returns:

Returns the createUserFullName.

setCreateUserFullName

public void setCreateUserFullName(String createUserFullName)

Sets the createUserFullName attribute value.

Parameters:

createUserFullName - The createUserFullName to set.

getUpdateUserFullName

public String getUpdateUserFullName()

Gets the updateUserFullName attribute.

Returns:

Returns the updateUserFullName.

setUpdateUserFullName

public void setUpdateUserFullName(String updateUserFullName)

Sets the updateUserFullName attribute value.

Parameters:

updateUserFullName - The updateUserFullName to set.

getCommitteeSchedule

public CS getCommitteeSchedule()

Specified by:

getCommitteeSchedule in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

setCommitteeSchedule

public void setCommitteeSchedule(CS committeeSchedule)

getCanView

public boolean getCanView()

Returns whether the current user can view this comment. This is true either if 1) The current user has the role IRB Administrator 2) The current user does not have the role IRB Administrator, but the current user is the comment creator 3) The current user does not have the role IRB Administrator, the current user is not the comment creator, but the comment is public and final

Returns:

whether the current user can view this comment

isAdministrator

protected abstract boolean isAdministrator(String principalId)

getCopy

public CSM getCopy()

isDisplayReviewerName

public boolean isDisplayReviewerName()

setDisplayReviewerName

public void setDisplayReviewerName(boolean displayReviewerName)

Specified by:

setDisplayReviewerName in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

isReviewComment

public boolean isReviewComment()

This method is needed to determine whether schedule minute comments have been accepted by the irb admin. Only online review comments are subject to approval, all other minute types are returned true by default.

Overrides:

isReviewComment in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

Returns:

false if it is an online review comment and not accepted, true otherwise.

isFinal

public boolean isFinal()

Description copied from class: ProtocolReviewableBase

This method indicates if the OLR is finalized or not review comment has a finalflag, but review attachment does not

Specified by:

isFinal in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

Returns:

isPrivate

public boolean isPrivate()

Description copied from class: ProtocolReviewableBase

This method is to show whether comment or attachment is private or not

Specified by:

isPrivate in class ProtocolReviewableBase<CS extends CommitteeScheduleBase<CS,?,?,CSM>>

Returns:

getReadOnly

public boolean getReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)