org.kuali.kra.common.committee.rules

Class CommitteeDocumentRuleBase

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.common.committee.rules.CommitteeDocumentRuleBase

All Implemented Interfaces:

AddCommitteeMembershipRoleRule, AddCommitteeMembershipRule, BusinessRuleInterface, 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:

CommitteeDocumentRule, IacucCommitteeDocumentRule

public abstract class CommitteeDocumentRuleBase
extends ResearchDocumentRuleBase
implements BusinessRuleInterface, AddCommitteeMembershipRule, AddCommitteeMembershipRoleRule

This is the main business rule class for the CommitteeBase Document. It is responsible for customized workflow related business rule checking such saving, routing, etc. All committee specific actions, e.g. adding members, this class will act as a controller and forward the rules checking to another class within this package.

Field Summary

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

DOCUMENT_ERROR_PATH

Constructor Summary

Constructors

Constructor and Description
CommitteeDocumentRuleBase()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkResearchAreasForCommitteeMember(CommitteeMembershipBase committeeMember, int membershipIndex) This method will check if all the research areas that have been added to a committee member as 'area of expertise' are indeed active.
protected abstract Class<? extends CommitteeBase>	getCommitteeBOClassHook()
protected abstract Class<? extends CommitteeDocumentBase>	getCommitteeDocumentBOClassHook()
protected abstract CommitteeIdValuesFinderBase	getNewCommitteeIdValuesFinderInstanceHook()
boolean	processAddCommitteeMembershipBusinessRules(AddCommitteeMembershipEvent addCommitteeMembershipEvent) ProcessDefinitionDefinitiones the validation rules for an AddCommitteeMembershipEvent
boolean	processAddCommitteeMembershipRoleBusinessRules(AddCommitteeMembershipRoleEvent addCommitteeMembershipRoleEvent) ProcessDefinitionDefinitiones the validation rules for an AddCommitteeMembershipRoleEvent
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processRules(KraDocumentEventBaseExtension event) This method implementer must process rule for the event passed.
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	validateCommitteeResearchAreas(CommitteeBase committee) This method will check if all the research areas that have been added to the committee are indeed active.
boolean	validateReviewType(CommitteeBase committee)

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

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, getParameterService, getSoftErrors, hasPermission, hasPermission, hasRole, hasRole, isInvalid, isValid, keyValue, processBudgetVersionsBusinessRule, 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, 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

Constructor Detail

CommitteeDocumentRuleBase

public CommitteeDocumentRuleBase()

Method Detail

processCustomRouteDocumentBusinessRules

protected boolean processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document document)

Overrides:

processCustomRouteDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

org.kuali.core.rules.DocumentRuleBase#processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document)

processCustomSaveDocumentBusinessRules

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

Overrides:

processCustomSaveDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

org.kuali.core.rules.DocumentRuleBase#processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document)

getCommitteeDocumentBOClassHook

protected abstract Class<? extends CommitteeDocumentBase> getCommitteeDocumentBOClassHook()

getCommitteeBOClassHook

protected abstract Class<? extends CommitteeBase> getCommitteeBOClassHook()

getNewCommitteeIdValuesFinderInstanceHook

protected abstract CommitteeIdValuesFinderBase getNewCommitteeIdValuesFinderInstanceHook()

checkResearchAreasForCommitteeMember

public boolean checkResearchAreasForCommitteeMember(CommitteeMembershipBase committeeMember,
                                           int membershipIndex)

This method will check if all the research areas that have been added to a committee member as 'area of expertise' are indeed active. It is declared public because it will be invoked from the action class for committee members as well.

Parameters:

document -

Returns:

processRunAuditBusinessRules

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

Specified by:

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

Overrides:

processRunAuditBusinessRules in class ResearchDocumentRuleBase

See Also:

org.kuali.core.rule.DocumentAuditRule#processRunAuditBusinessRules(org.kuali.core.document.Document)

processAddCommitteeMembershipBusinessRules

public boolean processAddCommitteeMembershipBusinessRules(AddCommitteeMembershipEvent addCommitteeMembershipEvent)

Description copied from interface: AddCommitteeMembershipRule

ProcessDefinitionDefinitiones the validation rules for an AddCommitteeMembershipEvent

Specified by:

processAddCommitteeMembershipBusinessRules in interface AddCommitteeMembershipRule

Returns:

true if valid, false otherwise

See Also:

org.kuali.kra.common.committee.rule.AddCommitteeMembershipRule#processAddCommitteeMembershipRules(org.kuali.kra.common.committee.rule.event.AddCommitteeMembershipEvent)

processAddCommitteeMembershipRoleBusinessRules

public boolean processAddCommitteeMembershipRoleBusinessRules(AddCommitteeMembershipRoleEvent addCommitteeMembershipRoleEvent)

Description copied from interface: AddCommitteeMembershipRoleRule

ProcessDefinitionDefinitiones the validation rules for an AddCommitteeMembershipRoleEvent

Specified by:

processAddCommitteeMembershipRoleBusinessRules in interface AddCommitteeMembershipRoleRule

Returns:

true if valid, false otherwise

See Also:

AddCommitteeMembershipRoleRule.processAddCommitteeMembershipRoleBusinessRules(org.kuali.kra.common.committee.rule.event.AddCommitteeMembershipRoleEvent)

processRules

public boolean processRules(KraDocumentEventBaseExtension event)

Description copied from interface: BusinessRuleInterface

This method implementer must process rule for the event passed.

Specified by:

processRules in interface BusinessRuleInterface

Returns:

See Also:

BusinessRuleInterface.processRules(org.kuali.kra.rule.event.KraDocumentEventBaseExtension)

validateCommitteeResearchAreas

public boolean validateCommitteeResearchAreas(CommitteeBase committee)

This method will check if all the research areas that have been added to the committee are indeed active. It is declared public because it will be invoked from the action class for committee as well.

Parameters:

document -

Returns:

validateReviewType

public boolean validateReviewType(CommitteeBase committee)