org.kuali.kra.protocol.personnel

Class ProtocolPersonnelRuleBase

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.protocol.personnel.ProtocolPersonnelRuleBase

All Implemented Interfaces:

org.kuali.rice.krad.rules.rule.AddAdHocRoutePersonRule, org.kuali.rice.krad.rules.rule.AddAdHocRouteWorkgroupRule, org.kuali.rice.krad.rules.rule.AddNoteRule, org.kuali.rice.krad.rules.rule.ApproveDocumentRule, org.kuali.rice.krad.rules.rule.BusinessRule, org.kuali.rice.krad.rules.rule.CompleteDocumentRule, org.kuali.rice.krad.rules.rule.DocumentAuditRule, org.kuali.rice.krad.rules.rule.RouteDocumentRule, org.kuali.rice.krad.rules.rule.SaveDocumentRule, org.kuali.rice.krad.rules.rule.SendAdHocRequestsRule

Direct Known Subclasses:

AddIacucProtocolPersonnelRule, AddProtocolPersonnelRule, DeleteIacucProtocolPersonnelRule, SaveIacucProtocolPersonnelRule, SaveProtocolPersonnelRule

public abstract class ProtocolPersonnelRuleBase
extends ResearchDocumentRuleBase

This class contains rules to validate protocol personnel.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_PROPERTY_EXISTING_PERSON
protected static String	ERROR_PROPERTY_NEW_PERSON
protected static String	ERROR_PROPERTY_PERSON_INDEX
protected static String	ERROR_PROPERTY_PERSON_ROLE
protected static String	ERROR_PROPERTY_PERSON_UNIT
protected static String	PERSON_INDEX
protected static String	REFERENCE_PERSON_ROLE

Fields inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME, DOCUMENT_ERROR_PATH, VALIDATION_REQUIRED

Constructor Summary

Constructors

Constructor and Description
ProtocolPersonnelRuleBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	formatErrorPropertyName(boolean newPerson, int personIndex, String errorKey) This method is to format error property for new person and persons in the list based on person index.
ProtocolPersonnelService	getProtocolPersonnelService() Gets the ProtocolBase Personnel Service.
abstract ProtocolPersonnelService	getProtocolPersonnelServiceHook()
boolean	processAddProtocolPersonnelEvent(AddProtocolPersonnelEventBase addProtocolPersonnelEvent) Runs the rules for adding a protocol personnel.
boolean	processSaveProtocolPersonnelEvent(SaveProtocolPersonnelEventBase saveProtocolPersonnelEvent) Runs the rules for saving a protocol personnel.
void	setProtocolPersonnelService(ProtocolPersonnelService protocolPersonnelService) Sets the ProtocolBase Personnel Service.

Methods inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, getParameterService, getSoftErrors, hasPermission, hasPermission, hasRole, hasRole, isInvalid, isValid, keyValue, processBudgetVersionsBusinessRule, processRunAuditBusinessRules, reportError, reportErrorWithoutFullErrorPath, reportSoftError, reportWarning, setBusinessObjectService, setParameterService

Methods inherited from class org.kuali.rice.krad.rules.DocumentRuleBase

buildDocumentTypeActionRequestPermissionDetails, buildDocumentTypePermissionDetails, getDataDictionaryService, getDictionaryValidationService, getDocumentDictionaryService, getGroupService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getPermissionService, getPersonService, hasAdHocRouteCompletion, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteCompletionToInitiator, isAdHocRouteRecipientsValid, isDocumentAttributesValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processApproveDocument, processCompleteDocument, processCustomAddAdHocRoutePersonBusinessRules, processCustomAddAdHocRouteWorkgroupBusinessRules, processCustomAddNoteBusinessRules, processCustomApproveDocumentBusinessRules, processCustomCompleteDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processCustomSaveDocumentBusinessRules, processCustomSendAdHocRequests, processRouteDocument, processSaveDocument, processSendAdHocRequests, setDocumentDictionaryService, setMaxDictionaryValidationDepth, useKimPermission, validateSensitiveDataValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_PROPERTY_NEW_PERSON

protected static final String ERROR_PROPERTY_NEW_PERSON

See Also:

Constant Field Values

ERROR_PROPERTY_EXISTING_PERSON

protected static final String ERROR_PROPERTY_EXISTING_PERSON

See Also:

Constant Field Values

ERROR_PROPERTY_PERSON_ROLE

protected static final String ERROR_PROPERTY_PERSON_ROLE

See Also:

Constant Field Values

ERROR_PROPERTY_PERSON_UNIT

protected static final String ERROR_PROPERTY_PERSON_UNIT

See Also:

Constant Field Values

ERROR_PROPERTY_PERSON_INDEX

protected static final String ERROR_PROPERTY_PERSON_INDEX

See Also:

Constant Field Values

PERSON_INDEX

protected static final String PERSON_INDEX

See Also:

Constant Field Values

REFERENCE_PERSON_ROLE

protected static final String REFERENCE_PERSON_ROLE

See Also:

Constant Field Values

Constructor Detail

ProtocolPersonnelRuleBase

public ProtocolPersonnelRuleBase()

Method Detail

processAddProtocolPersonnelEvent

public boolean processAddProtocolPersonnelEvent(AddProtocolPersonnelEventBase addProtocolPersonnelEvent)

Runs the rules for adding a protocol personnel.

Parameters:

addProtocolPersonnelEvent - The event invoking the add protocol personnel rules

Returns:

True if the protocol personnel is valid, false otherwise

formatErrorPropertyName

protected String formatErrorPropertyName(boolean newPerson,
                             int personIndex,
                             String errorKey)

This method is to format error property for new person and persons in the list based on person index. Index is applied for existing person list. For new person index is ignored. This is to display message in appropriate tab

Parameters:

newPerson -

personIndex -

errorKey -

Returns:

String - formatted error property

processSaveProtocolPersonnelEvent

public boolean processSaveProtocolPersonnelEvent(SaveProtocolPersonnelEventBase saveProtocolPersonnelEvent)

Runs the rules for saving a protocol personnel.

Parameters:

saveProtocolPersonnelEvent - The event invoking the save protocol personnel rules

Returns:

True if the protocol personnel are valid, false otherwise

getProtocolPersonnelService

public ProtocolPersonnelService getProtocolPersonnelService()

Gets the ProtocolBase Personnel Service.

Returns:

the ProtocolBase Personnel Service

getProtocolPersonnelServiceHook

public abstract ProtocolPersonnelService getProtocolPersonnelServiceHook()

setProtocolPersonnelService

public void setProtocolPersonnelService(ProtocolPersonnelService protocolPersonnelService)

Sets the ProtocolBase Personnel Service.

Parameters:

protocolPersonnelService - the ProtocolBase Personnel Service