org.kuali.kra.irb

Class Protocol

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.ProtocolBase

org.kuali.kra.irb.Protocol

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Disclosurable, Permissionable, KcKrmsContextBo, Sequenceable, SequenceAssociate<ProtocolBase>, SequenceOwner<ProtocolBase>, 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

public class Protocol
extends ProtocolBase

This class is Protocol Business Object.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.protocol.ProtocolBase

AMENDMENT_LETTER, NEXT_ACTION_ID_KEY, RENEWAL_LETTER

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
Protocol() Constructs an Protocol BO.

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
protected ProtocolSummary	createProtocolSummary()
protected List<AnswerHeader>	getAnswerHeaderForProtocol(ProtocolBase protocol)
protected String	getDefaultProtocolStatusCodeHook()
protected String	getDefaultProtocolTypeCodeHook()
String	getDocumentKey() This method returns unique key for implementing document.
String	getDocumentRoleTypeCode() Returns the type code of the document (i.e.
KrmsRulesContext	getKrmsRulesContext() This method to get the RuleContext, which is this bo's document class, of this bo class.
ProtocolAction	getLastProtocolAction()
String	getNamespace()
protected ProtocolResearchAreaBase	getNewProtocolResearchAreaInstance()
protected Class<? extends ProtocolAttachmentProtocolBase>	getProtocolAttachmentProtocolClassHook()
protected String	getProtocolModuleAddModifyAttachmentCodeHook()
ProtocolParticipant	getProtocolParticipant(int index) Gets index i from the protocol participant list.
List<ProtocolParticipant>	getProtocolParticipants()
protected ProtocolPersonnelService	getProtocolPersonnelService() This method is to get protocol personnel service
List<ProtocolRiskLevel>	getProtocolRiskLevels()
protected ProtocolStatusBase	getProtocolStatusNewInstanceHook()
ProtocolSubmission	getProtocolSubmission()
protected ProtocolSubmissionBase	getProtocolSubmissionNewInstanceHook()
protected ProtocolSubmissionStatusBase	getProtocolSubmissionStatusNewInstanceHook()
protected ProtocolSubmissionTypeBase	getProtocolSubmissionTypeNewInstanceHook()
ProtocolSummary	getProtocolSummary()
List<String>	getRoleNames() This method gets all the role names for particular document.
String	getVulnerableSubjectIndicator()
void	initializeProtocolAttachmentFilter()
boolean	isLookupActionNotifyIRBProtocol()
void	merge(ProtocolBase amendment, String protocolModuleTypeCode) This method merges the data of a specific module of the amended protocol into this protocol.
protected void	mergeProtocolAction(ProtocolBase amendment)
void	setLookupActionNotifyIRBProtocol(boolean lookupActionNotifyIRBProtocol)
void	setProtocolParticipants(List<ProtocolParticipant> protocolParticipants)
void	setProtocolRiskLevels(List<ProtocolRiskLevel> protocolRiskLevels)
void	setVulnerableSubjectIndicator(String vulnerableSubjectIndicator)

Methods inherited from class org.kuali.kra.protocol.ProtocolBase

addAdditionalInfoSummary, addAttachmentsByType, addAttachmentSummaries, addFundingSourceSummaries, addOrganizationSummaries, addPersonnelSummaries, addProtocolResearchAreas, addResearchAreaSummaries, addSpecialReview, addSpecialReviewSummaries, amendQuestionnaire, cleanupSpecialReviews, deepCopy, filterOutProtocolPersonnel, getActiveAttachmentProtocols, getActiveAttachmentProtocolsNoDelete, getAmendedProtocolNumber, getApplicationDate, getApprovalDate, getAttachmentPersonnels, getAttachmentProtocol, getAttachmentProtocols, getBusinessObjectService, getCorrespondentIndicator, getDateTimeService, getDefaultNewDescription, getDescription, getDocumentNumberForPermission, getDocumentUnitNumber, getExpirationDate, getFdaApplicationNumber, getFilteredAttachmentProtocols, getFundingSource, getFundingSourceIndicator, getInitialSubmissionDate, getInitiatorLastUpdated, getInvestigator, getKeyPerson, getKeyStudyPersonIndicator, getLastApprovalDate, getLeadUnit, getLeadUnitName, getLeadUnitNumber, getNewDescription, getNextValue, getNotepad, getNotepads, getNotifyIrbSubmissionId, getOwnerSequenceNumber, getParameterService, getPerformingOrganizationId, getPrincipalInvestigator, getPrincipalInvestigatorId, getPrincipalInvestigatorName, getProjectId, getProjectName, getProtocolActions, getProtocolAmendRenewal, getProtocolAmendRenewals, getProtocolAttachmentFilter, getProtocolDocument, getProtocolFundingSources, getProtocolId, getProtocolLocations, getProtocolLocationService, getProtocolNumber, getProtocolOnlineReviews, getProtocolPerson, getProtocolPersons, getProtocolReferences, getProtocolResearchAreas, getProtocolResearchAreas, getProtocolStatus, getProtocolStatusCode, getProtocolSubmissions, getProtocolSubmissionStatus, getProtocolType, getProtocolTypeCode, getQuestionnaireAnswerService, getReferenceIndicator, getReferenceNumber1, getReferenceNumber2, getRelatedProjectsIndicator, getResearchAreaCode, getSequenceAccessorService, getSequenceNumber, getSequenceOwner, getSortedActions, getSpecialReview, getSpecialReviewIndicator, getSpecialReviews, getSubmissionDate, getTitle, getVersionNameField, incrementSequenceNumber, isActive, isAmendment, isCorrectionMode, isEmptyProtocolResearchAreas, isFollowupAction, isLookupActionAmendRenewProtocol, isLookupActionRequestProtocol, isLookupPendingPIActionProtocol, isLookupPendingProtocol, isLookupProtocolPersonId, isMemberInProtocolPersonnel, isMergeAmendment, isNew, isNonEmployeeFlag, isRenewal, isRenewalWithoutAmendment, isUserNamedInProtocol, isVersioningRequired, merge, merge, mergeAttachments, mergeFundingSources, mergeGeneralInfo, mergeNotepads, mergeOrganizations, mergeOthers, mergePersonnel, mergeProtocolPermissions, mergeProtocolQuestionnaire, mergeProtocolSubmission, mergeReferences, mergeResearchAreas, mergeSpecialReview, populateAdditionalQualifiedRoleAttributes, removeAttachmentsByType, removeOldQuestionnaire, resetForeignKeys, resetPersistenceState, resetPersistenceStateForNotifications, restoreAttachments, setActive, setApprovalDate, setAttachmentProtocols, setCorrectionMode, setCorrespondentIndicator, setDescription, setExpirationDate, setFdaApplicationNumber, setFundingSource, setFundingSourceIndicator, setInitialSubmissionDate, setInvestigator, setKeyPerson, setKeyStudyPersonIndicator, setLastApprovalDate, setLeadUnitName, setLeadUnitNumber, setLookupActionAmendRenewProtocol, setLookupActionRequestProtocol, setLookupPendingPIActionProtocol, setLookupPendingProtocol, setLookupProtocolPersonId, setMergeAmendment, setNewDescription, setNonEmployeeFlag, setNotepads, setNotifyIrbSubmissionId, setPerformingOrganizationId, setPrincipalInvestigatorId, setProtocolActions, setProtocolAmendRenewal, setProtocolAmendRenewals, setProtocolAttachmentFilter, setProtocolDocument, setProtocolFundingSources, setProtocolId, setProtocolLocations, setProtocolNumber, setProtocolPersons, setProtocolReferences, setProtocolResearchAreas, setProtocolStatus, setProtocolStatusCode, setProtocolSubmission, setProtocolSubmissions, setProtocolType, setProtocolTypeCode, setReferenceIndicator, setReferenceNumber1, setReferenceNumber2, setRelatedProjectsIndicator, setResearchAreaCode, setSequenceNumber, setSequenceOwner, setSpecialReviewIndicator, setSpecialReviews, setTitle

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

Protocol

public Protocol()

Constructs an Protocol BO.

Method Detail

getVulnerableSubjectIndicator

public String getVulnerableSubjectIndicator()

setVulnerableSubjectIndicator

public void setVulnerableSubjectIndicator(String vulnerableSubjectIndicator)

getProtocolRiskLevels

public List<ProtocolRiskLevel> getProtocolRiskLevels()

setProtocolRiskLevels

public void setProtocolRiskLevels(List<ProtocolRiskLevel> protocolRiskLevels)

getProtocolParticipants

public List<ProtocolParticipant> getProtocolParticipants()

setProtocolParticipants

public void setProtocolParticipants(List<ProtocolParticipant> protocolParticipants)

getProtocolParticipant

public ProtocolParticipant getProtocolParticipant(int index)

Gets index i from the protocol participant list.

Parameters:

index -

Returns:

protocol participant at index i

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class ProtocolBase

getProtocolPersonnelService

protected ProtocolPersonnelService getProtocolPersonnelService()

This method is to get protocol personnel service

Specified by:

getProtocolPersonnelService in class ProtocolBase

Returns:

protocolPersonnelService

getProtocolSubmission

public ProtocolSubmission getProtocolSubmission()

Overrides:

getProtocolSubmission in class ProtocolBase

getLastProtocolAction

public ProtocolAction getLastProtocolAction()

Overrides:

getLastProtocolAction in class ProtocolBase

merge

public void merge(ProtocolBase amendment,
         String protocolModuleTypeCode)

This method merges the data of a specific module of the amended protocol into this protocol.

Specified by:

merge in class ProtocolBase

Parameters:

amendment -

protocolModuleTypeCode -

getAnswerHeaderForProtocol

protected List<AnswerHeader> getAnswerHeaderForProtocol(ProtocolBase protocol)

Specified by:

getAnswerHeaderForProtocol in class ProtocolBase

mergeProtocolAction

protected void mergeProtocolAction(ProtocolBase amendment)

Specified by:

mergeProtocolAction in class ProtocolBase

getProtocolSummary

public ProtocolSummary getProtocolSummary()

Specified by:

getProtocolSummary in class ProtocolBase

createProtocolSummary

protected ProtocolSummary createProtocolSummary()

Specified by:

createProtocolSummary in class ProtocolBase

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Specified by:

getDocumentKey in class ProtocolBase

Returns:

See Also:

Permissionable.getDocumentKey()

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

Specified by:

getRoleNames in class ProtocolBase

Returns:

See Also:

Permissionable.getRoleNames()

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Permissionable

Specified by:

getNamespace in class ProtocolBase

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

Specified by:

getDocumentRoleTypeCode in class ProtocolBase

Returns:

typeCode of document

See Also:

UnitAclLoadable.getDocumentRoleTypeCode()

initializeProtocolAttachmentFilter

public void initializeProtocolAttachmentFilter()

Specified by:

initializeProtocolAttachmentFilter in class ProtocolBase

getKrmsRulesContext

public KrmsRulesContext getKrmsRulesContext()

Description copied from interface: KcKrmsContextBo

This method to get the RuleContext, which is this bo's document class, of this bo class.

Returns:

getProtocolStatusNewInstanceHook

protected ProtocolStatusBase getProtocolStatusNewInstanceHook()

Specified by:

getProtocolStatusNewInstanceHook in class ProtocolBase

getDefaultProtocolStatusCodeHook

protected String getDefaultProtocolStatusCodeHook()

Specified by:

getDefaultProtocolStatusCodeHook in class ProtocolBase

getDefaultProtocolTypeCodeHook

protected String getDefaultProtocolTypeCodeHook()

Specified by:

getDefaultProtocolTypeCodeHook in class ProtocolBase

getNewProtocolResearchAreaInstance

protected ProtocolResearchAreaBase getNewProtocolResearchAreaInstance()

Specified by:

getNewProtocolResearchAreaInstance in class ProtocolBase

getProtocolSubmissionStatusNewInstanceHook

protected ProtocolSubmissionStatusBase getProtocolSubmissionStatusNewInstanceHook()

Specified by:

getProtocolSubmissionStatusNewInstanceHook in class ProtocolBase

getProtocolSubmissionTypeNewInstanceHook

protected ProtocolSubmissionTypeBase getProtocolSubmissionTypeNewInstanceHook()

Specified by:

getProtocolSubmissionTypeNewInstanceHook in class ProtocolBase

getProtocolSubmissionNewInstanceHook

protected ProtocolSubmissionBase getProtocolSubmissionNewInstanceHook()

Specified by:

getProtocolSubmissionNewInstanceHook in class ProtocolBase

getProtocolModuleAddModifyAttachmentCodeHook

protected String getProtocolModuleAddModifyAttachmentCodeHook()

Specified by:

getProtocolModuleAddModifyAttachmentCodeHook in class ProtocolBase

getProtocolAttachmentProtocolClassHook

protected Class<? extends ProtocolAttachmentProtocolBase> getProtocolAttachmentProtocolClassHook()

Specified by:

getProtocolAttachmentProtocolClassHook in class ProtocolBase

isLookupActionNotifyIRBProtocol

public boolean isLookupActionNotifyIRBProtocol()

setLookupActionNotifyIRBProtocol

public void setLookupActionNotifyIRBProtocol(boolean lookupActionNotifyIRBProtocol)