| java.lang.Object
 org.kuali.core.rules.DocumentRuleBase
org.kuali.core.maintenance.rules.MaintenanceDocumentRuleBase
All known Subclasses: org.kuali.module.chart.rules.OrganizationRoutingModelRule, org.kuali.module.pdp.rules.PayeeAchAccountRule, org.kuali.module.purap.rules.PurchaseOrderQuoteLanguageRule, org.kuali.module.vendor.rules.VendorRule, org.kuali.module.chart.rules.OrgRule, org.kuali.module.financial.rules.FinancialUserRule, org.kuali.module.purap.rules.PurchaseOrderContractLanguageRule, org.kuali.module.chart.rules.ObjectConsRule, org.kuali.module.kra.budget.rules.IndirectCostLookupRule, org.kuali.core.rules.ParameterRule, org.kuali.module.labor.rules.BenefitsCalculationDocumentRule, org.kuali.module.financial.rules.BankRule, org.kuali.core.rules.UniversalUserRule, org.kuali.module.pdp.rules.AchBankRule, org.kuali.module.cg.rules.SubcontractorRule, org.kuali.module.chart.rules.ObjectTypeRule, org.kuali.module.purap.rules.OrganizationParameterRule, org.kuali.module.purap.rules.PurapUserRule, org.kuali.module.financial.rules.CreditCardVendorRule, org.kuali.module.chart.rules.DelegateRule, edu.sampleu.travel.bo.TravelAccountRules, org.kuali.module.chart.rules.ChartRule, org.kuali.module.chart.rules.AccountRule, org.kuali.module.cg.rules.ProposalCloseRule, org.kuali.module.chart.rules.GlobalDocumentRuleBase, org.kuali.module.chart.rules.IcrAutomatedEntryRule, org.kuali.module.chart.rules.OrganizationReversionRule, org.kuali.module.cg.rules.CGMaintenanceDocumentRuleBase, org.kuali.module.kra.budget.rules.AppointmentTypeMaintenanceDocumentRule, org.kuali.module.financial.rules.BankAccountRule, org.kuali.module.chart.rules.SubAccountRule, org.kuali.module.chart.rules.ChartUserRule, org.kuali.module.chart.rules.ProjectCodeRule, org.kuali.module.chart.rules.ObjectCodeRule, org.kuali.module.financial.rules.ServiceBillingControlRule, org.kuali.module.chart.rules.SubObjCdRule, org.kuali.module.chart.rules.AccountingPeriodRule, org.kuali.module.chart.rules.ReportingCodesRule, org.kuali.module.cg.rules.AgencyRule, org.kuali.core.impls.RiceTestMaintenanceDocumentRule, org.kuali.module.financial.rules.PayeeDocumentRule, org.kuali.module.chart.rules.ObjectCodeGlobalRule, org.kuali.module.chart.rules.ObjectLevelRule, org.kuali.module.chart.rules.OffsetDefinitionRule,
| Method Summary | |
| protected boolean | apcRuleFails(String parameterNamespace, String parameterDetailTypeCode, String parameterName, String valueToTest)
This method is a shallow inverse wrapper around applyApcRule, it simply reverses the return value, for better readability in
an if test.
This method applies an APC rule based on the values provided.
It will throw an ApplicationParameterException if the APC Group and Parm do not exist in the system.
Parameters:
apcGroupName - - The script or group name in the APC system. | | protected boolean | applyApcRule(String parameterNamespace, String parameterDetailTypeCode, String parameterName, String valueToTest)
This method applies an APC rule based on the values provided.
It will throw an ApplicationParameterException if the APC Group and Parm do not exist in the system.
Parameters:
apcGroupName - - The script or group name in the APC system. | | protected boolean | checkAuthorizationRestrictions(MaintenanceDocument document)
This method ensures that any fields that are restricted by the Authorization system in the system are also enforced on the
back-end, otherwise form manipulation could bypass authorization rules. | | protected boolean | checkEmptyBOField(String propertyName, Object valueToTest, String parameter)
This method accepts an object, and attempts to determine whether it is empty by this method's definition. | | protected boolean | checkEmptyDocumentField(String propertyName, Object valueToTest, String parameter)
This method accepts document field (such as , and attempts to determine whether it is empty by this method's definition. | | protected boolean | checkEmptyValue(Object valueToTest)
This method accepts document field (such as , and attempts to determine whether it is empty by this method's definition. | | protected boolean | checkForPartiallyFilledOutReferenceForeignKeys(String referenceName)
This method checks to make sure that if the foreign-key fields for the given reference attributes have any fields filled out,
that all fields are filled out.
If any are filled out, but all are not, it will return false and add a global error message about the problem.
Parameters:
referenceName - - The name of the reference object, whose foreign-key fields must be all-or-none filled out. | | protected void | clearErrorPath()
This method is used to deal with error paths that are not what we expect them to be. | | protected boolean | dataDictionaryValidate(MaintenanceDocument document)
This method executes the DataDictionary Validation against the document. | | final protected BusinessObjectDictionaryService | getBoDictionaryService()
Gets the boDictionaryService attribute. | | final protected BusinessObjectService | getBoService()
Gets the boService attribute. | | final protected KualiConfigurationService | getConfigService()
Gets the configService attribute. | | public DateTimeService | getDateTimeService()
| | final protected DataDictionaryService | getDdService()
Gets the ddService attribute. | | final protected DictionaryValidationService | getDictionaryValidationService()
Gets the dictionaryValidationService attribute. | | final protected DocumentAuthorizationService | getDocumentAuthorizationService()
Gets the documentAuthorizationService attribute. | | protected String | getFieldLabel(String fieldName)
This method translates the passed in field name into a human-readable attribute label.
It assumes the existing newBO's class as the class to examine the fieldName for.
Parameters:
fieldName - The fieldName you want a human-readable label for. | | protected String | getFieldLabel(Class boClass, String fieldName)
This method translates the passed in field name into a human-readable attribute label.
It assumes the existing newBO's class as the class to examine the fieldName for.
Parameters:
boClass - The class to use in combination with the fieldName.
Parameters:
fieldName - The fieldName you want a human-readable label for. | | final protected MaintenanceDocumentDictionaryService | getMaintDocDictionaryService()
Gets the maintDocDictionaryService attribute. | | final protected PersistableBusinessObject | getNewBo()
Gets the newBo attribute. | | final protected PersistableBusinessObject | getOldBo()
Gets the oldBo attribute. | | final protected PersistenceService | getPersistenceService()
Gets the persistenceService attribute. | | final protected PersistenceStructureService | getPersistenceStructureService()
Gets the persistenceStructureService attribute. | | public UniversalUserService | getUniversalUserService()
| | public WorkflowDocumentService | getWorkflowDocumentService()
Gets the workflowDocumentService attribute. | | protected boolean | isCorrectMaintenanceClass(MaintenanceDocument document, Class clazz)
This method tests to make sure the MaintenanceDocument passed in is based on the class you are expecting. | | protected boolean | isDocumentValidForSave(MaintenanceDocument maintenanceDocument)
This method checks to see if the document is in a state that it can be saved without causing exceptions.
Note that Business Rules are NOT enforced here, only validity checks.
This method will only return false if the document is in such a state that routing it will cause RunTimeExceptions.
Parameters:
maintenanceDocument - - a populated MaintenaceDocument instance. | | public boolean | processAddCollectionLineBusinessRules(MaintenanceDocument document, String collectionName, PersistableBusinessObject bo)
| | public boolean | processApproveDocument(ApproveDocumentEvent approveEvent)
| | public boolean | processCustomAddCollectionLineBusinessRules(MaintenanceDocument document, String collectionName, PersistableBusinessObject line)
| | protected boolean | processCustomApproveDocumentBusinessRules(MaintenanceDocument document)
This method should be overridden to provide custom rules for processing document approval. | | protected boolean | processCustomRouteDocumentBusinessRules(MaintenanceDocument document)
| | protected boolean | processCustomSaveDocumentBusinessRules(MaintenanceDocument document)
| | protected boolean | processGlobalApproveDocumentBusinessRules(MaintenanceDocument document)
This method enforces all business rules that are common to all maintenance documents which must be tested before doing an
approval. | | protected boolean | processGlobalRouteDocumentBusinessRules(MaintenanceDocument document)
This method enforces all business rules that are common to all maintenance documents which must be tested before doing a
route. | | protected boolean | processGlobalSaveDocumentBusinessRules(MaintenanceDocument document)
This method enforces all business rules that are common to all maintenance documents which must be tested before doing a
save.
It can be overloaded in special cases where a MaintenanceDocument has very special needs that would be contrary to what is
enforced here.
Note that although this method returns a true or false to indicate whether the save should happen or not, this result may not
be followed by the calling method. | | public boolean | processRouteDocument(Document document)
| | public boolean | processSaveDocument(Document document)
| | protected void | putDocumentError(String propertyName, String errorConstant, String parameter)
This method is a convenience method to add a property-specific document error to the global errors list. | | protected void | putDocumentError(String propertyName, String errorConstant, String[] parameters)
This method is a convenience method to add a property-specific document error to the global errors list. | | protected void | putFieldError(String propertyName, String errorConstant)
This method is a convenience method to add a property-specific error to the global errors list. | | protected void | putFieldError(String propertyName, String errorConstant, String parameter)
This method is a convenience method to add a property-specific error to the global errors list. | | protected void | putFieldError(String propertyName, String errorConstant, String[] parameters)
This method is a convenience method to add a property-specific error to the global errors list. | | protected void | putFieldErrorWithShortLabel(String propertyName, String errorConstant)
Adds a property-specific error to the global errors list, with the DD short label as the single argument.
Parameters:
propertyName - - Property name of the element that is associated with the error. | | protected void | putGlobalError(String errorConstant)
This method is a convenience method to easily add a Document level error (ie, one not tied to a specific field, but
applicable to the whole document). | | protected void | putGlobalError(String errorConstant, String parameter)
This method is a convenience method to easily add a Document level error (ie, one not tied to a specific field, but
applicable to the whole document). | | protected void | putGlobalError(String errorConstant, String[] parameters)
This method is a convenience method to easily add a Document level error (ie, one not tied to a specific field, but
applicable to the whole document). | | protected void | putGlobalsError(String propertyName, String errorConstant)
| | protected void | putGlobalsError(String propertyName, String errorConstant, String parameter)
| | protected void | resumeErrorPath()
This method is used to deal with error paths that are not what we expect them to be. | | final public void | setBoDictionaryService(BusinessObjectDictionaryService boDictionaryService)
Sets the boDictionaryService attribute value. | | final public void | setBoService(BusinessObjectService boService)
Sets the boService attribute value. | | final public void | setConfigService(KualiConfigurationService configService)
Sets the configService attribute value. | | final public void | setDdService(DataDictionaryService ddService)
Sets the ddService attribute value. | | final public void | setDictionaryValidationService(DictionaryValidationService dictionaryValidationService)
Sets the dictionaryValidationService attribute value. | | final public void | setDocumentAuthorizationService(DocumentAuthorizationService documentAuthorizationService)
Sets the documentAuthorizationService attribute value. | | final public void | setMaintDocDictionaryService(MaintenanceDocumentDictionaryService maintDocDictionaryService)
Sets the maintDocDictionaryService attribute value. | | protected void | setNewBo(PersistableBusinessObject newBo)
| | final public void | setPersistenceService(PersistenceService persistenceService)
Sets the persistenceService attribute value. | | final public void | setPersistenceStructureService(PersistenceStructureService persistenceStructureService)
Sets the persistenceStructureService attribute value. | | public void | setUniversalUserService(UniversalUserService universalUserService)
| | public void | setWorkflowDocumentService(WorkflowDocumentService workflowDocumentService)
Sets the workflowDocumentService attribute value. | | public void | setupBaseConvenienceObjects(MaintenanceDocument document)
| | public void | setupConvenienceObjects()
| | protected boolean | validateDocumentStructure(Document document)
This method makes sure the document itself is valid, and has the necessary fields populated to be routable. | | protected boolean | validateGlobalBusinessObjectPersistable(MaintenanceDocument document)
This method checks whether this maint doc contains Global Business Objects, and if so, whether the GBOs are in a persistable
state. | | protected boolean | validateMaintenanceDocument(MaintenanceDocument maintenanceDocument)
This method checks to make sure the document is a valid maintenanceDocument, and has the necessary values populated such that
it will not cause exceptions in later routing or business rules testing. |
| DOCUMENT_ERROR_PREFIX | | final public static String DOCUMENT_ERROR_PREFIX(Code) | | |
| LOG | | protected static org.apache.log4j.Logger LOG(Code) | | |
| MAINTAINABLE_ERROR_PATH | | final public static String MAINTAINABLE_ERROR_PATH(Code) | | |
| MAINTAINABLE_ERROR_PREFIX | | final public static String MAINTAINABLE_ERROR_PREFIX(Code) | | |
| MaintenanceDocumentRuleBase | | public MaintenanceDocumentRuleBase()(Code) | | Default constructor a MaintenanceDocumentRuleBase.java.
|
| apcRuleFails | | protected boolean apcRuleFails(String parameterNamespace, String parameterDetailTypeCode, String parameterName, String valueToTest)(Code) | | This method is a shallow inverse wrapper around applyApcRule, it simply reverses the return value, for better readability in
an if test.
This method applies an APC rule based on the values provided.
It will throw an ApplicationParameterException if the APC Group and Parm do not exist in the system.
Parameters:
apcGroupName - - The script or group name in the APC system. If the value is null or blank, an IllegalArgumentExceptionwill be thrown.
Parameters:
parameterName - - The name of the parm/rule in the APC system. If the value is null or blank, an IllegalArgumentExceptionwill be thrown.
Parameters:
valueToTest - - The String value to test against the APC rule. The value may be null or blank without throwing an error,but the rule will likely fail if null or blank. True if the rule fails, False if the rule passes. |
| applyApcRule | | protected boolean applyApcRule(String parameterNamespace, String parameterDetailTypeCode, String parameterName, String valueToTest)(Code) | | This method applies an APC rule based on the values provided.
It will throw an ApplicationParameterException if the APC Group and Parm do not exist in the system.
Parameters:
apcGroupName - - The script or group name in the APC system. If the value is null or blank, an IllegalArgumentExceptionwill be thrown.
Parameters:
parameterName - - The name of the parm/rule in the APC system. If the value is null or blank, an IllegalArgumentExceptionwill be thrown.
Parameters:
valueToTest - - The String value to test against the APC rule. The value may be null or blank without throwing an error,but the rule will likely fail if null or blank. True if the rule passes, False if the rule fails. |
| checkAuthorizationRestrictions | | protected boolean checkAuthorizationRestrictions(MaintenanceDocument document)(Code) | | This method ensures that any fields that are restricted by the Authorization system in the system are also enforced on the
back-end, otherwise form manipulation could bypass authorization rules.
This method will add errors to the Global ErrorMap if any problems are encountered.
Parameters:
document - - the maintenance document being evaluated true if no failures occurred, false otherwise |
| checkEmptyBOField | | protected boolean checkEmptyBOField(String propertyName, Object valueToTest, String parameter)(Code) | | This method accepts an object, and attempts to determine whether it is empty by this method's definition.
OBJECT RESULT null false empty-string false whitespace false otherwise true
If the result is false, it will add an object field error to the Global Errors.
Parameters:
valueToTest - - any object to test, usually a String
Parameters:
propertyName - - the name of the property being tested true or false, by the description above |
| checkEmptyDocumentField | | protected boolean checkEmptyDocumentField(String propertyName, Object valueToTest, String parameter)(Code) | | This method accepts document field (such as , and attempts to determine whether it is empty by this method's definition.
OBJECT RESULT null false empty-string false whitespace false otherwise true
If the result is false, it will add document field error to the Global Errors.
Parameters:
valueToTest - - any object to test, usually a String
Parameters:
propertyName - - the name of the property being tested true or false, by the description above |
| checkEmptyValue | | protected boolean checkEmptyValue(Object valueToTest)(Code) | | This method accepts document field (such as , and attempts to determine whether it is empty by this method's definition.
OBJECT RESULT null false empty-string false whitespace false otherwise true
It will the result as a boolean
Parameters:
valueToTest - - any object to test, usually a String |
| checkForPartiallyFilledOutReferenceForeignKeys | | protected boolean checkForPartiallyFilledOutReferenceForeignKeys(String referenceName)(Code) | | This method checks to make sure that if the foreign-key fields for the given reference attributes have any fields filled out,
that all fields are filled out.
If any are filled out, but all are not, it will return false and add a global error message about the problem.
Parameters:
referenceName - - The name of the reference object, whose foreign-key fields must be all-or-none filled out. true if this is the case, false if not |
| clearErrorPath | | protected void clearErrorPath()(Code) | | This method is used to deal with error paths that are not what we expect them to be. This method, along with
resumeErrorPath() are used to temporarily clear the errorPath, and then return it to the original state after the rule is
executed.
This method is called at the very beginning of rule enforcement and pulls a copy of the contents of the errorPath ArrayList
to a local arrayList for temporary storage.
|
| dataDictionaryValidate | | protected boolean dataDictionaryValidate(MaintenanceDocument document)(Code) | | This method executes the DataDictionary Validation against the document.
Parameters:
document - true if it passes DD validation, false otherwise |
| getDictionaryValidationService | | final protected DictionaryValidationService getDictionaryValidationService()(Code) | | Gets the dictionaryValidationService attribute.
Returns the dictionaryValidationService. |
| getDocumentAuthorizationService | | final protected DocumentAuthorizationService getDocumentAuthorizationService()(Code) | | Gets the documentAuthorizationService attribute.
Returns the documentAuthorizationService. |
| getFieldLabel | | protected String getFieldLabel(String fieldName)(Code) | | This method translates the passed in field name into a human-readable attribute label.
It assumes the existing newBO's class as the class to examine the fieldName for.
Parameters:
fieldName - The fieldName you want a human-readable label for. A human-readable label, pulled from the DataDictionary. |
| getFieldLabel | | protected String getFieldLabel(Class boClass, String fieldName)(Code) | | This method translates the passed in field name into a human-readable attribute label.
It assumes the existing newBO's class as the class to examine the fieldName for.
Parameters:
boClass - The class to use in combination with the fieldName.
Parameters:
fieldName - The fieldName you want a human-readable label for. A human-readable label, pulled from the DataDictionary. |
| getPersistenceService | | final protected PersistenceService getPersistenceService()(Code) | | Gets the persistenceService attribute.
Returns the persistenceService. |
| getPersistenceStructureService | | final protected PersistenceStructureService getPersistenceStructureService()(Code) | | Gets the persistenceStructureService attribute.
Returns the persistenceStructureService. |
| getWorkflowDocumentService | | public WorkflowDocumentService getWorkflowDocumentService()(Code) | | Gets the workflowDocumentService attribute.
Returns the workflowDocumentService. |
| isCorrectMaintenanceClass | | protected boolean isCorrectMaintenanceClass(MaintenanceDocument document, Class clazz)(Code) | | This method tests to make sure the MaintenanceDocument passed in is based on the class you are expecting.
It does this based on the NewMaintainableObject of the MaintenanceDocument.
Parameters:
document - - MaintenanceDocument instance you want to test
Parameters:
clazz - - class you are expecting the MaintenanceDocument to be based on true if they match, false if not |
| isDocumentValidForSave | | protected boolean isDocumentValidForSave(MaintenanceDocument maintenanceDocument)(Code) | | This method checks to see if the document is in a state that it can be saved without causing exceptions.
Note that Business Rules are NOT enforced here, only validity checks.
This method will only return false if the document is in such a state that routing it will cause RunTimeExceptions.
Parameters:
maintenanceDocument - - a populated MaintenaceDocument instance. boolean - returns true unless the object is in an invalid state. |
| processCustomApproveDocumentBusinessRules | | protected boolean processCustomApproveDocumentBusinessRules(MaintenanceDocument document)(Code) | | This method should be overridden to provide custom rules for processing document approval.
Parameters:
document - booelan |
| processCustomRouteDocumentBusinessRules | | protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document)(Code) | | This method should be overridden to provide custom rules for processing document routing
Parameters:
document - boolean |
| processCustomSaveDocumentBusinessRules | | protected boolean processCustomSaveDocumentBusinessRules(MaintenanceDocument document)(Code) | | This method should be overridden to provide custom rules for processing document saving
Parameters:
document - boolean |
| processGlobalApproveDocumentBusinessRules | | protected boolean processGlobalApproveDocumentBusinessRules(MaintenanceDocument document)(Code) | | This method enforces all business rules that are common to all maintenance documents which must be tested before doing an
approval.
It can be overloaded in special cases where a MaintenanceDocument has very special needs that would be contrary to what is
enforced here.
Parameters:
document - - a populated MaintenanceDocument instance true if the document can be approved, false if not |
| processGlobalRouteDocumentBusinessRules | | protected boolean processGlobalRouteDocumentBusinessRules(MaintenanceDocument document)(Code) | | This method enforces all business rules that are common to all maintenance documents which must be tested before doing a
route.
It can be overloaded in special cases where a MaintenanceDocument has very special needs that would be contrary to what is
enforced here.
Parameters:
document - - a populated MaintenanceDocument instance true if the document can be routed, false if not |
| processGlobalSaveDocumentBusinessRules | | protected boolean processGlobalSaveDocumentBusinessRules(MaintenanceDocument document)(Code) | | This method enforces all business rules that are common to all maintenance documents which must be tested before doing a
save.
It can be overloaded in special cases where a MaintenanceDocument has very special needs that would be contrary to what is
enforced here.
Note that although this method returns a true or false to indicate whether the save should happen or not, this result may not
be followed by the calling method. In other words, the boolean result will likely be ignored, and the document saved,
regardless.
Parameters:
document - - a populated MaintenanceDocument instance true if all business rules succeed, false if not |
| putDocumentError | | protected void putDocumentError(String propertyName, String errorConstant, String parameter)(Code) | | This method is a convenience method to add a property-specific document error to the global errors list. This method makes
sure that the correct prefix is added to the property name so that it will display correctly on maintenance documents.
Parameters:
propertyName - - Property name of the element that is associated with the error. Used to mark the field as errored inthe UI.
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message.
Parameters:
parameter - - Single parameter value that can be used in the message so that you can display specific values to theuser. |
| putDocumentError | | protected void putDocumentError(String propertyName, String errorConstant, String[] parameters)(Code) | | This method is a convenience method to add a property-specific document error to the global errors list. This method makes
sure that the correct prefix is added to the property name so that it will display correctly on maintenance documents.
Parameters:
propertyName - - Property name of the element that is associated with the error. Used to mark the field as errored inthe UI.
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message.
Parameters:
parameters - - Array of String parameters that can be used in the message so that you can display specific values to theuser. |
| putFieldError | | protected void putFieldError(String propertyName, String errorConstant)(Code) | | This method is a convenience method to add a property-specific error to the global errors list. This method makes sure that
the correct prefix is added to the property name so that it will display correctly on maintenance documents.
Parameters:
propertyName - - Property name of the element that is associated with the error. Used to mark the field as errored inthe UI.
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message. |
| putFieldError | | protected void putFieldError(String propertyName, String errorConstant, String parameter)(Code) | | This method is a convenience method to add a property-specific error to the global errors list. This method makes sure that
the correct prefix is added to the property name so that it will display correctly on maintenance documents.
Parameters:
propertyName - - Property name of the element that is associated with the error. Used to mark the field as errored inthe UI.
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message.
Parameters:
parameter - - Single parameter value that can be used in the message so that you can display specific values to theuser. |
| putFieldError | | protected void putFieldError(String propertyName, String errorConstant, String[] parameters)(Code) | | This method is a convenience method to add a property-specific error to the global errors list. This method makes sure that
the correct prefix is added to the property name so that it will display correctly on maintenance documents.
Parameters:
propertyName - - Property name of the element that is associated with the error. Used to mark the field as errored inthe UI.
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message.
Parameters:
parameters - - Array of strings holding values that can be used in the message so that you can display specific valuesto the user. |
| putFieldErrorWithShortLabel | | protected void putFieldErrorWithShortLabel(String propertyName, String errorConstant)(Code) | | Adds a property-specific error to the global errors list, with the DD short label as the single argument.
Parameters:
propertyName - - Property name of the element that is associated with the error. Used to mark the field as errored inthe UI.
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message. |
| putGlobalError | | protected void putGlobalError(String errorConstant)(Code) | | This method is a convenience method to easily add a Document level error (ie, one not tied to a specific field, but
applicable to the whole document).
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message. |
| putGlobalError | | protected void putGlobalError(String errorConstant, String parameter)(Code) | | This method is a convenience method to easily add a Document level error (ie, one not tied to a specific field, but
applicable to the whole document).
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message.
Parameters:
parameter - - Replacement value for part of the error message. |
| putGlobalError | | protected void putGlobalError(String errorConstant, String[] parameters)(Code) | | This method is a convenience method to easily add a Document level error (ie, one not tied to a specific field, but
applicable to the whole document).
Parameters:
errorConstant - - Error Constant that can be mapped to a resource for the actual text message.
Parameters:
parameters - - Array of replacement values for part of the error message. |
| putGlobalsError | | protected void putGlobalsError(String propertyName, String errorConstant)(Code) | | This method specifically doesn't put any prefixes before the error so that the developer can do things specific to the
globals errors (like newDelegateChangeDocument errors)
Parameters:
propertyName -
Parameters:
errorConstant - |
| putGlobalsError | | protected void putGlobalsError(String propertyName, String errorConstant, String parameter)(Code) | | This method specifically doesn't put any prefixes before the error so that the developer can do things specific to the
globals errors (like newDelegateChangeDocument errors)
Parameters:
propertyName -
Parameters:
errorConstant -
Parameters:
parameter - |
| resumeErrorPath | | protected void resumeErrorPath()(Code) | | This method is used to deal with error paths that are not what we expect them to be. This method, along with clearErrorPath()
are used to temporarily clear the errorPath, and then return it to the original state after the rule is executed.
This method is called at the very end of the rule enforcement, and returns the temporarily stored copy of the errorPath to
the global errorPath, so that no other classes are interrupted.
|
| setBoDictionaryService | | final public void setBoDictionaryService(BusinessObjectDictionaryService boDictionaryService)(Code) | | Sets the boDictionaryService attribute value.
Parameters:
boDictionaryService - The boDictionaryService to set. |
| setBoService | | final public void setBoService(BusinessObjectService boService)(Code) | | Sets the boService attribute value.
Parameters:
boService - The boService to set. |
| setConfigService | | final public void setConfigService(KualiConfigurationService configService)(Code) | | Sets the configService attribute value.
Parameters:
configService - The configService to set. |
| setDdService | | final public void setDdService(DataDictionaryService ddService)(Code) | | Sets the ddService attribute value.
Parameters:
ddService - The ddService to set. |
| setDictionaryValidationService | | final public void setDictionaryValidationService(DictionaryValidationService dictionaryValidationService)(Code) | | Sets the dictionaryValidationService attribute value.
Parameters:
dictionaryValidationService - The dictionaryValidationService to set. |
| setDocumentAuthorizationService | | final public void setDocumentAuthorizationService(DocumentAuthorizationService documentAuthorizationService)(Code) | | Sets the documentAuthorizationService attribute value.
Parameters:
documentAuthorizationService - The documentAuthorizationService to set. |
| setMaintDocDictionaryService | | final public void setMaintDocDictionaryService(MaintenanceDocumentDictionaryService maintDocDictionaryService)(Code) | | Sets the maintDocDictionaryService attribute value.
Parameters:
maintDocDictionaryService - The maintDocDictionaryService to set. |
| setPersistenceService | | final public void setPersistenceService(PersistenceService persistenceService)(Code) | | Sets the persistenceService attribute value.
Parameters:
persistenceService - The persistenceService to set. |
| setPersistenceStructureService | | final public void setPersistenceStructureService(PersistenceStructureService persistenceStructureService)(Code) | | Sets the persistenceStructureService attribute value.
Parameters:
persistenceStructureService - The persistenceStructureService to set. |
| setWorkflowDocumentService | | public void setWorkflowDocumentService(WorkflowDocumentService workflowDocumentService)(Code) | | Sets the workflowDocumentService attribute value.
Parameters:
workflowDocumentService - The workflowDocumentService to set. |
| setupConvenienceObjects | | public void setupConvenienceObjects()(Code) | | |
| validateDocumentStructure | | protected boolean validateDocumentStructure(Document document)(Code) | | This method makes sure the document itself is valid, and has the necessary fields populated to be routable.
This is not a business rules test, rather its a structure test to make sure that the document will not cause exceptions
before routing.
Parameters:
document - - document to be tested false if the document is missing key values, true otherwise |
| validateGlobalBusinessObjectPersistable | | protected boolean validateGlobalBusinessObjectPersistable(MaintenanceDocument document)(Code) | | This method checks whether this maint doc contains Global Business Objects, and if so, whether the GBOs are in a persistable
state. This will return false if this method determines that the GBO will cause a SQL Exception when the document is
persisted.
Parameters:
document - False when the method determines that the contained Global Business Object will cause a SQL Exception, and thedocument should not be saved. It will return True otherwise. |
| validateMaintenanceDocument | | protected boolean validateMaintenanceDocument(MaintenanceDocument maintenanceDocument)(Code) | | This method checks to make sure the document is a valid maintenanceDocument, and has the necessary values populated such that
it will not cause exceptions in later routing or business rules testing.
This is not a business rules test.
Parameters:
maintenanceDocument - - document to be tested whether maintenance doc passes
throws:
ValidationException - |
|
|