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

Class AddCollectionLineEvent

java.lang.Object

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

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

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

All Implemented Interfaces:

DocumentEvent, RuleEvent

public class AddCollectionLineEvent
extends DocumentEventBase

Defines the add collection line event fired when a user adds a line in a collection in a document.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

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

document

Constructor Summary

Constructors

Modifier	Constructor and Description
	AddCollectionLineEvent(Document document, String collectionName, Object addLine) Constructs an event for a document adding a line to the collection with the name collectionName.
	AddCollectionLineEvent(String errorPathPrefix, Document document, String collectionName, Object addLine) Constructs an event for a document adding a line to the collection with the name collectionName with a specific errorPathPrefix.
protected	AddCollectionLineEvent(String eventType, String errorPathPrefix, Document document, String collectionName, Object addLine) Constructs an event for a document adding a line to the collection with the name collectionName with a specific errorPathPrefix and eventType.

Method Summary

Modifier and Type	Method and Description
Object	getAddLine() The object being added to the collection.
String	getCollectionName() The name of the collection being added to.
Class<AddCollectionLineRule>	getRuleInterfaceClass() Returns the interface that classes must implement to receive this event.
boolean	invokeRuleMethod(BusinessRule rule) Invokes the event handling method on the rule object.

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

getDocument, getDocumentId, validate

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

addFact, generateEvents, getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName, setFacts, setName, setRuleMethodName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.rules.rule.event.RuleEvent

generateEvents, getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName

Constructor Detail

AddCollectionLineEvent

public AddCollectionLineEvent(Document document,
                              String collectionName,
                              Object addLine)

Constructs an event for a document adding a line to the collection with the name collectionName.

Parameters:

document - the document containing the collection objects

collectionName - the name of the collection object

addLine - the object being added to the collection

AddCollectionLineEvent

public AddCollectionLineEvent(String errorPathPrefix,
                              Document document,
                              String collectionName,
                              Object addLine)

Constructs an event for a document adding a line to the collection with the name collectionName with a specific errorPathPrefix.

Parameters:

errorPathPrefix - the prefix to add to the error path for reporting messages

document - the document containing the collection objects

collectionName - the name of the collection object

addLine - the object being added to the collection

AddCollectionLineEvent

protected AddCollectionLineEvent(String eventType,
                                 String errorPathPrefix,
                                 Document document,
                                 String collectionName,
                                 Object addLine)

Constructs an event for a document adding a line to the collection with the name collectionName with a specific errorPathPrefix and eventType.

Parameters:

eventType - the name of the type of event

errorPathPrefix - the prefix to add to the error path for reporting messages

document - the document containing the collection objects

collectionName - the name of the collection object

addLine - the object being added to the collection

Method Detail

getRuleInterfaceClass

public Class<AddCollectionLineRule> getRuleInterfaceClass()

Returns the interface that classes must implement to receive this event. Specifies that this class returns the AddCollectionLineRule class.

Returns:

rule interface

invokeRuleMethod

public boolean invokeRuleMethod(BusinessRule rule)

Invokes the event handling method on the rule object. Invokes the specific rule in AddCollectionLineRule.

Parameters:

rule - business rule

Returns:

true if the rule matches

getCollectionName

public String getCollectionName()

The name of the collection being added to.

Returns:

the collection name

getAddLine

public Object getAddLine()

The object being added to the collection.

Returns:

the added object