org.kuali.kra.protocol.onlinereview

Class ProtocolOnlineReviewBase

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.ProtocolOnlineReviewBase

All Implemented Interfaces:

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

IacucProtocolOnlineReview, ProtocolOnlineReview

public abstract class ProtocolOnlineReviewBase
extends KraPersistableBusinessObjectBase
implements Permissionable, UnitAclLoadable

This class encapsulates the notion of a protocol review. Essentially a join between protocol, submission, and a reviewer. The ProtocolReview is created by the IRB Admin as request.

See Also:

Serialized Form

Field Summary

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
ProtocolOnlineReviewBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionPerformed(String action) This method is to add action performed for this OLR.
List	buildListOfDeletionAwareLists()
String	getActionsPerformed()
List<CommitteeScheduleMinuteBase>	getCommitteeScheduleMinutes() Gets the committeeScheduleMinutes attribute.
Date	getDateDue() Gets the dueDate attribute.
Date	getDateRequested() Gets the dateRequested attribute.
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() Returns the type code of the document (i.e.
String	getDocumentUnitNumber() Returns the unit number of the unit to which the document belongs to.
String	getLeadUnitNumber()
ProtocolBase	getLookupProtocol()
String	getLookupProtocolOnlineReviewStatusCode()
String	getLookupReviewerFullName() Gets the loopReviewerFullName attribute.
KcPerson	getLookupReviewerPerson() Gets the lookupReviewerPerson attribute.
String	getLookupReviewerPersonId() Gets the lookupReviewerPersonId attribute.
Rolodex	getLookupReviewerRolodex() Gets the lookupReviewerRolodex attribute.
Integer	getLookupReviewerRolodexId() Gets the lookupReviewerRolodexId attribute.
String	getNamespace()
ProtocolBase	getProtocol() Gets the protocol attribute.
Long	getProtocolId() Gets the protocolId attribute.
protected abstract String	getProtocolOLRFinalStatusCodeHook()
protected abstract String	getProtocolOLRRemovedCancelledStatusCodeHook()
ProtocolOnlineReviewDeterminationRecommendationBase	getProtocolOnlineReviewDeterminationRecommendation() Gets the protocolReviewDeterminationRecommendation attribute.
Long	getProtocolOnlineReviewDeterminationRecommendationCode() Gets the protocolReviewDeterminationRecommendationCode attribute.
ProtocolOnlineReviewDocumentBase	getProtocolOnlineReviewDocument() Gets the protocolReviewDocument attribute.
Long	getProtocolOnlineReviewId() Gets the protocolReviewId attribute.
ProtocolOnlineReviewStatus	getProtocolOnlineReviewStatus() Gets the protocolReviewStatus attribute.
String	getProtocolOnlineReviewStatusCode() Gets the protocolReviewStatusCode attribute.
ProtocolReviewer	getProtocolReviewer() Gets the protocolReviewer attribute.
Long	getProtocolReviewerId() Gets the protocolReviewerId attribute.
ProtocolSubmissionBase	getProtocolSubmission() Gets the protocolSubmission attribute.
Date	getResultDueDate() Returns the dateDue if it is non-empty; otherwise, returns the scheduled meeting date.
List<ProtocolReviewAttachmentBase>	getReviewAttachments()
String	getReviewerTypeCode()
String	getReviewerUserName() get the reviewer user name of the last action performed if last action is reviewer approve OLR doc.
List<String>	getRoleNames() This method gets all the role names for particular document.
Long	getSubmissionIdFk() Gets the submissionIdFk attribute.
boolean	isActive()
boolean	isAdminAccepted()
boolean	isReviewerApproved()
boolean	isStatusMatched(String docStatus) check if the OLR is reviewer or admin approved.
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	removeLastAction() after undo last action, OLR will be versioned.
void	resetPersistenceState()
void	setActionsPerformed(String actionsPerformed)
void	setAdminAccepted(boolean adminAccepted)
void	setCommitteeScheduleMinutes(List<CommitteeScheduleMinuteBase> committeeScheduleMinutes) Sets the committeeScheduleMinutes attribute value.
void	setDateDue(Date dateDue) Sets the dueDate attribute value.
void	setDateRequested(Date dateRequested) Sets the dateRequested attribute value.
void	setLookupProtocol(ProtocolBase lookupProtocol)
void	setLookupProtocolOnlineReviewStatusCode(String lookupProtocolOnlineReviewStatusCode)
void	setLookupReviewerFullName(String loopReviewerFullName) Sets the loopReviewerFullName attribute value.
void	setLookupReviewerPerson(KcPerson lookupReviewerPerson) Sets the lookupReviewerPerson attribute value.
void	setLookupReviewerPersonId(String lookupReviewerPersonId) Sets the lookupReviewerPersonId attribute value.
void	setLookupReviewerRolodex(Rolodex lookupReviewerRolodex) Sets the lookupReviewerRolodex attribute value.
void	setLookupReviewerRolodexId(Integer lookupReviewerRolodexId) Sets the lookupReviewerRolodexId attribute value.
void	setProtocol(ProtocolBase protocol) Sets the protocol attribute value.
void	setProtocolId(Long protocolId) Sets the protocolId attribute value.
void	setProtocolOnlineReviewDeterminationRecommendation(ProtocolOnlineReviewDeterminationRecommendationBase protocolOnlineReviewDeterminationRecommendation) Sets the protocolReviewDeterminationRecommendation attribute value.
void	setProtocolOnlineReviewDeterminationRecommendationCode(Long protocolOnlineReviewDeterminationRecommendationCode) Sets the protocolReviewDeterminationRecommendationCode attribute value.
void	setProtocolOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument) Sets the protocolReviewDocument attribute value.
void	setProtocolOnlineReviewId(Long protocolOnlineReviewId) Sets the protocolReviewId attribute value.
void	setProtocolOnlineReviewStatus(ProtocolOnlineReviewStatus protocolOnlineReviewStatus) Sets the protocolReviewStatus attribute value.
void	setProtocolOnlineReviewStatusCode(String protocolOnlineReviewStatusCode) Sets the protocolReviewStatusCode attribute value.
void	setProtocolReviewer(ProtocolReviewer protocolReviewer) Sets the protocolReviewer attribute value.
void	setProtocolReviewerId(Long protocolReviewerId) Sets the protocolReviewerId attribute value.
void	setProtocolSubmission(ProtocolSubmissionBase protocolSubmission) Sets the protocolSubmission attribute value.
void	setReviewAttachments(List<ProtocolReviewAttachmentBase> reviewAttachments)
void	setReviewerApproved(boolean reviewerApproved)
void	setReviewerTypeCode(String reviewerTypeCode)
void	setSubmissionIdFk(Long submissionIdFk) Sets the submissionIdFk attribute value.

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, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

