org.kuali.ole.module.cg.document.validation.impl

Class ProposalRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.rice.kns.rules.DocumentRuleBase

org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

org.kuali.ole.module.cg.document.validation.impl.CGMaintenanceDocumentRuleBase

org.kuali.ole.module.cg.document.validation.impl.ProposalRule

All Implemented Interfaces:

org.kuali.rice.kns.rule.AddCollectionLineRule, org.kuali.rice.kns.rules.MaintenanceDocumentRule, 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.RouteDocumentRule, org.kuali.rice.krad.rules.rule.SaveDocumentRule, org.kuali.rice.krad.rules.rule.SendAdHocRequestsRule

public class ProposalRule
extends CGMaintenanceDocumentRuleBase

Rules for the Proposal maintenance document.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOG
protected Proposal	newProposalCopy

Fields inherited from class org.kuali.ole.module.cg.document.validation.impl.CGMaintenanceDocumentRuleBase

AGENCY_TYPE_CODE_FEDERAL, PROJECT_DIRECTOR_DECEASED, PROJECT_DIRECTOR_INVALID_STATUSES

Fields inherited from class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

boDictionaryService, boService, businessObjectAuthorizationService, businessObjectMetaDataService, configService, dataObjectMetaDataService, ddService, dictionaryValidationService, DOCUMENT_ERROR_PREFIX, documentHelperService, MAINTAINABLE_ERROR_PATH, MAINTAINABLE_ERROR_PREFIX, maintDocDictionaryService, persistenceStructureService, personService, priorErrorPath, roleService, workflowDocumentService

Constructor Summary

Constructors

Constructor and Description
ProposalRule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document, String collectionName, org.kuali.rice.krad.bo.PersistableBusinessObject line)
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument documentCopy)
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument documentCopy)
void	setupConvenienceObjects() Performs convenience cast for Maintenance framework.
protected boolean	validateAddSubcontractor(org.kuali.rice.krad.bo.PersistableBusinessObject addLine) This method takes a look at the new line being added and applies appropriate validation checks if the line is a new line for the Subcontractor collection.

Methods inherited from class org.kuali.ole.module.cg.document.validation.impl.CGMaintenanceDocumentRuleBase

checkAgencyNotEqualToFederalPassThroughAgency, checkEndAfterBegin, checkFederalPassThrough, checkPrimary, checkProjectDirectorsAreDirectors, checkProjectDirectorsExist, checkProjectDirectorsStatuses

Methods inherited from class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

checkEmptyBOField, checkEmptyDocumentField, checkEmptyValue, checkForPartiallyFilledOutReferenceForeignKeys, clearErrorPath, consolidateFieldNames, dataDictionaryValidate, errorAlreadyExists, getBoService, getConfigService, getDataObjectMetaDataService, getDateTimeService, getDdService, getDictionaryValidationService, getDocumentHelperService, getFieldLabel, getFieldLabel, getHumanReadablePrimaryKeyFieldNames, getMaintDocDictionaryService, getNewBo, getOldBo, getPersistenceStructureService, getPersonService, getRoleService, getWorkflowDocumentService, isCorrectMaintenanceClass, isDocumentInactivatingBusinessObject, isDocumentValidForSave, primaryKeyCheck, processAddCollectionLineBusinessRules, processApproveDocument, processCustomApproveDocumentBusinessRules, processGlobalApproveDocumentBusinessRules, processGlobalRouteDocumentBusinessRules, processGlobalSaveDocumentBusinessRules, processInactivationBlockChecking, processInactivationBlockChecking, processRouteDocument, processSaveDocument, putDocumentError, putDocumentError, putFieldError, putFieldError, putFieldError, putFieldErrorWithShortLabel, putGlobalError, putGlobalError, putGlobalError, putGlobalsError, putGlobalsError, putInactivationBlockingErrorOnPage, resumeErrorPath, setBoDictionaryService, setBoService, setBusinessObjectAuthorizationService, setBusinessObjectMetaDataService, setConfigService, setDataObjectMetaDataService, setDdService, setDictionaryValidationService, setDocumentHelperService, setMaintDocDictionaryService, setNewBo, setPersistenceStructureService, setPersonService, setupBaseConvenienceObjects, setWorkflowDocumentService, showErrorMap, validateDocumentStructure, validateDuplicateIdentifierInDataDictionary, validateGlobalBusinessObjectPersistable, validateMaintenanceDocument

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

buildDocumentTypeActionRequestPermissionDetails, buildDocumentTypePermissionDetails, getDataDictionaryService, getDocumentDictionaryService, getGroupService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getPermissionService, hasAdHocRouteCompletion, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteCompletionToInitiator, isAdHocRouteRecipientsValid, isDocumentAttributesValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processCompleteDocument, processCustomAddAdHocRoutePersonBusinessRules, processCustomAddAdHocRouteWorkgroupBusinessRules, processCustomAddNoteBusinessRules, processCustomApproveDocumentBusinessRules, processCustomCompleteDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processCustomSaveDocumentBusinessRules, processCustomSendAdHocRequests, 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

LOG

protected static org.apache.log4j.Logger LOG

newProposalCopy

protected Proposal newProposalCopy

Constructor Detail

ProposalRule

public ProposalRule()

Method Detail

processCustomSaveDocumentBusinessRules

protected boolean processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument documentCopy)

Overrides:

processCustomSaveDocumentBusinessRules in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

processCustomRouteDocumentBusinessRules

protected boolean processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument documentCopy)

Overrides:

processCustomRouteDocumentBusinessRules in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

processCustomAddCollectionLineBusinessRules

public boolean processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document,
                                                  String collectionName,
                                                  org.kuali.rice.krad.bo.PersistableBusinessObject line)

Overrides:

processCustomAddCollectionLineBusinessRules in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

Returns:

validateAddSubcontractor

protected boolean validateAddSubcontractor(org.kuali.rice.krad.bo.PersistableBusinessObject addLine)

This method takes a look at the new line being added and applies appropriate validation checks if the line is a new line for the Subcontractor collection. If the validation checks fail, an appropriate error message will be added to the global error map and the method will return a value of false.

Parameters:

addLine - New business object values being added.

Returns:

True is the value being added passed all applicable validation rules.

setupConvenienceObjects

public void setupConvenienceObjects()

Performs convenience cast for Maintenance framework. Note that the MaintenanceDocumentRule events provide only a deep copy of the document (from KualiDocumentEventBase), so these BOs are a copy too. The framework does this to prevent these rules from changing any data.

Specified by:

setupConvenienceObjects in interface org.kuali.rice.kns.rules.MaintenanceDocumentRule

Overrides:

setupConvenienceObjects in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

See Also:

MaintenanceDocumentRule.setupConvenienceObjects()