org.kuali.kra.rule.event

Class SaveCustomDataEvent

java.lang.Object

org.kuali.rice.krad.rules.rule.event.KualiDocumentEventBase

org.kuali.kra.rule.event.KraDocumentEventBase

org.kuali.kra.rule.event.KraDocumentEventBaseExtension

org.kuali.kra.rule.event.SaveCustomDataEvent

All Implemented Interfaces:

org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent

Direct Known Subclasses:

AuditCustomDataEvent

public class SaveCustomDataEvent
extends KraDocumentEventBaseExtension

Encapsulates a validation event for a Custom Attribute add action.

Field Summary

Fields

Modifier and Type	Field and Description
protected ErrorReporter	errorReporter

Fields inherited from class org.kuali.rice.krad.rules.rule.event.KualiDocumentEventBase

document

Constructor Summary

Constructors

Constructor and Description
SaveCustomDataEvent(ResearchDocumentBase document)
SaveCustomDataEvent(ResearchDocumentBase document, boolean validateRequiredFields)
SaveCustomDataEvent(String errorPrefix, org.kuali.rice.krad.document.Document document, List<? extends DocumentCustomData> customDataList, Map<String,CustomAttributeDocument> customAttributeDocuments) Constructs a SaveCustomAttributeEvent.
SaveCustomDataEvent(String errorPrefix, org.kuali.rice.krad.document.Document document, List<? extends DocumentCustomData> customDataList, Map<String,CustomAttributeDocument> customAttributeDocuments, boolean validateRequiredFields)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,CustomAttributeDocument>	getCustomAttributeDocuments()
List<? extends DocumentCustomData>	getCustomDataList()
BusinessRuleInterface	getRule() This method implementer must pass the instance of rule tied with it.
boolean	isValidateRequiredFields()
void	reportError(CustomAttribute customAttribute, String propertyName, String errorKey, String... errorParams)
void	setCustomAttributeDocuments(Map<String,CustomAttributeDocument> customAttributeDocuments)
void	setCustomDataList(List<? extends DocumentCustomData> customDataList)
void	setValidateRequiredFields(boolean validateRequiredFields)

Methods inherited from class org.kuali.kra.rule.event.KraDocumentEventBaseExtension

getRuleInterfaceClass, invokeRuleMethod, logEvent

Methods inherited from class org.kuali.rice.krad.rules.rule.event.KualiDocumentEventBase

generateEvents, getDescription, getDocument, getDocumentId, getErrorPathPrefix, getName, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

errorReporter

protected ErrorReporter errorReporter

Constructor Detail

SaveCustomDataEvent

public SaveCustomDataEvent(String errorPrefix,
                   org.kuali.rice.krad.document.Document document,
                   List<? extends DocumentCustomData> customDataList,
                   Map<String,CustomAttributeDocument> customAttributeDocuments)

Constructs a SaveCustomAttributeEvent.

Parameters:

errorPathPrefix - The error path prefix

document - The document to validate

SaveCustomDataEvent

public SaveCustomDataEvent(String errorPrefix,
                   org.kuali.rice.krad.document.Document document,
                   List<? extends DocumentCustomData> customDataList,
                   Map<String,CustomAttributeDocument> customAttributeDocuments,
                   boolean validateRequiredFields)

SaveCustomDataEvent

public SaveCustomDataEvent(ResearchDocumentBase document)

SaveCustomDataEvent

public SaveCustomDataEvent(ResearchDocumentBase document,
                   boolean validateRequiredFields)

Method Detail

getRule

public BusinessRuleInterface getRule()

Description copied from class: KraDocumentEventBaseExtension

This method implementer must pass the instance of rule tied with it.

Specified by:

getRule in class KraDocumentEventBaseExtension

Returns:

isValidateRequiredFields

public boolean isValidateRequiredFields()

setValidateRequiredFields

public void setValidateRequiredFields(boolean validateRequiredFields)

getCustomDataList

public List<? extends DocumentCustomData> getCustomDataList()

setCustomDataList

public void setCustomDataList(List<? extends DocumentCustomData> customDataList)

getCustomAttributeDocuments

public Map<String,CustomAttributeDocument> getCustomAttributeDocuments()

setCustomAttributeDocuments

public void setCustomAttributeDocuments(Map<String,CustomAttributeDocument> customAttributeDocuments)

reportError

public void reportError(CustomAttribute customAttribute,
               String propertyName,
               String errorKey,
               String... errorParams)