toString

Constructor Detail

ProtocolOnlineReviewBase

public ProtocolOnlineReviewBase()

Method Detail

getProtocolOnlineReviewId

public Long getProtocolOnlineReviewId()

Gets the protocolReviewId attribute.

Returns:

Returns the protocolReviewId.

setProtocolOnlineReviewId

public void setProtocolOnlineReviewId(Long protocolOnlineReviewId)

Sets the protocolReviewId attribute value.

Parameters:

protocolOnlineReviewId - The protocolReviewId to set.

getProtocolId

public Long getProtocolId()

Gets the protocolId attribute.

Returns:

Returns the protocolId.

setProtocolId

public void setProtocolId(Long protocolId)

Sets the protocolId attribute value.

Parameters:

protocolId - The protocolId to set.

getSubmissionIdFk

public Long getSubmissionIdFk()

Gets the submissionIdFk attribute.

Returns:

Returns the submissionIdFk.

setSubmissionIdFk

public void setSubmissionIdFk(Long submissionIdFk)

Sets the submissionIdFk attribute value.

Parameters:

submissionIdFk - The submissionIdFk to set.

getProtocolOnlineReviewStatusCode

public String getProtocolOnlineReviewStatusCode()

Gets the protocolReviewStatusCode attribute.

Returns:

Returns the protocolReviewStatusCode.

setProtocolOnlineReviewStatusCode

public void setProtocolOnlineReviewStatusCode(String protocolOnlineReviewStatusCode)

Sets the protocolReviewStatusCode attribute value.

Parameters:

protocolOnlineReviewStatusCode - The protocolReviewStatusCode to set.

getDateDue

public Date getDateDue()

Gets the dueDate attribute.

Returns:

Returns the dueDate.

setDateDue

public void setDateDue(Date dateDue)

Sets the dueDate attribute value.

Parameters:

dateDue - The dueDate to set.

getDateRequested

public Date getDateRequested()

Gets the dateRequested attribute.

Returns:

Returns the dateRequested.

setDateRequested

public void setDateRequested(Date dateRequested)

Sets the dateRequested attribute value.

Parameters:

dateRequested - The dateRequested to set.

getProtocol

public ProtocolBase getProtocol()

Gets the protocol attribute.

Returns:

Returns the protocol.

setProtocol

public void setProtocol(ProtocolBase protocol)

