# Package org.eclipse.birt.report.model.api.command

package org.eclipse.birt.report.model.api.command
Provides events when some command operations modify the state of the Design Engine.

## Package Specification

The application modifies a report design using a set of commands. Each command will send notification event and throw exception if an error occurs.

- An exception thrown if an error occurs. Many exceptions provide detailed error codes to clearly identify what went wrong.
- A notification event sent to the UI each time the operation is done, undone or redone.

## Related Documentation

The application generally uses the API handle classes to work with a design. These handle classes use the commands defined here to modify the design.

Related Packages
Package
Description
org.eclipse.birt.report.model.api
Tool-writer's interface for the BIRT design model (also known as the "Design Engine.")
Class
Description
CircularExtendsException
An error indicates circular extension while setting the extends property of an element.
ContentEvent
Notification event that says that the contents of a container have changed.
ContentException
Reports an error during a container operation.
ContentReplaceEvent
Notification event that says that one content of a container have been replaced by another one.
CssEvent
Included css style sheet event
CssException
Included css style sheet exception
CssReloadedEvent
Included css style sheet reload event
CustomMsgEvent
Notification event that says that the contents of user-defined message is added, dropped, or changed.
CustomMsgException
Reports an error during a user-defined message operation.
ElementDeletedEvent
Indicates that an element was deleted.
ElementLocalizeEvent
Events indicating that the element is just localized.
EncryptionEvent
Identifies that the encryption of an element property changed.
EncryptionException
Indicates an error when setting the name of an element.
ExtendsEvent
Indicates that the extends attribute of an element changed.
ExtendsException
Indicates an error while setting the extends property of an element.
ExtendsForbiddenException
An error indicates not supported extension while setting the extends property of an element.
ExtensionPropertyDefinitionEvent
Notification event to send when the dynamic property list is changed after setting an extension property value.
InvalidParentException
An error indicates invalid parent while setting the extends property of an element.
LibraryChangeEvent
Notification event that says that the module need refreshing.
LibraryEvent
Indicates that the library is added, dropped or shifted.
LibraryException
Indicates an error while operating with library.
LibraryReloadedEvent
Events indicating that the library is reloaded.
NameEvent
Identifies that the name of an element changed.
NameException
Indicates an error when setting the name of an element.
NameSpaceEvent
Deprecated.
Since BIRT 2.1, there will no such event send by BIRT
PropertyEvent
Notification event to send when a property changes.
PropertyNameException
Exception thrown when a property name is invalid.
ResourceChangeEvent
Notification event that says that the module need refreshing.
StyleEvent
Notifies that the style of an element has changed.
StyleException
Indicates an error while setting the style of an element.
TemplateException
Reports an error during a template related operation.
TemplateTransformEvent
Notification event that says that transformation betweem a template element and a report item or data set occurs.
ThemeEvent
Notifies that the style of an element has changed.
ThemeException
Indicates an error while setting the style of an element.
UserPropertyEvent
Indicates a change to a user-defined property.
UserPropertyException
Reports an error during a user property operation.
ViewsContentEvent
Notification event that says that multiple views of a container have changed.
WrongTypeException
An error indicates wrong type while setting the extends property of an element.