org.kuali.kra.rules

Class ResearchDocumentRuleBase

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

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:

AddAlternateSearchRule, AddCoiReviewerRule, AddDisclosureReporterUnitRule, AddManualProjectRule, AddNotificationRecipientRule, AddOnlineReviewAttachmentRule, AddOnlineReviewAttachmentRule, AddProcedureLocationRule, AddProcedurePersonResponsibleRule, AddProtocolStudyGroupRule, AwardApprovedEquipmentRuleImpl, AwardApprovedForeignTravelRuleImpl, AwardApprovedSubawardRuleImpl, AwardBenefitsRatesRuleImpl, AwardCloseoutRuleImpl, AwardCommentsRuleImpl, AwardDetailsAndDatesRuleImpl, AwardDirectFandADistributionRuleImpl, AwardDocumentRule, AwardFandaRateRule, AwardNoteAddRule, AwardPaymentScheduleRuleImpl, AwardPersonCreditSplitRuleImpl, AwardPersonUnitCreditSplitRuleImpl, AwardReportTermRecipientRuleImpl, AwardReportTermRuleImpl, AwardSponsorTermRuleImpl, BaseQuestionnaireAuditRule, BudgetExpensesAuditRule, BudgetPeriodAuditRule, BudgetPeriodRule, BudgetPersonnelAuditRule, BudgetRateAuditRule, CertifyDisclosureRule, CoiDisclosureDocumentRule, CommitteeActionFilterBatchCorrespondenceHistoryRule, CommitteeActionGenerateBatchCorrespondenceRuleBase, CommitteeActionPrintCommitteeDocumentRule, CommitteeActionPrintCommitteeDocumentRule, CommitteeActionViewBatchCorrespondenceRule, CommitteeDecisionRuleBase, CommitteeDocumentRuleBase, CommitteeMembershipRule, CommitteeScheduleDateConflictRule, CommitteeScheduleDateConflictRule, CommitteeScheduleDayRule, CommitteeScheduleDayRule, CommitteeScheduleDeadlineDateRule, CommitteeScheduleDeadlineDateRule, CommitteeScheduleFilterDatesRule, CommitteeScheduleFilterDatesRule, CommitteeScheduleStartAndEndDateRule, CommitteeScheduleStartAndEndDateRule, CommitteeScheduleTimeRule, CommitteeScheduleTimeRule, CommitteeScheduleWeekDayRule, CommitteeScheduleWeekDayRule, CostShareRuleResearchDocumentBase, CreateAmendmentRuleBase, CreateContinuationRuleBase, CreateRenewalRuleBase, CustomDataRule, DeleteCommitteeMemberRuleBase, DeleteCommitteeScheduleRuleBase, DisclosureFinancialEntityAuditRule, FinancialEntityAttachmentRule, IacucProtocolAssignCmtRuleImpl, IacucProtocolModifySubmissionRuleImpl, IacucProtocolOnlineReviewDocumentRule, IacucProtocolRequestRule, InstitutionalProposalDocumentRule, InstitutionalProposalFinancialRuleImpl, InstitutionalProposalNoteAddRule, InstitutionalProposalPersonCreditSplitRuleImpl, InstitutionalProposalPersonUnitCreditSplitRuleImpl, InstitutionalProposalRuleImpl, InstitutionalProposalSponsorAndProgramRuleImpl, InstitutionalProposalUnrecoveredFandARuleImpl, KeyPersonnelAuditRule, LookupProtocolFundingSourceRule, LookupProtocolFundingSourceRule, MeetingAddAttachmentsRule, MeetingAddMinuteRuleBase, MeetingAddOtherRule, MeetingDeleteOtherRule, MeetingPresentOtherOrVotingRule, MeetingSaveRule, ModifyAmendmentSectionsRuleBase, NegotiationDocumentRule, PerformPersonMassChangeRule, PermissionsRuleBase, PersonCustomDataRuleBase, PersonMassChangeDocumentRule, ProposalBudgetDataOverrideRule, ProposalDevelopmentAbstractsRule, ProposalDevelopmentCopyRule, ProposalDevelopmentDataOverrideRule, ProposalDevelopmentDocumentRule, ProposalDevelopmentInstituteAttachmentRule, ProposalDevelopmentKeyPersonsRule, ProposalDevelopmentNarrativeRule, ProposalDevelopmentPermissionsRule, ProposalDevelopmentPersonnelAttachmentRule, ProposalDevelopmentProposalLocationRule, ProposalDevelopmentQuestionnaireAuditRule, ProposalDevelopmentRejectionRule, ProposalDevelopmentResubmissionPromptRule, ProposalDevelopmentS2sQuestionnaireAuditRule, ProposalDevelopmentYnqAuditRule, ProposalSiteRule, ProtocolActionPrintRule, ProtocolActionPrintRule, ProtocolAddReviewAttachmentRule, ProtocolAddReviewCommentRuleBase, ProtocolAddRiskLevelRule, ProtocolAdminCorrectionRule, ProtocolAdminCorrectionRuleBase, ProtocolApproveRule, ProtocolApproveRuleBase, ProtocolAssignCmtSchedRule, ProtocolAssignReviewersRule, ProtocolAssignToAgendaRule, ProtocolAssignToAgendaRuleBase, ProtocolAttachmentPersonnelRuleBase, ProtocolDocumentRuleBase, ProtocolExceptionRule, ProtocolFundingSourceAuditRuleBase, ProtocolFundingSourceRuleBase, ProtocolGenericActionRuleBase, ProtocolGrantExemptionRule, ProtocolHistoryFilterDatesRule, ProtocolLocationRuleBase, ProtocolManageReviewAttachmentRule, ProtocolModifySubmissionRule, ProtocolOnlineReviewDocumentRule, ProtocolOnlineReviewDocumentRule, ProtocolParticipantRuleBase, ProtocolParticipantRuleBase, ProtocolPersonnelAuditRuleBase, ProtocolPersonnelRuleBase, ProtocolReferenceRuleBase, ProtocolRequestRule, ProtocolResearchAreaAuditRuleBase, ProtocolReviewNotRequiredRule, ProtocolReviewNotRequiredRuleBase, ProtocolSpeciesRule, ProtocolSubmitActionRule, ProtocolSubmitActionRuleBase, ProtocolUnitRuleBase, ProtocolUpdateRiskLevelRule, SaveDisclosureReporterUnitRule, SaveFinancialEntityRule, SaveProtocolFundingSourceLinkRule, SaveProtocolFundingSourceLinkRule, SendNotificationRule, SpecialReviewRuleBase, SubAwardAuditRule, SubAwardDocumentRule, SubAwardFinancialAuditRule, TimeAndMoneyAwardAmountTransactionRuleImpl, TimeAndMoneyAwardDateSaveRuleImpl, TimeAndMoneyDocumentRule, TransactionRuleImpl, UndoLastActionRule

