org.kuali.kfs.sys.document.validation.event
Interface AttributedDocumentEvent

All Superinterfaces:

org.kuali.rice.kns.rule.event.KualiDocumentEvent

All Known Subinterfaces:

AttributedPurchasingAccountsPayableItemEvent, AttributedPurchasingCapitalAssetLocationEvent, AttributedPurchasingItemCapitalAssetEvent

All Known Implementing Classes:

AddAccountingLineEvent, AddCheckEvent, AssetPaymentAddAssetEvent, AssetPaymentManuallyAddAccountingLineEvent, AssetPaymentPrepareRouteEvent, AttributedAddAdHocRoutePersonEvent, AttributedAddAdHocRouteWorkgroupEvent, AttributedAddNoteEvent, AttributedAddPurchasingAccountsPayableItemEvent, AttributedAddPurchasingCapitalAssetLocationEvent, AttributedAddPurchasingItemCapitalAssetEvent, AttributedAddVendorToQuoteEvent, AttributedApproveDocumentEvent, AttributedAssignSensitiveDataEvent, AttributedBlanketApproveDocumentEvent, AttributedCalculateAccountsPayableEvent, AttributedCancelAccountsPayableEvent, AttributedChangeSystemPurapEvent, AttributedCommodityCodesForDistributionEvent, AttributedContinuePurapEvent, AttributedDocumentEventBase, AttributedExpiredAccountWarningEvent, AttributedImportPurchasingAccountsPayableItemEvent, AttributedPayDateNotOverThresholdDaysAwayEvent, AttributedPaymentRequestForEInvoiceEvent, AttributedPreCalculateAccountsPayableEvent, AttributedPurchasingAccountsPayableItemEventBase, AttributedPurchasingCapitalAssetLocationEventBase, AttributedPurchasingItemCapitalAssetEventBase, AttributedRouteDocumentEvent, AttributedSaveDocumentEvent, AttributedSelectSystemPurapEvent, AttributedSplitPurchaseOrderEvent, AttributedTradeInWarningEvent, AttributedUpdateCamsViewPurapEvent, DeleteAccountingLineEvent, DeleteCheckEvent, DiscountCustomerInvoiceDetailEvent, RecalculateCustomerInvoiceDetailEvent, ReviewAccountingLineEvent, UpdateAccountingLineEvent, UpdateCheckEvent

public interface AttributedDocumentEvent
extends org.kuali.rice.kns.rule.event.KualiDocumentEvent

An interface that allows rules to add attribues to an event as it is processed.

Method Summary

Object	getAttribute(String attributeName) Retrieves a named attribute from the event.
Object	getIterationSubject() If event is going through a collection validation, this will return the current subject of the iteration through the collection
void	setAttribute(String attributeName, Object attributeValue) Sets the value of a named attribute on the event.
void	setIterationSubject(Object iterationSubject) This sets an iteration subject in the case of this event going through a CollectionValidation

Methods inherited from interface org.kuali.rice.kns.rule.event.KualiDocumentEvent

generateEvents, getDescription, getDocument, getErrorPathPrefix, getName, getRuleInterfaceClass, invokeRuleMethod, validate

Method Detail

getAttribute

Object getAttribute(String attributeName)

Retrieves a named attribute from the event.

Parameters:

attributeName - the name of the attribute to retrieve

Returns:

the attribute's value, or null if no attribute with the given name was found.

setAttribute

void setAttribute(String attributeName,
                  Object attributeValue)

Sets the value of a named attribute on the event.

Parameters:

attributeName - the name of the attribute to set

attributeValue - the value of the named attribute

setIterationSubject

void setIterationSubject(Object iterationSubject)

This sets an iteration subject in the case of this event going through a CollectionValidation

Parameters:

iterationSubject - the current subject of the CollectionValidation's iteration through a collection

getIterationSubject

Object getIterationSubject()

If event is going through a collection validation, this will return the current subject of the iteration through the collection

Returns:

a subject to a CollectionValidation's iteration through a collection