org.kuali.rice.krms.impl.rule

Class AgendaEditorBusRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.rice.krad.rules.MaintenanceDocumentRuleBase

org.kuali.rice.krms.impl.rule.AgendaEditorBusRule

All Implemented Interfaces:

MaintenanceDocumentRule, AddAdHocRoutePersonRule, AddAdHocRouteWorkgroupRule, AddCollectionLineRule, AddNoteRule, ApproveDocumentRule, BusinessRule, CompleteDocumentRule, RouteDocumentRule, SaveDocumentRule, SendAdHocRequestsRule

public class AgendaEditorBusRule
extends MaintenanceDocumentRuleBase

This class contains the rules for the AgendaEditor.

Field Summary

Fields inherited from class org.kuali.rice.krad.rules.MaintenanceDocumentRuleBase

DOCUMENT_ERROR_PREFIX, LOG, MAINTAINABLE_ERROR_PATH, MAINTAINABLE_ERROR_PREFIX, priorErrorPath

Constructor Summary

Constructors

Constructor and Description
AgendaEditorBusRule()

Method Summary

Methods

Modifier and Type	Method and Description
ActionTypeService	getActionTypeService(String serviceName)
AgendaAuthorizationService	getAgendaAuthorizationService()
AgendaBoService	getAgendaBoService()
ContextBoService	getContextBoService()
KrmsTypeRepositoryService	getKrmsTypeRepositoryService()
RuleBoService	getRuleBoService()
protected boolean	primaryKeyCheck(MaintenanceDocument document) This method checks the two major cases that may violate primary key integrity.
boolean	processAgendaItemBusinessRules(MaintenanceDocument document) Check if a agenda item is valid.
protected boolean	processCustomSaveDocumentBusinessRules(MaintenanceDocument document) This method should be overridden to provide custom rules for processing document saving
boolean	validAgendaName(AgendaEditor agendaEditor) Check if an agenda with that name exists already in the context.
boolean	validContext(AgendaEditor agendaEditor) Check if the context exists and if user has authorization to edit agendas under this context.
boolean	validContextAgendaNamespace(AgendaEditor agendaEditor) Check if for namespace.

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

checkEmptyBOField, checkEmptyDocumentField, checkEmptyValue, checkForPartiallyFilledOutReferenceForeignKeys, clearErrorPath, consolidateFieldNames, dataDictionaryValidate, errorAlreadyExists, getConfigService, getDataObjectAuthorizationService, getDataObjectService, getDateTimeService, getDdService, getDictionaryValidationService, getFieldLabel, getFieldLabel, getHumanReadablePrimaryKeyFieldNames, getNewDataObject, getOldDataObject, getPersonService, getRoleService, getWorkflowDocumentService, isCorrectMaintenanceClass, isDocumentInactivatingBusinessObject, isDocumentValidForSave, processAddCollectionLine, processApproveDocument, processCustomAddCollectionLineBusinessRules, processCustomApproveDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processGlobalApproveDocumentBusinessRules, processGlobalRouteDocumentBusinessRules, processGlobalSaveDocumentBusinessRules, processInactivationBlockChecking, processInactivationBlockChecking, processRouteDocument, processSaveDocument, putDocumentError, putDocumentError, putFieldError, putFieldError, putFieldError, putFieldErrorWithShortLabel, putGlobalError, putGlobalError, putGlobalError, putGlobalsError, putGlobalsError, putInactivationBlockingErrorOnPage, resumeErrorPath, setConfigService, setDataObjectAuthorizationService, setDdService, setDictionaryValidationService, setNewDataObject, setPersonService, setupBaseConvenienceObjects, setupConvenienceObjects, setWorkflowDocumentService, showErrorMap, validateDocumentStructure, 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, processCustomAddCollectionLineBusinessRules, 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

Constructor Detail

AgendaEditorBusRule

public AgendaEditorBusRule()

Method Detail

primaryKeyCheck

protected boolean primaryKeyCheck(MaintenanceDocument document)

Description copied from class: MaintenanceDocumentRuleBase

This method checks the two major cases that may violate primary key integrity. 1. Disallow changing of the primary keys on an EDIT maintenance document. Other fields can be changed, but once the primary keys have been set, they are permanent. 2. Disallow creating a new object whose primary key values are already present in the system on a CREATE NEW maintenance document. This method also will add new Errors to the Global Error Map.

Overrides:

primaryKeyCheck in class MaintenanceDocumentRuleBase

Parameters:

document - - The Maintenance Document being tested.

Returns:

Returns false if either test failed, otherwise returns true.

processCustomSaveDocumentBusinessRules

protected boolean processCustomSaveDocumentBusinessRules(MaintenanceDocument document)

Description copied from class: MaintenanceDocumentRuleBase

This method should be overridden to provide custom rules for processing document saving

Overrides:

processCustomSaveDocumentBusinessRules in class MaintenanceDocumentRuleBase

Returns:

boolean

validContext

public boolean validContext(AgendaEditor agendaEditor)

Check if the context exists and if user has authorization to edit agendas under this context.

Parameters:

agendaEditor -

Returns:

true if the context exist and has authorization, false otherwise

validContextAgendaNamespace

public boolean validContextAgendaNamespace(AgendaEditor agendaEditor)

Check if for namespace.

Parameters:

agendaEditor -

Returns:

validAgendaName

public boolean validAgendaName(AgendaEditor agendaEditor)

Check if an agenda with that name exists already in the context.

Parameters:

agendaEditor -

Returns:

true if agenda name is unique, false otherwise

processAgendaItemBusinessRules

public boolean processAgendaItemBusinessRules(MaintenanceDocument document)

Check if a agenda item is valid.

Parameters:

document, - the Agenda document of the added/edited agenda item

Returns:

true if agenda item is valid, false otherwise

getContextBoService

public ContextBoService getContextBoService()

getAgendaBoService

public AgendaBoService getAgendaBoService()

getRuleBoService

public RuleBoService getRuleBoService()

getKrmsTypeRepositoryService

public KrmsTypeRepositoryService getKrmsTypeRepositoryService()

getActionTypeService

public ActionTypeService getActionTypeService(String serviceName)

getAgendaAuthorizationService

public AgendaAuthorizationService getAgendaAuthorizationService()