public class ObjectCodeGlobalRule extends org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
ObjectCodeGlobal
business objectsModifier and Type | Field and Description |
---|---|
protected ObjectCodeGlobal |
objectCodeGlobal |
protected ObjectCodeService |
objectCodeService |
protected ObjectLevelService |
objectLevelService |
boDictionaryService, boService, businessObjectAuthorizationService, businessObjectMetaDataService, configService, dataObjectMetaDataService, ddService, dictionaryValidationService, DOCUMENT_ERROR_PREFIX, documentHelperService, LOG, MAINTAINABLE_ERROR_PATH, MAINTAINABLE_ERROR_PREFIX, maintDocDictionaryService, persistenceStructureService, personService, priorErrorPath, roleService, workflowDocumentService
Constructor and Description |
---|
ObjectCodeGlobalRule() |
Modifier and Type | Method and Description |
---|---|
protected Collection<org.kuali.rice.krad.bo.BusinessObject> |
addAdditionalBlockingBusinessObjects(Collection<org.kuali.rice.krad.bo.BusinessObject> blockingBusinessObjects,
ObjectCode objectCode)
Retrieves any additional blocking objects not handled by the inactivation framework
|
protected boolean |
checkChartAllLines(ObjectCodeGlobal ocChangeDocument)
This method calls
checkChartOnObjCodeDetails(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean) on each detail object |
protected boolean |
checkChartOnObjCodeDetails(ObjectCodeGlobal objectCodeGlobal,
ObjectCodeGlobalDetail objectCodeGlobalDetail,
int lineNum,
boolean add)
This checks to make sure that the chart of accounts for the detail object has been filled in
|
protected boolean |
checkFiscalYear(ObjectCodeGlobal objectCodeGlobal,
ObjectCodeGlobalDetail objectCodeGlobalDetail,
int lineNum,
boolean add)
This checks to make sure that the fiscal year has been entered
|
protected boolean |
checkFiscalYearAllLines(ObjectCodeGlobal objectCodeGlobal)
This method calls
checkFiscalYear(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean) on each detail object |
protected boolean |
checkForObjectCodeGlobalDetails(Collection<? extends org.kuali.rice.krad.bo.PersistableBusinessObject> objectCodeGlobalDetails)
This checks to make sure that there is at least one
ObjectCodeGlobalDetail in the collection |
protected boolean |
checkNextYearObjectCode(ObjectCodeGlobal objectCodeGlobal,
ObjectCodeGlobalDetail dtl,
int lineNum,
boolean add)
This method checks that the next year object code specified in the change document is a valid object code for a given chart
and year
|
protected boolean |
checkNextYearObjectCodeAllLines(ObjectCodeGlobal objectCodeGlobalDocument2)
This method calls
checkNextYearObjectCode(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean) on each detail object |
boolean |
checkObjectCodeDetails(ObjectCodeGlobalDetail dtl)
|
protected boolean |
checkObjectLevelCode(ObjectCodeGlobal objectCodeGlobal,
ObjectCodeGlobalDetail dtl,
int lineNum,
boolean add)
This method checks that the object level code from the object code change document actually exists for the chart object
specified in the detail
|
protected boolean |
checkObjectLevelCodeAllLines(ObjectCodeGlobal objectCodeGlobalDocument2)
This method calls
checkObjectLevelCode(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean) on each detail object |
protected boolean |
checkReportsToObjectCode(ObjectCodeGlobal objectCodeGlobal,
ObjectCodeGlobalDetail dtl,
int lineNum,
boolean add)
This method checks that the reports to object code input on the top level of the global document is valid for a given chart's
reportToChart in the detail section
|
protected boolean |
checkReportsToObjectCodeAllLines(ObjectCodeGlobal objectCodeGlobalDocument2)
This method calls
checkReportsToObjectCode(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean) on each detail object |
protected boolean |
checkResearchAdminAttributes(ObjectCodeGlobal objectCodeGlobal)
This method verifies the budget category value
|
protected boolean |
checkSimpleRulesAllLines()
This method checks the simple rules for all lines at once and gets called on save, submit, etc.
|
protected boolean |
checkUniqueIdentifiers(ObjectCodeGlobalDetail dtl)
This method (will)put an error about unique identifier fields must not exist more than once.
|
protected boolean |
isEqualObjectCode(ObjectCode castor,
ObjectCode pollux)
Determines if the two given object codes are roughly equal
|
protected boolean |
isObjectCodeInPersistingChanges(List<org.kuali.rice.krad.bo.PersistableBusinessObject> persistingChanges,
ObjectCode objectCode)
Determines if the given object code is within the list of persisting changes
|
protected boolean |
isOnlyPersistingChangesInBlockingBusinessObjects(Collection<org.kuali.rice.krad.bo.BusinessObject> blockingBusinessObjects,
List<org.kuali.rice.krad.bo.PersistableBusinessObject> persistingChanges)
Determines if all of the given blocking business objects are among the persisting changes
|
boolean |
processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document,
String collectionName,
org.kuali.rice.krad.bo.PersistableBusinessObject bo)
This method checks to make sure that each new
ObjectCodeGlobalDetail has:
valid chart of accounts code
valid fiscal year
unique identifiers (not currently implemented)
|
protected boolean |
processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)
This performs rules checks on document approve
checkSimpleRulesAllLines()
This rule fails on business rule failures |
protected boolean |
processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)
This performs rules checks on document route
checkSimpleRulesAllLines()
This rule fails on business rule failures |
protected boolean |
processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)
This performs rules checks on document save
checkSimpleRulesAllLines()
This rule does not fail on business rule failures |
protected boolean |
processInactivationBlockChecking(org.kuali.rice.kns.maintenance.Maintainable maintainable,
ObjectCode objectCode,
int index) |
protected boolean |
processInactivationBlockChecking(org.kuali.rice.kns.document.MaintenanceDocument maintenanceDocument) |
protected void |
putInactivationBlockingErrorOnPage(ObjectCode objectCode,
org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata inactivationBlockingMetadata,
int index) |
protected void |
retrieveBlockingIndirectCostRecoveryExclusionAccounts(ObjectCode objectCode,
List<org.kuali.rice.krad.bo.BusinessObject> additionalBlockingObjects)
Retrieves all Indirect Cost Recovery Exclusion by Account records blocking the given object code and puts them in the List of additional blocking objects
|
protected void |
retrieveBlockingOffsetDefinitions(ObjectCode objectCode,
List<org.kuali.rice.krad.bo.BusinessObject> additionalBlockingObjects)
Retrieves all Offset Definitions blocking the given object code and puts them in the List of additional blocking objects
|
protected void |
setObjectCodeService(ObjectCodeService objectCodeService) |
protected void |
setObjectLevelService(ObjectLevelService objectLevelService) |
void |
setupConvenienceObjects()
This method sets the convenience objects like objectCodeGlobal, so you have short and easy handles to the new and
old objects contained in the maintenance document.
|
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, processGlobalApproveDocumentBusinessRules, processGlobalRouteDocumentBusinessRules, processGlobalSaveDocumentBusinessRules, 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
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
protected ObjectCodeGlobal objectCodeGlobal
protected ObjectCodeService objectCodeService
protected ObjectLevelService objectLevelService
public ObjectCodeGlobalRule()
public void setupConvenienceObjects()
setupConvenienceObjects
in interface org.kuali.rice.kns.rules.MaintenanceDocumentRule
setupConvenienceObjects
in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
document
- - the maintenanceDocument being evaluatedprotected boolean processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)
processCustomApproveDocumentBusinessRules
in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
MaintenanceDocumentRuleBase.processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
protected boolean processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)
processCustomRouteDocumentBusinessRules
in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
MaintenanceDocumentRuleBase.processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
protected boolean processInactivationBlockChecking(org.kuali.rice.kns.document.MaintenanceDocument maintenanceDocument)
processInactivationBlockChecking
in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
protected boolean processInactivationBlockChecking(org.kuali.rice.kns.maintenance.Maintainable maintainable, ObjectCode objectCode, int index)
protected void putInactivationBlockingErrorOnPage(ObjectCode objectCode, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata inactivationBlockingMetadata, int index)
protected boolean isOnlyPersistingChangesInBlockingBusinessObjects(Collection<org.kuali.rice.krad.bo.BusinessObject> blockingBusinessObjects, List<org.kuali.rice.krad.bo.PersistableBusinessObject> persistingChanges)
blockingBusinessObjects
- the Collection of blocking business objectspersistingChanges
- the List of Object Codes which will be persisted by this documentprotected boolean isObjectCodeInPersistingChanges(List<org.kuali.rice.krad.bo.PersistableBusinessObject> persistingChanges, ObjectCode objectCode)
persistingChanges
- the changes to persistobjectCode
- the blocking object code to look for in the persisting changesprotected boolean isEqualObjectCode(ObjectCode castor, ObjectCode pollux)
castor
- an object codepollux
- another, though perhaps very similar, object codeprotected Collection<org.kuali.rice.krad.bo.BusinessObject> addAdditionalBlockingBusinessObjects(Collection<org.kuali.rice.krad.bo.BusinessObject> blockingBusinessObjects, ObjectCode objectCode)
blockingBusinessObjects
- the current list of blocking business objectsobjectCode
- the object code to find additional blocking objects forprotected void retrieveBlockingOffsetDefinitions(ObjectCode objectCode, List<org.kuali.rice.krad.bo.BusinessObject> additionalBlockingObjects)
objectCode
- the object code to find additional blocking objects foradditionalBlockingObjects
- the List of additional blocking objects to populateprotected void retrieveBlockingIndirectCostRecoveryExclusionAccounts(ObjectCode objectCode, List<org.kuali.rice.krad.bo.BusinessObject> additionalBlockingObjects)
objectCode
- the object code to find additional blocking objects foradditionalBlockingObjects
- the List of additional blocking objects to populateprotected boolean processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)
processCustomSaveDocumentBusinessRules
in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
MaintenanceDocumentRuleBase.processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
public boolean processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document, String collectionName, org.kuali.rice.krad.bo.PersistableBusinessObject bo)
ObjectCodeGlobalDetail
has:
processCustomAddCollectionLineBusinessRules
in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
MaintenanceDocumentRuleBase.processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument, java.lang.String, org.kuali.rice.krad.bo.PersistableBusinessObject)
protected boolean checkUniqueIdentifiers(ObjectCodeGlobalDetail dtl)
dtl
- public boolean checkObjectCodeDetails(ObjectCodeGlobalDetail dtl)
dtl
- protected boolean checkReportsToObjectCode(ObjectCodeGlobal objectCodeGlobal, ObjectCodeGlobalDetail dtl, int lineNum, boolean add)
dtl
- protected boolean checkNextYearObjectCode(ObjectCodeGlobal objectCodeGlobal, ObjectCodeGlobalDetail dtl, int lineNum, boolean add)
dtl
- protected boolean checkObjectLevelCode(ObjectCodeGlobal objectCodeGlobal, ObjectCodeGlobalDetail dtl, int lineNum, boolean add)
dtl
- protected boolean checkSimpleRulesAllLines()
protected boolean checkForObjectCodeGlobalDetails(Collection<? extends org.kuali.rice.krad.bo.PersistableBusinessObject> objectCodeGlobalDetails)
ObjectCodeGlobalDetail
in the collectionobjectCodeGlobalDetails
- protected boolean checkFiscalYearAllLines(ObjectCodeGlobal objectCodeGlobal)
checkFiscalYear(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean)
on each detail objectobjectCodeGlobal
- protected boolean checkChartAllLines(ObjectCodeGlobal ocChangeDocument)
checkChartOnObjCodeDetails(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean)
on each detail objectocChangeDocument
- protected boolean checkReportsToObjectCodeAllLines(ObjectCodeGlobal objectCodeGlobalDocument2)
checkReportsToObjectCode(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean)
on each detail objectobjectCodeGlobalDocument2
- protected boolean checkNextYearObjectCodeAllLines(ObjectCodeGlobal objectCodeGlobalDocument2)
checkNextYearObjectCode(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean)
on each detail objectobjectCodeGlobalDocument2
- protected boolean checkObjectLevelCodeAllLines(ObjectCodeGlobal objectCodeGlobalDocument2)
checkObjectLevelCode(ObjectCodeGlobal, ObjectCodeGlobalDetail, int, boolean)
on each detail objectobjectCodeGlobalDocument2
- protected boolean checkFiscalYear(ObjectCodeGlobal objectCodeGlobal, ObjectCodeGlobalDetail objectCodeGlobalDetail, int lineNum, boolean add)
objectCodeGlobal
- objectCodeGlobalDetail
- lineNum
- add
- protected boolean checkChartOnObjCodeDetails(ObjectCodeGlobal objectCodeGlobal, ObjectCodeGlobalDetail objectCodeGlobalDetail, int lineNum, boolean add)
objectCodeGlobal
- objectCodeGlobalDetail
- lineNum
- add
- protected boolean checkResearchAdminAttributes(ObjectCodeGlobal objectCodeGlobal)
objectCodeGlobal
- protected void setObjectCodeService(ObjectCodeService objectCodeService)
protected void setObjectLevelService(ObjectLevelService objectLevelService)
Copyright © 2004–2014 The Kuali Foundation. All rights reserved.