Sets the protocol attribute value.

Parameters:

protocol - The protocol to set.

getProtocolSubmission

public ProtocolSubmissionBase getProtocolSubmission()

Gets the protocolSubmission attribute.

Returns:

Returns the protocolSubmission.

setProtocolSubmission

public void setProtocolSubmission(ProtocolSubmissionBase protocolSubmission)

Sets the protocolSubmission attribute value.

Parameters:

protocolSubmission - The protocolSubmission to set.

getProtocolOnlineReviewStatus

public ProtocolOnlineReviewStatus getProtocolOnlineReviewStatus()

Gets the protocolReviewStatus attribute.

Returns:

Returns the protocolReviewStatus.

setProtocolOnlineReviewStatus

public void setProtocolOnlineReviewStatus(ProtocolOnlineReviewStatus protocolOnlineReviewStatus)

Sets the protocolReviewStatus attribute value.

Parameters:

protocolOnlineReviewStatus - The protocolReviewStatus to set.

getProtocolOnlineReviewDeterminationRecommendationCode

public Long getProtocolOnlineReviewDeterminationRecommendationCode()

Gets the protocolReviewDeterminationRecommendationCode attribute.

Returns:

Returns the protocolReviewDeterminationRecommendationCode.

setProtocolOnlineReviewDeterminationRecommendationCode

public void setProtocolOnlineReviewDeterminationRecommendationCode(Long protocolOnlineReviewDeterminationRecommendationCode)

Sets the protocolReviewDeterminationRecommendationCode attribute value.

Parameters:

protocolOnlineReviewDeterminationRecommendationCode - The protocolReviewDeterminationRecommendationCode to set.

getProtocolOnlineReviewDeterminationRecommendation

public ProtocolOnlineReviewDeterminationRecommendationBase getProtocolOnlineReviewDeterminationRecommendation()

Gets the protocolReviewDeterminationRecommendation attribute.

Returns:

Returns the protocolReviewDeterminationRecommendation.

setProtocolOnlineReviewDeterminationRecommendation

public void setProtocolOnlineReviewDeterminationRecommendation(ProtocolOnlineReviewDeterminationRecommendationBase protocolOnlineReviewDeterminationRecommendation)

Sets the protocolReviewDeterminationRecommendation attribute value.

Parameters:

protocolOnlineReviewDeterminationRecommendation - The protocolReviewDeterminationRecommendation to set.

getProtocolReviewerId

public Long getProtocolReviewerId()

Gets the protocolReviewerId attribute.

Returns:

Returns the protocolReviewerId.

setProtocolReviewerId

public void setProtocolReviewerId(Long protocolReviewerId)

Sets the protocolReviewerId attribute value.

Parameters:

protocolReviewerId - The protocolReviewerId to set.

getProtocolReviewer

public ProtocolReviewer getProtocolReviewer()

Gets the protocolReviewer attribute.

Returns:

Returns the protocolReviewer.

setProtocolReviewer

public void setProtocolReviewer(ProtocolReviewer protocolReviewer)

Sets the protocolReviewer attribute value.

Parameters:

protocolReviewer - The protocolReviewer to set.

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()

Description copied from interface: UnitAclLoadable

Returns the type code of the document (i.e. Proposal, Protocol, etc).

Specified by:

getDocumentRoleTypeCode in interface Permissionable

Specified by:

getDocumentRoleTypeCode in interface UnitAclLoadable

Returns:

typeCode of document

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

getDocumentUnitNumber

public String getDocumentUnitNumber()

Description copied from interface: UnitAclLoadable

Returns the unit number of the unit to which the document belongs to.

Specified by:

getDocumentUnitNumber in interface UnitAclLoadable

Returns:

unitNumber of document

getCommitteeScheduleMinutes

public List<CommitteeScheduleMinuteBase> getCommitteeScheduleMinutes()

Gets the committeeScheduleMinutes attribute.

Returns:

Returns the committeeScheduleMinutes.

setCommitteeScheduleMinutes

public void setCommitteeScheduleMinutes(List<CommitteeScheduleMinuteBase> committeeScheduleMinutes)

Sets the committeeScheduleMinutes attribute value.

Parameters:

committeeScheduleMinutes - The committeeScheduleMinutes to set.

getProtocolOnlineReviewDocument

public ProtocolOnlineReviewDocumentBase getProtocolOnlineReviewDocument()

Gets the protocolReviewDocument attribute.

Returns:

Returns the protocolReviewDocument.

setProtocolOnlineReviewDocument

public void setProtocolOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument)

Sets the protocolReviewDocument attribute value.

