org.kuali.kra.proposaldevelopment.rule.event

Class BasicProposalSiteEvent

java.lang.Object

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

org.kuali.kra.rule.event.KraDocumentEventBase

org.kuali.kra.proposaldevelopment.rule.event.BasicProposalSiteEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

AddProposalCongressionalDistrictEvent, AddProposalSiteEvent, DeleteProposalCongressionalDistrictEvent

public class BasicProposalSiteEvent
extends KraDocumentEventBase

Superclass for rule events related to Proposal Sites.

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
BasicProposalSiteEvent(String errorPathPrefix, ProposalDevelopmentDocument proposalDevelopmentDocument)
BasicProposalSiteEvent(String description, String errorPathPrefix, ProposalDevelopmentDocument proposalDevelopmentDocument, List<ProposalSite> proposalSites, String siteIndex) This constructor takes a List of ProposalSites and an index that points to one of them.
BasicProposalSiteEvent(String description, String errorPathPrefix, ProposalDevelopmentDocument proposalDevelopmentDocument, ProposalSite proposalSite) This constructor takes a single ProposalSite.

Method Summary

Methods

Modifier and Type	Method and Description
ProposalSite	getProposalSite() This method returns the proposal site at the index pointed to by siteIndex.
List<ProposalSite>	getProposalSites()
Class	getRuleInterfaceClass()
String	getSiteIndex()
boolean	invokeRuleMethod(org.kuali.rice.krad.rules.rule.BusinessRule rule)
protected void	logEvent() Logs the event type and some information about the associated accountingLine

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

Constructor Detail

BasicProposalSiteEvent

public BasicProposalSiteEvent(String errorPathPrefix,
                      ProposalDevelopmentDocument proposalDevelopmentDocument)

BasicProposalSiteEvent

public BasicProposalSiteEvent(String description,
                      String errorPathPrefix,
                      ProposalDevelopmentDocument proposalDevelopmentDocument,
                      ProposalSite proposalSite)

This constructor takes a single ProposalSite.

Parameters:

description -

errorPathPrefix -

proposalDevelopmentDocument -

proposalSite -

BasicProposalSiteEvent

public BasicProposalSiteEvent(String description,
                      String errorPathPrefix,
                      ProposalDevelopmentDocument proposalDevelopmentDocument,
                      List<ProposalSite> proposalSites,
                      String siteIndex)

This constructor takes a List of ProposalSites and an index that points to one of them.

Parameters:

description -

errorPathPrefix -

proposalDevelopmentDocument -

proposalSites -

siteIndex -

Method Detail

getProposalSites

public List<ProposalSite> getProposalSites()

getSiteIndex

public String getSiteIndex()

getProposalSite

public ProposalSite getProposalSite()

This method returns the proposal site at the index pointed to by siteIndex. No check is done to ensure siteIndex is a valid index, etc.

Returns:

logEvent

protected void logEvent()

Description copied from class: KraDocumentEventBase

Logs the event type and some information about the associated accountingLine

Specified by:

logEvent in class KraDocumentEventBase

getRuleInterfaceClass

public Class getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(org.kuali.rice.krad.rules.rule.BusinessRule rule)