Class ValidationEvent

java.lang.Object

org.eclipse.birt.report.model.api.activity.NotificationEvent

org.eclipse.birt.report.model.api.validators.ValidationEvent

public class ValidationEvent
extends NotificationEvent

Notification event that says that the validation is performed and whether error exists. This event provides the information: the validated element, the validation ID and the error list.

Field Summary

Fields inherited from class NotificationEvent

ATTRIBUTE_EVENT, CONTAINER, CONTENT_EVENT, CONTENT_REPLACE_EVENT, CONTENTS, CSS_EVENT, CSS_RELOADED_EVENT, CUSTOM_MSG_EVENT, DATA_DESIGN_RELOADED_EVENT, DATA_MART_PROPERTY_EVENT, deliveryPath, DESCENDENT, DIRECT, DISPOSE_EVENT, ELEMENT_CLIENT, ELEMENT_DELETE_EVENT, ELEMENT_LOCALIZE_EVENT, ENCRYPTION_EVENT, EXTENDS_EVENT, EXTENSION_PROPERTY_DEFINITION_EVENT, LAYOUT_CHANGED_EVENT, LIBRARY_CHANGE_EVENT, LIBRARY_EVENT, LIBRARY_RELOADED_EVENT, NAME_EVENT, NAME_SPACE_EVENT, PROPERTY_EVENT, sender, STRUCTURE_CLIENT, STYLE_CLIENT, STYLE_EVENT, target, TEMPLATE_TRANSFORM_EVENT, THEME_EVENT, USER_PROP_EVENT, VALIDATION_EVENT, VIEWS_CONTENT_EVENT

Constructor Summary

Constructors

Constructor	Description
ValidationEvent(org.eclipse.birt.report.model.core.DesignElement obj, String validationID, List errors)	Constructs the validation event.

Method Summary

Modifier and Type	Method	Description
List	getErrors()	Returns the error list which is the validation result.
int	getEventType()	Returns the event type.
String	getValidationID()	Returns the ID of the validation this event represents.

Methods inherited from class NotificationEvent

getDeliveryPath, getSender, getTarget, isSame, setDeliveryPath, setSender, setTarget

Methods inherited from class Object

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

Constructor Details

ValidationEvent

public ValidationEvent(org.eclipse.birt.report.model.core.DesignElement obj,
 String validationID,
 List errors)

Constructs the validation event.

Parameters:

obj - the element which is validated.

validationID - the validation ID

errors - the error list which is the validation result. Each one is the instance of ErrorDetail.

Method Details

getEventType

public int getEventType()

Description copied from class: NotificationEvent

Returns the event type. The following event types are defined:

• CONTENT_EVENT
• ELEMENT_DELETE_EVENT
• EXTENDS_EVENT
• NAME_EVENT
• NAME_SPACE_EVENT
• PROPERTY_EVENT
• STYLE_EVENT
• USER_PROP_EVENT
• CUSTOM_MSG_EVENT
• EXTENSION_PROPERTY_DEFINITION_EVENT
• NOTIFICATION_EVENT
• VALIDATION_EVENT
• LIBRARY_EVENT
• ATTRIBUTE_EVENT
• DISPOSE_EVENT
• CONTENT_REPLACE_EVENT
• TEMPLATE_TRANSFORM_EVENT

Specified by:

getEventType in class NotificationEvent

Returns:

the event type.

getErrors

public List getErrors()

Returns the error list which is the validation result. Each of the list is the instance of ErrorDetail.

Returns:

the error list returned after validation

getValidationID

public String getValidationID()

Returns the ID of the validation this event represents.

Returns:

the validation ID