public abstract class ResearchDocumentRuleBase
extends org.kuali.rice.krad.rules.DocumentRuleBase
implements org.kuali.rice.krad.rules.rule.DocumentAuditRule

Base implementation class for KRA document business rules

Version:

$Revision: 1.13 $

Author:

$Author: gmcgrego $

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME
static String	DOCUMENT_ERROR_PATH
static boolean	VALIDATION_REQUIRED

Constructor Summary

Constructors

Constructor and Description
ResearchDocumentRuleBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAuditError(org.kuali.rice.kns.util.AuditError error, String errorKey, String clusterLabel, String clusterCategory) Delegates to ErrorReporter#reportAuditError(AuditError, String, String, String) to keep api compatibility.
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Locate in Spring the BusinessObjectService singleton instance
ErrorReporter	getErrorReporter() Gets the error reporter.
protected org.kuali.rice.kns.service.DictionaryValidationService	getKnsDictionaryValidationService()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
Map<String,Collection<SoftError>>	getSoftErrors() Delegates to ErrorReporter#getSoftErrors() to keep api compatibility.
protected boolean	hasPermission(ProposalDevelopmentDocument doc, String permissionName) Does the current user have the given permission for the proposal?
protected boolean	hasPermission(String userId, ProposalDevelopmentDocument doc, String permissionName) Does the given user have the given permission for the proposal?
protected boolean	hasRole(ProposalDevelopmentDocument doc, String roleName) Does the current user have the given role for the proposal?
protected boolean	hasRole(String userId, ProposalDevelopmentDocument doc, String roleName) Does the given user have the given role for the proposal?
protected boolean	isInvalid(Class<?> boClass, Map.Entry<String,String>... entries) The opposite of #isValid(Class, SimpleEntry...)
protected boolean	isValid(Class<?> boClass, Map.Entry<String,String>... entries) Is the given code valid? Query the database for a matching code If found, it is valid; otherwise it is invalid.
protected Map.Entry<String,String>	keyValue(String key, Object value) Convenience method for creating a AbstractMap.SimpleEntry out of a key/value pair
protected boolean	processBudgetVersionsBusinessRule(BudgetParentDocument budgetParentDocument, boolean runDatactionaryValidation) This method checks budget versions business rules.
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
protected void	reportError(String propertyName, String errorKey, String... errorParams) Delegates to ErrorReporter#reportError(String, String, String...) to keep api compatibility.
protected void	reportErrorWithoutFullErrorPath(String propertyName, String errorKey, String... errorParams) Wrapper around global errorMap.put call, to allow better logging
protected void	reportSoftError(String propertyName, String errorKey, String... errorParams) Delegates to ErrorReporter#reportSoftError(String, String, String...) to keep api compatibility.
protected void	reportWarning(String propertyName, String errorKey, String... errorParams) Delegates to ErrorReporter#reportError(String, String, String...) to keep api compatibility.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) This is a convenience method to use jmock to set the businessObjectService for unit testing.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) This is a convenience method to use jmock to set the parameterService for unit testing.

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

DOCUMENT_ERROR_PATH

public static final String DOCUMENT_ERROR_PATH

See Also:

Constant Field Values

VALIDATION_REQUIRED

public static final boolean VALIDATION_REQUIRED

See Also:

Constant Field Values

CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME

public static final boolean CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME

See Also:

Constant Field Values

Constructor Detail

