org.kuali.kra.protocol.actions

Class ProtocolActionBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.ProtocolAssociateBase

org.kuali.kra.protocol.actions.ProtocolActionBase

All Implemented Interfaces:

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

IacucProtocolAction, ProtocolAction

public abstract class ProtocolActionBase
extends ProtocolAssociateBase

This class manages all the attributes needed to maintain a protocol action.

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

Constructor Summary

Constructors

Constructor and Description
ProtocolActionBase()
ProtocolActionBase(ProtocolBase protocol, ProtocolSubmissionBase protocolSubmission, String protocolActionTypeCode)
ProtocolActionBase(ProtocolBase protocol, String protocolActionTypeCode)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotification(KcNotification notification)
void	addProtocolNotification(KcNotification notification)
boolean	equals(Object obj)
Timestamp	getActionDate()
String	getActionDateString() This method returns an empty string of the action date is null, otherwise it returns a formated date.
Integer	getActionId()
Timestamp	getActualActionDate()
String	getActualActionDateString() This method returns an empty string of the action date is null, otherwise it returns a formated date.
protected String	getAmendmentRenewalNumber(String comment)
int	getAnswerHeaderCount(String moduleSubItemCode, String moduleItemKey, String moduleSubItemKey)
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected abstract String	getCoeusModule()
String	getComments()
CommitteeServiceBase	getCommitteeService()
protected abstract Class<? extends CommitteeServiceBase>	getCommitteeServiceClassHook()
List<KcNotification>	getFilteredProtocolNotifications()
String	getFollowupActionCode()
boolean	getIsInFilterView()
String	getPrevProtocolStatusCode()
String	getPrevSubmissionStatusCode()
Long	getProtocolActionId()
ProtocolActionTypeBase	getProtocolActionType() Refreshes the protocol action type (if it doesn't exist) and returns it.
String	getProtocolActionTypeCode()
List<ProtocolCorrespondence>	getProtocolCorrespondences()
List<KcNotification>	getProtocolNotifications()
ProtocolSubmissionBase	getProtocolSubmission() Refreshes the protocol submission (if it doesn't exist) and returns it.
List<ProtocolSubmissionDocBase>	getProtocolSubmissionDocs()
protected abstract ProtocolSubmissionQuestionnaireHelper	getProtocolSubmissionQuestionnaireHelperHook(ProtocolBase protocol, String actionTypeCode, String submissionNumber)
ProtocolSubmissionQuestionnaireHelper	getQuestionnaireHelper()
Long	getSubmissionIdFk()
Integer	getSubmissionNumber()
String	getSubmissionStatusString() This method calculates and returns the submission status as a string.
String	getSubmissionTypeCode()
int	hashCode()
protected void	initializeProtocolAction(ProtocolBase protocol, String protocolActionTypeCode)
boolean	isActiveCommitteeMember()
void	resetForeignKeys() This resets the foreign keys if there is a protocol submission.
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setActionDate(Timestamp actionDate)
void	setActionId(Integer actionId)
void	setActualActionDate(Timestamp actualActionDate)
void	setComments(String comments)
void	setCommitteeService(CommitteeServiceBase committeeService)
void	setFollowupActionCode(String followupActionCode)
void	setIsInFilterView(boolean isInFilterView)
void	setPrevProtocolStatusCode(String prevProtocolStatusCode)
void	setPrevSubmissionStatusCode(String prevSubmissionStatusCode)
void	setProtocolActionId(Long protocolActionId)
void	setProtocolActionType(ProtocolActionTypeBase protocolActionType)
void	setProtocolActionTypeCode(String protocolActionTypeCode)
void	setProtocolCorrespondences(List<ProtocolCorrespondence> protocolCorrespondences)
void	setProtocolNotifications(List<KcNotification> notifications)
void	setProtocolSubmission(ProtocolSubmissionBase protocolSubmission)
void	setProtocolSubmissionDocs(List<ProtocolSubmissionDocBase> protocolSubmissionDocs)
void	setQuestionnaireHelper(ProtocolSubmissionQuestionnaireHelper questionnaireHelper)
void	setSubmissionIdFk(Long submissionIdFk)
void	setSubmissionNumber(Integer submissionNumber)
void	setSubmissionTypeCode(String submissionTypeCode)

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

getProtocol, getProtocolId, getProtocolNumber, getSequenceNumber, getSequenceOwner, init, postInitHook, setProtocol, setProtocolId, setProtocolNumber, setSequenceNumber, 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

Constructor Detail

ProtocolActionBase

public ProtocolActionBase()

ProtocolActionBase

public ProtocolActionBase(ProtocolBase protocol,
                  ProtocolSubmissionBase protocolSubmission,
                  String protocolActionTypeCode)

ProtocolActionBase

public ProtocolActionBase(ProtocolBase protocol,
                  String protocolActionTypeCode)

Method Detail

initializeProtocolAction

protected void initializeProtocolAction(ProtocolBase protocol,
                            String protocolActionTypeCode)

getProtocolActionId

public Long getProtocolActionId()

setProtocolActionId

public void setProtocolActionId(Long protocolActionId)

getActionId

public Integer getActionId()

setActionId

public void setActionId(Integer actionId)

getProtocolActionTypeCode

public String getProtocolActionTypeCode()

setProtocolActionTypeCode

public void setProtocolActionTypeCode(String protocolActionTypeCode)

setSubmissionNumber

public void setSubmissionNumber(Integer submissionNumber)

getSubmissionNumber

public Integer getSubmissionNumber()

getSubmissionIdFk

public Long getSubmissionIdFk()

setSubmissionIdFk

public void setSubmissionIdFk(Long submissionIdFk)

getComments

public String getComments()

setComments

public void setComments(String comments)

getActualActionDate

public Timestamp getActualActionDate()

setActualActionDate

public void setActualActionDate(Timestamp actualActionDate)

getActionDate

public Timestamp getActionDate()

setActionDate

public void setActionDate(Timestamp actionDate)

setProtocolSubmission

public void setProtocolSubmission(ProtocolSubmissionBase protocolSubmission)

getProtocolSubmission

public ProtocolSubmissionBase getProtocolSubmission()

Refreshes the protocol submission (if it doesn't exist) and returns it.

Returns:

setProtocolActionType

public void setProtocolActionType(ProtocolActionTypeBase protocolActionType)

getProtocolActionType

public ProtocolActionTypeBase getProtocolActionType()

Refreshes the protocol action type (if it doesn't exist) and returns it.

Returns:

getActualActionDateString

public String getActualActionDateString()

This method returns an empty string of the action date is null, otherwise it returns a formated date.

Returns:

getActionDateString

public String getActionDateString()

This method returns an empty string of the action date is null, otherwise it returns a formated date.

Returns:

getSubmissionStatusString

public String getSubmissionStatusString()

This method calculates and returns the submission status as a string.

Returns:

getPrevSubmissionStatusCode

public String getPrevSubmissionStatusCode()

setPrevSubmissionStatusCode

public void setPrevSubmissionStatusCode(String prevSubmissionStatusCode)

getSubmissionTypeCode

public String getSubmissionTypeCode()

setSubmissionTypeCode

public void setSubmissionTypeCode(String submissionTypeCode)

getPrevProtocolStatusCode

public String getPrevProtocolStatusCode()

setPrevProtocolStatusCode

public void setPrevProtocolStatusCode(String prevProtocolStatusCode)

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.

See Also:

Sequenceable.resetPersistenceState()

resetForeignKeys

public void resetForeignKeys()

This resets the foreign keys if there is a protocol submission.

hashCode

public int hashCode()

Overrides:

hashCode in class ProtocolAssociateBase

equals

public boolean equals(Object obj)

Overrides:

equals in class ProtocolAssociateBase

getProtocolCorrespondences

public List<ProtocolCorrespondence> getProtocolCorrespondences()

setProtocolCorrespondences

public void setProtocolCorrespondences(List<ProtocolCorrespondence> protocolCorrespondences)

getProtocolNotifications

public List<KcNotification> getProtocolNotifications()

setProtocolNotifications

public void setProtocolNotifications(List<KcNotification> notifications)

getFilteredProtocolNotifications

public List<KcNotification> getFilteredProtocolNotifications()

addProtocolNotification

public void addProtocolNotification(KcNotification notification)

getProtocolSubmissionDocs

public List<ProtocolSubmissionDocBase> getProtocolSubmissionDocs()

setProtocolSubmissionDocs

public void setProtocolSubmissionDocs(List<ProtocolSubmissionDocBase> protocolSubmissionDocs)

getIsInFilterView

public boolean getIsInFilterView()

setIsInFilterView

public void setIsInFilterView(boolean isInFilterView)

getFollowupActionCode

public String getFollowupActionCode()

setFollowupActionCode

public void setFollowupActionCode(String followupActionCode)

getAnswerHeaderCount

public int getAnswerHeaderCount(String moduleSubItemCode,
                       String moduleItemKey,
                       String moduleSubItemKey)

getAmendmentRenewalNumber

protected String getAmendmentRenewalNumber(String comment)

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

isActiveCommitteeMember

public boolean isActiveCommitteeMember()

getCommitteeService

public CommitteeServiceBase getCommitteeService()

getCommitteeServiceClassHook

protected abstract Class<? extends CommitteeServiceBase> getCommitteeServiceClassHook()

setCommitteeService

public void setCommitteeService(CommitteeServiceBase committeeService)

getCoeusModule

protected abstract String getCoeusModule()

getProtocolSubmissionQuestionnaireHelperHook

protected abstract ProtocolSubmissionQuestionnaireHelper getProtocolSubmissionQuestionnaireHelperHook(ProtocolBase protocol,
                                                                                 String actionTypeCode,
                                                                                 String submissionNumber)

addNotification

public void addNotification(KcNotification notification)

getQuestionnaireHelper

public ProtocolSubmissionQuestionnaireHelper getQuestionnaireHelper()

setQuestionnaireHelper

public void setQuestionnaireHelper(ProtocolSubmissionQuestionnaireHelper questionnaireHelper)