org.kuali.kfs.sys.document.validation.event
Class AttributedDocumentEventBase

java.lang.Object
  org.kuali.rice.kns.rule.event.KualiDocumentEventBase
      org.kuali.kfs.sys.document.validation.event.AttributedDocumentEventBase

All Implemented Interfaces:

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

Direct Known Subclasses:

AddAccountingLineEvent, AddCheckEvent, AssetPaymentAddAssetEvent, AssetPaymentManuallyAddAccountingLineEvent, AssetPaymentPrepareRouteEvent, AttributedAddAdHocRoutePersonEvent, AttributedAddAdHocRouteWorkgroupEvent, AttributedAddNoteEvent, AttributedAddVendorToQuoteEvent, AttributedApproveDocumentEvent, AttributedAssignSensitiveDataEvent, AttributedBlanketApproveDocumentEvent, AttributedCalculateAccountsPayableEvent, AttributedCancelAccountsPayableEvent, AttributedCommodityCodesForDistributionEvent, AttributedExpiredAccountWarningEvent, AttributedPayDateNotOverThresholdDaysAwayEvent, AttributedPaymentRequestForEInvoiceEvent, AttributedPreCalculateAccountsPayableEvent, AttributedPurchasingAccountsPayableItemEventBase, AttributedPurchasingCapitalAssetLocationEventBase, AttributedPurchasingItemCapitalAssetEventBase, AttributedRouteDocumentEvent, AttributedSaveDocumentEvent, AttributedSplitPurchaseOrderEvent, AttributedTradeInWarningEvent, DeleteAccountingLineEvent, DeleteCheckEvent, DiscountCustomerInvoiceDetailEvent, RecalculateCustomerInvoiceDetailEvent, ReviewAccountingLineEvent, UpdateAccountingLineEvent, UpdateCheckEvent

public class AttributedDocumentEventBase
extends org.kuali.rice.kns.rule.event.KualiDocumentEventBase
implements AttributedDocumentEvent

Base abstract implementation of an attributed document event.

Field Summary

Fields inherited from class org.kuali.rice.kns.rule.event.KualiDocumentEventBase

document

Constructor Summary

protected	AttributedDocumentEventBase(String description, String errorPathPrefix) Constructs a AttributedDocumentEventBase
	AttributedDocumentEventBase(String description, String errorPathPrefix, org.kuali.rice.kns.document.Document document)

Method Summary

Object	getAttribute(String attributeName) Retrieves a named attribute from the event.
Object	getIterationSubject() Gets the iterationSubject attribute.
Class	getRuleInterfaceClass()
boolean	invokeRuleMethod(org.kuali.rice.kns.rule.BusinessRule rule)
void	setAttribute(String attributeName, Object attributeValue) Sets the value of a named attribute on the event.
void	setIterationSubject(Object iterationSubject) Sets the iterationSubject attribute value.

Methods inherited from class org.kuali.rice.kns.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

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

generateEvents, getDescription, getDocument, getErrorPathPrefix, getName, validate

Constructor Detail

AttributedDocumentEventBase

protected AttributedDocumentEventBase(String description,
                                      String errorPathPrefix)

Constructs a AttributedDocumentEventBase

Parameters:

description -

errorPathPrefix -

AttributedDocumentEventBase

public AttributedDocumentEventBase(String description,
                                   String errorPathPrefix,
                                   org.kuali.rice.kns.document.Document document)

See Also:

KualiDocumentEventBase.KualiDocumentEventBase(java.lang.String, java.lang.String, org.kuali.rice.kns.document.Document)

Method Detail

getAttribute

public Object getAttribute(String attributeName)

Description copied from interface: AttributedDocumentEvent

Retrieves a named attribute from the event.

Specified by:

getAttribute in interface AttributedDocumentEvent

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.

See Also:

AttributedDocumentEvent.getAttribute(java.lang.String)

setAttribute

public void setAttribute(String attributeName,
                         Object attributeValue)

Description copied from interface: AttributedDocumentEvent

Sets the value of a named attribute on the event.

Specified by:

setAttribute in interface AttributedDocumentEvent

Parameters:

attributeName - the name of the attribute to set

attributeValue - the value of the named attribute

See Also:

AttributedDocumentEvent.setAttribute(java.lang.String, java.lang.Object)

getIterationSubject

public Object getIterationSubject()

Gets the iterationSubject attribute.

Specified by:

getIterationSubject in interface AttributedDocumentEvent

Returns:

Returns the iterationSubject.

setIterationSubject

public void setIterationSubject(Object iterationSubject)

Sets the iterationSubject attribute value.

Specified by:

setIterationSubject in interface AttributedDocumentEvent

Parameters:

iterationSubject - The iterationSubject to set.

getRuleInterfaceClass

public Class getRuleInterfaceClass()

Specified by:

getRuleInterfaceClass in interface org.kuali.rice.kns.rule.event.KualiDocumentEvent

See Also:

KualiDocumentEvent.getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(org.kuali.rice.kns.rule.BusinessRule rule)

Specified by:

invokeRuleMethod in interface org.kuali.rice.kns.rule.event.KualiDocumentEvent

See Also:

KualiDocumentEvent.invokeRuleMethod(org.kuali.rice.kns.rule.BusinessRule)