ResearchDocumentRuleBase

public ResearchDocumentRuleBase()

Method Detail

reportError

protected void reportError(String propertyName,
               String errorKey,
               String... errorParams)

Delegates to ErrorReporter#reportError(String, String, String...) to keep api compatibility.

See Also:

ErrorReporter.reportError(String, String, String...)

reportWarning

protected void reportWarning(String propertyName,
                 String errorKey,
                 String... errorParams)

Delegates to ErrorReporter#reportError(String, String, String...) to keep api compatibility.

See Also:

ErrorReporter.reportError(String, String, String...)

addAuditError

protected void addAuditError(org.kuali.rice.kns.util.AuditError error,
                 String errorKey,
                 String clusterLabel,
                 String clusterCategory)

Delegates to ErrorReporter#reportAuditError(AuditError, String, String, String) to keep api compatibility.

See Also:

ErrorReporter.reportAuditError(AuditError, String, String, String)

reportSoftError

protected void reportSoftError(String propertyName,
                   String errorKey,
                   String... errorParams)

Delegates to ErrorReporter#reportSoftError(String, String, String...) to keep api compatibility.

See Also:

ErrorReporter.reportSoftError(String, String, String...)

getSoftErrors

public Map<String,Collection<SoftError>> getSoftErrors()

Delegates to ErrorReporter#getSoftErrors() to keep api compatibility.

See Also:

ErrorReporter.getSoftErrors()

reportErrorWithoutFullErrorPath

protected void reportErrorWithoutFullErrorPath(String propertyName,
                                   String errorKey,
                                   String... errorParams)

Wrapper around global errorMap.put call, to allow better logging

Parameters:

propertyName -

errorKey -

errorParams -

processRunAuditBusinessRules

public boolean processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)

Specified by:

processRunAuditBusinessRules in interface org.kuali.rice.krad.rules.rule.DocumentAuditRule

processBudgetVersionsBusinessRule

protected boolean processBudgetVersionsBusinessRule(BudgetParentDocument budgetParentDocument,
                                        boolean runDatactionaryValidation)

This method checks budget versions business rules.

Parameters:

budgetParentDocument - the document

runDatactionaryValidation - if dd validation should be run

Returns:

true if valid false if not

Throws:

NullPointerException - if the proposalDevelopmentDocument is null

hasPermission

protected boolean hasPermission(ProposalDevelopmentDocument doc,
                    String permissionName)

Does the current user have the given permission for the proposal?

Parameters:

doc - the Proposal Development Document

permissionName - the name of the permission

Returns:

true if user has permission; otherwise false

hasRole

protected boolean hasRole(ProposalDevelopmentDocument doc,
              String roleName)

Does the current user have the given role for the proposal?

Parameters:

doc - the Proposal Development Document

roleName - the name of the role

Returns:

true if user has role; otherwise false

hasPermission

protected boolean hasPermission(String userId,
                    ProposalDevelopmentDocument doc,
                    String permissionName)

Does the given user have the given permission for the proposal?

Parameters:

username - the user's username

doc - the Proposal Development Document

permissionName - the name of the permission

Returns:

true if user has permission; otherwise false

hasRole

protected boolean hasRole(String userId,
              ProposalDevelopmentDocument doc,
              String roleName)

Does the given user have the given role for the proposal?

Parameters:

username - the user's username

doc - the Proposal Development Document

roleName - the name of the role

Returns:

true if user has role; otherwise false

keyValue

protected Map.Entry<String,String> keyValue(String key,
                                Object value)

Convenience method for creating a AbstractMap.SimpleEntry out of a key/value pair

Parameters:

key -

value -

Returns:

SimpleImmutableEntry

isInvalid

protected boolean isInvalid(Class<?> boClass,
                Map.Entry<String,String>... entries)

The opposite of #isValid(Class, SimpleEntry...)

Parameters:

boClass - the class of the business object to validate

entries - varargs array of AbstractMap.SimpleEntry key/value pair instances

Returns:

true if invalid; false if valid

See Also:

#isValid(Class, SimpleImmutableEntry...)

isValid

protected boolean isValid(Class<?> boClass,
              Map.Entry<String,String>... entries)

Is the given code valid? Query the database for a matching code If found, it is valid; otherwise it is invalid.

Parameters:

boClass - the class of the business object to validate

entries - varargs array of AbstractMap.SimpleEntry key/value pair instances

Returns:

true if invalid; false if valid

See Also:

#isInvalid(Class, SimpleImmutableEntry...)

getBusinessObjectService

protected final org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Locate in Spring the BusinessObjectService singleton instance

Returns:

BusinessObjectService

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

This is a convenience method to use jmock to set the businessObjectService for unit testing.

Parameters:

businessObjectService -

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Looks up and returns the ParameterService.

Returns:

the parameter service.

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

This is a convenience method to use jmock to set the parameterService for unit testing.

Parameters:

businessObjectService -

getErrorReporter

public ErrorReporter getErrorReporter()

Gets the error reporter.

Returns:

the error reporter

getKnsDictionaryValidationService

protected org.kuali.rice.kns.service.DictionaryValidationService getKnsDictionaryValidationService()