Parameters:

protocolOnlineReviewDocument - The protocolReviewDocument to set.

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

resetPersistenceState

public void resetPersistenceState()

getLookupReviewerRolodexId

public Integer getLookupReviewerRolodexId()

Gets the lookupReviewerRolodexId attribute.

Returns:

Returns the lookupReviewerRolodexId.

setLookupReviewerRolodexId

public void setLookupReviewerRolodexId(Integer lookupReviewerRolodexId)

Sets the lookupReviewerRolodexId attribute value.

Parameters:

lookupReviewerRolodexId - The lookupReviewerRolodexId to set.

getLookupReviewerPersonId

public String getLookupReviewerPersonId()

Gets the lookupReviewerPersonId attribute.

Returns:

Returns the lookupReviewerPersonId.

setLookupReviewerPersonId

public void setLookupReviewerPersonId(String lookupReviewerPersonId)

Sets the lookupReviewerPersonId attribute value.

Parameters:

lookupReviewerPersonId - The lookupReviewerPersonId to set.

getLookupReviewerRolodex

public Rolodex getLookupReviewerRolodex()

Gets the lookupReviewerRolodex attribute.

Returns:

Returns the lookupReviewerRolodex.

setLookupReviewerRolodex

public void setLookupReviewerRolodex(Rolodex lookupReviewerRolodex)

Sets the lookupReviewerRolodex attribute value.

Parameters:

lookupReviewerRolodex - The lookupReviewerRolodex to set.

getLookupReviewerPerson

public KcPerson getLookupReviewerPerson()

Gets the lookupReviewerPerson attribute.

Returns:

Returns the lookupReviewerPerson.

setLookupReviewerPerson

public void setLookupReviewerPerson(KcPerson lookupReviewerPerson)

Sets the lookupReviewerPerson attribute value.

Parameters:

lookupReviewerPerson - The lookupReviewerPerson to set.

getLookupReviewerFullName

public String getLookupReviewerFullName()

Gets the loopReviewerFullName attribute.

Returns:

Returns the loopReviewerFullName.

setLookupReviewerFullName

public void setLookupReviewerFullName(String loopReviewerFullName)

Sets the loopReviewerFullName attribute value.

Parameters:

loopReviewerFullName - The loopReviewerFullName to set.

isActive

public boolean isActive()

getProtocolOLRRemovedCancelledStatusCodeHook

protected abstract String getProtocolOLRRemovedCancelledStatusCodeHook()

getLookupProtocol

public ProtocolBase getLookupProtocol()

setLookupProtocol

public void setLookupProtocol(ProtocolBase lookupProtocol)

getLookupProtocolOnlineReviewStatusCode

public String getLookupProtocolOnlineReviewStatusCode()

setLookupProtocolOnlineReviewStatusCode

public void setLookupProtocolOnlineReviewStatusCode(String lookupProtocolOnlineReviewStatusCode)

getResultDueDate

public Date getResultDueDate()

Returns the dateDue if it is non-empty; otherwise, returns the scheduled meeting date.

Returns:

dateDue if not-null, otherwise scheduled meeting date

getActionsPerformed

public String getActionsPerformed()

setActionsPerformed

public void setActionsPerformed(String actionsPerformed)

addActionPerformed

public void addActionPerformed(String action)

This method is to add action performed for this OLR. This used as audit trail and be used when undo action.

Parameters:

action -

isReviewerApproved

public boolean isReviewerApproved()

setReviewerApproved

public void setReviewerApproved(boolean reviewerApproved)

isAdminAccepted

public boolean isAdminAccepted()

setAdminAccepted

public void setAdminAccepted(boolean adminAccepted)

isStatusMatched

public boolean isStatusMatched(String docStatus)

check if the OLR is reviewer or admin approved. Then decided what's to do with the versioned OLR doc

getProtocolOLRFinalStatusCodeHook

protected abstract String getProtocolOLRFinalStatusCodeHook()

getReviewerUserName

public String getReviewerUserName()

get the reviewer user name of the last action performed if last action is reviewer approve OLR doc.

removeLastAction

public void removeLastAction()

after undo last action, OLR will be versioned. remove the last actionperformed from "actionsPerformed" In case, this OLR is finalized again and undo.

getReviewerTypeCode

public String getReviewerTypeCode()

setReviewerTypeCode

public void setReviewerTypeCode(String reviewerTypeCode)

getReviewAttachments

public List<ProtocolReviewAttachmentBase> getReviewAttachments()

setReviewAttachments

public void setReviewAttachments(List<ProtocolReviewAttachmentBase> reviewAttachments)